taktiny 0.0.1rc1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. taktiny-0.0.1rc1/.github/workflows/docs.yml +53 -0
  2. taktiny-0.0.1rc1/.github/workflows/publish.yml +47 -0
  3. taktiny-0.0.1rc1/.github/workflows/tests.yml +39 -0
  4. taktiny-0.0.1rc1/.gitignore +21 -0
  5. taktiny-0.0.1rc1/.python-version +1 -0
  6. taktiny-0.0.1rc1/AGENTS.md +36 -0
  7. taktiny-0.0.1rc1/CODE_OF_CONDUCT.md +128 -0
  8. taktiny-0.0.1rc1/CONTRIBUTING.md +0 -0
  9. taktiny-0.0.1rc1/LICENSE.md +202 -0
  10. taktiny-0.0.1rc1/Makefile +42 -0
  11. taktiny-0.0.1rc1/PKG-INFO +423 -0
  12. taktiny-0.0.1rc1/README.md +186 -0
  13. taktiny-0.0.1rc1/SECURITY.md +0 -0
  14. taktiny-0.0.1rc1/docs/Makefile +15 -0
  15. taktiny-0.0.1rc1/docs/_static/custom.css +318 -0
  16. taktiny-0.0.1rc1/docs/_static/favicon.svg +11 -0
  17. taktiny-0.0.1rc1/docs/_static/gan_generated_plot.png +0 -0
  18. taktiny-0.0.1rc1/docs/_static/image_classification_plot.png +0 -0
  19. taktiny-0.0.1rc1/docs/_static/mark.svg +11 -0
  20. taktiny-0.0.1rc1/docs/_static/mnist_confusion_matrix.png +0 -0
  21. taktiny-0.0.1rc1/docs/_static/mnist_misclassified.png +0 -0
  22. taktiny-0.0.1rc1/docs/_static/regression_plot.png +0 -0
  23. taktiny-0.0.1rc1/docs/_static/theme.js +31 -0
  24. taktiny-0.0.1rc1/docs/api/data/loader.md +12 -0
  25. taktiny-0.0.1rc1/docs/api/data/transforms.md +27 -0
  26. taktiny-0.0.1rc1/docs/api/data.md +10 -0
  27. taktiny-0.0.1rc1/docs/api/nn/activation.md +35 -0
  28. taktiny-0.0.1rc1/docs/api/nn/base.md +12 -0
  29. taktiny-0.0.1rc1/docs/api/nn/containers.md +15 -0
  30. taktiny-0.0.1rc1/docs/api/nn/convolution.md +29 -0
  31. taktiny-0.0.1rc1/docs/api/nn/embedding.md +7 -0
  32. taktiny-0.0.1rc1/docs/api/nn/flatten.md +9 -0
  33. taktiny-0.0.1rc1/docs/api/nn/linear.md +21 -0
  34. taktiny-0.0.1rc1/docs/api/nn/normalization.md +13 -0
  35. taktiny-0.0.1rc1/docs/api/nn/recurrent.md +21 -0
  36. taktiny-0.0.1rc1/docs/api/nn/regularization.md +13 -0
  37. taktiny-0.0.1rc1/docs/api/nn/resampling.md +9 -0
  38. taktiny-0.0.1rc1/docs/api/nn/transformer.md +23 -0
  39. taktiny-0.0.1rc1/docs/api/nn.md +20 -0
  40. taktiny-0.0.1rc1/docs/api/takt/adapters.md +19 -0
  41. taktiny-0.0.1rc1/docs/api/takt/base.md +8 -0
  42. taktiny-0.0.1rc1/docs/api/takt.md +10 -0
  43. taktiny-0.0.1rc1/docs/api/trainer/callbacks.md +12 -0
  44. taktiny-0.0.1rc1/docs/api/trainer/config.md +9 -0
  45. taktiny-0.0.1rc1/docs/api/trainer/trainer.md +8 -0
  46. taktiny-0.0.1rc1/docs/api/trainer.md +11 -0
  47. taktiny-0.0.1rc1/docs/api/utils/format.md +13 -0
  48. taktiny-0.0.1rc1/docs/api/utils/quantization.md +13 -0
  49. taktiny-0.0.1rc1/docs/api/utils/spmd.md +15 -0
  50. taktiny-0.0.1rc1/docs/api/utils/transforms.md +9 -0
  51. taktiny-0.0.1rc1/docs/api/utils.md +12 -0
  52. taktiny-0.0.1rc1/docs/api_reference.md +304 -0
  53. taktiny-0.0.1rc1/docs/conf.py +141 -0
  54. taktiny-0.0.1rc1/docs/core_concepts.md +137 -0
  55. taktiny-0.0.1rc1/docs/data.md +154 -0
  56. taktiny-0.0.1rc1/docs/experimental.md +85 -0
  57. taktiny-0.0.1rc1/docs/generation.md +85 -0
  58. taktiny-0.0.1rc1/docs/getting_started/installation.md +39 -0
  59. taktiny-0.0.1rc1/docs/getting_started/quickstart.md +227 -0
  60. taktiny-0.0.1rc1/docs/getting_started.md +122 -0
  61. taktiny-0.0.1rc1/docs/guides/checkpoint.md +300 -0
  62. taktiny-0.0.1rc1/docs/guides/data.md +317 -0
  63. taktiny-0.0.1rc1/docs/guides/peft.md +176 -0
  64. taktiny-0.0.1rc1/docs/guides/spmd.md +253 -0
  65. taktiny-0.0.1rc1/docs/guides/trainer.md +328 -0
  66. taktiny-0.0.1rc1/docs/index.md +139 -0
  67. taktiny-0.0.1rc1/docs/kernels.md +123 -0
  68. taktiny-0.0.1rc1/docs/layers.md +150 -0
  69. taktiny-0.0.1rc1/docs/models_and_checkpoints.md +153 -0
  70. taktiny-0.0.1rc1/docs/peft.md +88 -0
  71. taktiny-0.0.1rc1/docs/training.md +148 -0
  72. taktiny-0.0.1rc1/docs/tutorial/gan.md +276 -0
  73. taktiny-0.0.1rc1/docs/tutorial/image_classification.md +269 -0
  74. taktiny-0.0.1rc1/docs/tutorial/linear_regression.md +172 -0
  75. taktiny-0.0.1rc1/pyproject.toml +99 -0
  76. taktiny-0.0.1rc1/src/taktiny/__init__.py +40 -0
  77. taktiny-0.0.1rc1/src/taktiny/data/__init__.py +54 -0
  78. taktiny-0.0.1rc1/src/taktiny/data/loader.py +347 -0
  79. taktiny-0.0.1rc1/src/taktiny/data/transforms.py +750 -0
  80. taktiny-0.0.1rc1/src/taktiny/nn/__init__.py +22 -0
  81. taktiny-0.0.1rc1/src/taktiny/nn/base.py +571 -0
  82. taktiny-0.0.1rc1/src/taktiny/nn/block.py +689 -0
  83. taktiny-0.0.1rc1/src/taktiny/nn/flatten.py +250 -0
  84. taktiny-0.0.1rc1/src/taktiny/nn/modules/__init__.py +23 -0
  85. taktiny-0.0.1rc1/src/taktiny/nn/modules/activation.py +282 -0
  86. taktiny-0.0.1rc1/src/taktiny/nn/modules/convolution.py +2255 -0
  87. taktiny-0.0.1rc1/src/taktiny/nn/modules/embedding.py +203 -0
  88. taktiny-0.0.1rc1/src/taktiny/nn/modules/linear.py +550 -0
  89. taktiny-0.0.1rc1/src/taktiny/nn/modules/normalization.py +1001 -0
  90. taktiny-0.0.1rc1/src/taktiny/nn/modules/peft.py +951 -0
  91. taktiny-0.0.1rc1/src/taktiny/nn/modules/recurrent.py +1717 -0
  92. taktiny-0.0.1rc1/src/taktiny/nn/modules/transformer.py +1471 -0
  93. taktiny-0.0.1rc1/src/taktiny/nn/regularization.py +498 -0
  94. taktiny-0.0.1rc1/src/taktiny/nn/resampling.py +351 -0
  95. taktiny-0.0.1rc1/src/taktiny/nn/rng.py +177 -0
  96. taktiny-0.0.1rc1/src/taktiny/nn/utils.py +649 -0
  97. taktiny-0.0.1rc1/src/taktiny/py.typed +0 -0
  98. taktiny-0.0.1rc1/src/taktiny/takt/__init__.py +36 -0
  99. taktiny-0.0.1rc1/src/taktiny/takt/adapter/__init__.py +34 -0
  100. taktiny-0.0.1rc1/src/taktiny/takt/adapter/adalora.py +51 -0
  101. taktiny-0.0.1rc1/src/taktiny/takt/adapter/base.py +111 -0
  102. taktiny-0.0.1rc1/src/taktiny/takt/adapter/dora.py +51 -0
  103. taktiny-0.0.1rc1/src/taktiny/takt/adapter/loha.py +51 -0
  104. taktiny-0.0.1rc1/src/taktiny/takt/adapter/lokr.py +51 -0
  105. taktiny-0.0.1rc1/src/taktiny/takt/adapter/lora.py +47 -0
  106. taktiny-0.0.1rc1/src/taktiny/takt/adapter/vera.py +112 -0
  107. taktiny-0.0.1rc1/src/taktiny/takt/base.py +131 -0
  108. taktiny-0.0.1rc1/src/taktiny/trainer/__init__.py +19 -0
  109. taktiny-0.0.1rc1/src/taktiny/trainer/callbacks.py +165 -0
  110. taktiny-0.0.1rc1/src/taktiny/trainer/checkpoint.py +287 -0
  111. taktiny-0.0.1rc1/src/taktiny/trainer/config.py +258 -0
  112. taktiny-0.0.1rc1/src/taktiny/trainer/evaluate.py +225 -0
  113. taktiny-0.0.1rc1/src/taktiny/trainer/trainer.py +1447 -0
  114. taktiny-0.0.1rc1/src/taktiny/utils/__init__.py +13 -0
  115. taktiny-0.0.1rc1/src/taktiny/utils/format.py +114 -0
  116. taktiny-0.0.1rc1/src/taktiny/utils/quantization.py +190 -0
  117. taktiny-0.0.1rc1/src/taktiny/utils/sharding.py +80 -0
  118. taktiny-0.0.1rc1/src/taktiny/utils/spmd.py +166 -0
  119. taktiny-0.0.1rc1/src/taktiny/utils/sync.py +32 -0
  120. taktiny-0.0.1rc1/src/taktiny/utils/trainer.py +352 -0
  121. taktiny-0.0.1rc1/src/taktiny/utils/transforms.py +209 -0
  122. taktiny-0.0.1rc1/src/taktiny/utils/typing.py +146 -0
  123. taktiny-0.0.1rc1/src/taktiny/utils/weights.py +97 -0
  124. taktiny-0.0.1rc1/tests/accelerators/__init__.py +1 -0
  125. taktiny-0.0.1rc1/tests/accelerators/gpu/__init__.py +1 -0
  126. taktiny-0.0.1rc1/tests/accelerators/tpu/__init__.py +1 -0
  127. taktiny-0.0.1rc1/tests/adapter/lora_linear_test.py +209 -0
  128. taktiny-0.0.1rc1/tests/adapter/peft_test.py +248 -0
  129. taktiny-0.0.1rc1/tests/adapter/weight_adapters_test.py +249 -0
  130. taktiny-0.0.1rc1/tests/data/apply_template_test.py +21 -0
  131. taktiny-0.0.1rc1/tests/data/data_generic_test.py +222 -0
  132. taktiny-0.0.1rc1/tests/data/data_test.py +390 -0
  133. taktiny-0.0.1rc1/tests/data/data_transform_docs_test.py +24 -0
  134. taktiny-0.0.1rc1/tests/data/packing_test.py +0 -0
  135. taktiny-0.0.1rc1/tests/nn/block_test.py +508 -0
  136. taktiny-0.0.1rc1/tests/nn/context_rng_test.py +145 -0
  137. taktiny-0.0.1rc1/tests/nn/conv_generic_test.py +225 -0
  138. taktiny-0.0.1rc1/tests/nn/conv_test.py +534 -0
  139. taktiny-0.0.1rc1/tests/nn/embedding_test.py +159 -0
  140. taktiny-0.0.1rc1/tests/nn/flatten_test.py +170 -0
  141. taktiny-0.0.1rc1/tests/nn/linear_test.py +378 -0
  142. taktiny-0.0.1rc1/tests/nn/nn_normalization_test.py +344 -0
  143. taktiny-0.0.1rc1/tests/nn/recurrent_test.py +386 -0
  144. taktiny-0.0.1rc1/tests/nn/regularization_test.py +236 -0
  145. taktiny-0.0.1rc1/tests/nn/resampling_test.py +167 -0
  146. taktiny-0.0.1rc1/tests/nn/spatial_ops_test.py +172 -0
  147. taktiny-0.0.1rc1/tests/nn/transformer_test.py +328 -0
  148. taktiny-0.0.1rc1/tests/trainer/trainer_regression_test.py +1540 -0
  149. taktiny-0.0.1rc1/tests/trainer/trainer_test.py +312 -0
  150. taktiny-0.0.1rc1/tests/utils/format_test.py +42 -0
  151. taktiny-0.0.1rc1/tests/utils/quantization_test.py +54 -0
  152. taktiny-0.0.1rc1/tests/utils/transforms_test.py +177 -0
  153. taktiny-0.0.1rc1/uv.lock +2928 -0
@@ -0,0 +1,53 @@
1
+ name: Deploy docs
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - experiment
7
+
8
+ permissions:
9
+ contents: read
10
+ pages: write
11
+ id-token: write
12
+
13
+ concurrency:
14
+ group: pages
15
+ cancel-in-progress: true
16
+
17
+ jobs:
18
+ build:
19
+ runs-on: ubuntu-latest
20
+
21
+ steps:
22
+ - uses: actions/checkout@v4
23
+
24
+ - uses: actions/setup-python@v5
25
+ with:
26
+ python-version: "3.12"
27
+
28
+ - uses: astral-sh/setup-uv@v6
29
+
30
+ - name: Install dependencies
31
+ run: uv sync --group docs
32
+
33
+ - name: Build Sphinx
34
+ run: make docs
35
+
36
+ - uses: actions/configure-pages@v5
37
+
38
+ - uses: actions/upload-pages-artifact@v4
39
+ with:
40
+ path: docs/_build/html
41
+
42
+ deploy:
43
+ environment:
44
+ name: github-pages
45
+ url: ${{ steps.deployment.outputs.page_url }}
46
+
47
+ runs-on: ubuntu-latest
48
+ needs: build
49
+
50
+ steps:
51
+ - name: Deploy
52
+ id: deployment
53
+ uses: actions/deploy-pages@v4
@@ -0,0 +1,47 @@
1
+ name: Publish to PyPI
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ jobs:
8
+ build:
9
+ runs-on: ubuntu-latest
10
+ permissions:
11
+ contents: read
12
+
13
+ steps:
14
+ - uses: actions/checkout@v7.0.1
15
+
16
+ - uses: actions/setup-python@v7.0.0
17
+ with:
18
+ python-version: "3.12"
19
+
20
+ - uses: astral-sh/setup-uv@v10.0.1
21
+
22
+ - name: Build package
23
+ run: uv build
24
+
25
+ - name: Upload distributions
26
+ uses: actions/upload-artifact@v7.0.1
27
+ with:
28
+ name: python-package-distributions
29
+ path: dist/
30
+
31
+ publish:
32
+ needs: build
33
+ runs-on: ubuntu-latest
34
+
35
+ permissions:
36
+ contents: read
37
+ id-token: write
38
+
39
+ steps:
40
+ - name: Download distributions
41
+ uses: actions/download-artifact@v8.0.1
42
+ with:
43
+ name: python-package-distributions
44
+ path: dist/
45
+
46
+ - name: Publish package
47
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,39 @@
1
+ name: Tests
2
+
3
+ on:
4
+ push:
5
+ pull_request:
6
+
7
+ permissions:
8
+ contents: read
9
+
10
+ concurrency:
11
+ group: tests-${{ github.workflow }}-${{ github.ref }}
12
+ cancel-in-progress: true
13
+
14
+ jobs:
15
+ test:
16
+ name: Python 3.12
17
+ runs-on: ubuntu-latest
18
+ timeout-minutes: 20
19
+
20
+ env:
21
+ JAX_PLATFORMS: cpu
22
+ XLA_PYTHON_CLIENT_PREALLOCATE: "false"
23
+
24
+ steps:
25
+ - name: Check out repository
26
+ uses: actions/checkout@v6
27
+
28
+ - name: Install uv and Python
29
+ uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
30
+ with:
31
+ python-version: "3.12"
32
+ enable-cache: true
33
+ cache-dependency-glob: uv.lock
34
+
35
+ - name: Install dependencies
36
+ run: uv sync --frozen --group dev
37
+
38
+ - name: Run tests
39
+ run: make test
@@ -0,0 +1,21 @@
1
+ # Python-generated files
2
+ __pycache__/
3
+ *.py[oc]
4
+ build/
5
+ dist/
6
+ wheels/
7
+ *.egg-info
8
+
9
+ # Virtual environments
10
+ .venv
11
+
12
+
13
+ # Added by cargo
14
+ /target
15
+
16
+ # tmp files
17
+ tmp*
18
+ zcratch*
19
+
20
+ # Sphinx documentation build
21
+ docs/_build/
@@ -0,0 +1 @@
1
+ 3.12
@@ -0,0 +1,36 @@
1
+ # Repository Guidelines
2
+
3
+ ## Project Structure & Module Organization
4
+
5
+ Taktiny is an experimental JAX neural-network library. Python packages live under `src/taktiny/`. Put automated tests in `tests/`, hardware-specific cases in `tests/accelerators/{gpu,tpu}/`, benchmarks in `benchmarks/`, and exploratory notebooks in `notebook/colab/`. Project metadata is defined by `pyproject.toml` and `uv.lock`.
6
+
7
+ ## Build, Test, and Development Commands
8
+
9
+ - `uv sync --frozen --group dev` installs the Python 3.12 development environment from `uv.lock`.
10
+ - `uv run --frozen pytest` runs the CPU-oriented suite exactly as CI does.
11
+ - `uv run pytest tests/linear_test.py -q` runs one focused test module.
12
+ - `make test-fast [path]` runs tests in parallel with `pytest-xdist`.
13
+
14
+ Keep `JAX_PLATFORMS=cpu` for portable local/CI checks unless a test explicitly targets an accelerator.
15
+
16
+ ## Coding Style & Naming Conventions
17
+
18
+ Use four-space indentation, modern Python type annotations, and concise docstrings for public APIs. Follow existing module conventions: `snake_case` for files, functions, and variables; `PascalCase` for classes; and uppercase names for constants. Keep imports grouped as standard library, third-party, then local packages. No repository-wide Python formatter is configured, so match nearby code and keep changes focused.
19
+
20
+ ## Testing Guidelines
21
+
22
+ Tests use `pytest` and are named `tests/*_test.py`, with functions named `test_<behavior>`. Add deterministic, small cases alongside the affected feature. Avoid downloads and large checkpoints in the default suite. Mark device-only tests with `@pytest.mark.gpu` or `@pytest.mark.tpu`; no coverage threshold is configured. Run the focused test first, then the full suite before opening a PR.
23
+
24
+ ## Commit & Pull Request Guidelines
25
+
26
+ Recent history follows Conventional Commit-style subjects such as `feat(trainer): ...`, `fix(overture): ...`, and `refactor: ...`. Use an imperative, concise subject with an optional scope. PRs should explain the motivation and behavioral impact, link relevant issues, list verification commands, and note device/backend assumptions. Include screenshots or logs only when they clarify user-visible or performance changes.
27
+
28
+ ## Agent-Specific Instructions
29
+
30
+ - NEVER execute destructive Git commands under any circumstance:
31
+ - FORBIDDEN: `git checkout <path>`
32
+ - FORBIDDEN: `git restore`
33
+ - FORBIDDEN: `git reset --hard`
34
+ - FORBIDDEN: `git clean`
35
+ - NEVER discard, overwrite, or revert uncommitted changes in the user's working tree.
36
+ - Only stage specific target files explicitly (e.g., `git add src/...`).
@@ -0,0 +1,128 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ solitarius.ai@gmail.com.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.0, available at
119
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+ enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see the FAQ at
127
+ https://www.contributor-covenant.org/faq. Translations are available at
128
+ https://www.contributor-covenant.org/translations.
File without changes
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 Shinapri
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,42 @@
1
+ # If the first goal is a test or lint target, treat subsequent goals as target paths/arguments
2
+ ifneq ($(filter test test-fast test-single lint lint-fix,$(firstword $(MAKECMDGOALS))),)
3
+ RUN_ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
4
+ .PHONY: $(RUN_ARGS)
5
+ $(RUN_ARGS):
6
+ @:
7
+ endif
8
+
9
+ LINT_PATHS := $(if $(RUN_ARGS),$(RUN_ARGS),.)
10
+
11
+ .PHONY: help test test-fast test-single docs docs-clean lint lint-fix
12
+
13
+ help:
14
+ @echo "Available targets:"
15
+ @echo " make test [path] Run tests in parallel with pytest-xdist (-n auto)"
16
+ @echo " make test-fast [path] Run tests in parallel with concise output (-n auto -q)"
17
+ @echo " make test-single [path] Run tests sequentially"
18
+ @echo " make docs Build HTML documentation"
19
+ @echo " make docs-clean Clean documentation build directory"
20
+ @echo " make lint [path] Run Ruff linter (defaults to all files)"
21
+ @echo " make lint-fix [path] Run Ruff linter and automatically apply fixes"
22
+
23
+ test:
24
+ uv run --group dev pytest -n auto $(RUN_ARGS) $(ARGS)
25
+
26
+ test-fast:
27
+ uv run --group dev pytest -n auto -q $(RUN_ARGS) $(ARGS)
28
+
29
+ test-single:
30
+ uv run --group dev pytest $(RUN_ARGS) $(ARGS)
31
+
32
+ docs:
33
+ uv run --group docs make -C docs html
34
+
35
+ docs-clean:
36
+ uv run --group docs make -C docs clean
37
+
38
+ lint:
39
+ uv run --group dev ruff check $(LINT_PATHS) $(ARGS)
40
+
41
+ lint-fix:
42
+ uv run --group dev ruff check --fix $(LINT_PATHS) $(ARGS)