priml 0.1.0__tar.gz

priml-0.1.0/.gitignore

@@ -0,0 +1,152 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+# lib/
+# lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject.db
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# ML artifacts (weights, datasets, runs). Never commit generated bulk data;
+# keep only source, small deterministic fixtures, and goldens.
+wandb/
+*.npz
+*.npy
+*.pt
+*.pth
+*.ckpt
+*.safetensors
+*.parquet
+# Bit-for-bit golden fixtures are committed on purpose (small, deterministic
+# references the golden tests compare against); re-admit them past the *.pt rule.
+!**/goldens/
+!**/goldens/*.pt

priml-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,186 @@
+# See:
+#   https://pre-commit.com
+#   https://pre-commit.com/hooks.html
+#   https://learn.scientific-python.org/development/guides/style/
+# uv run pre-commit install
+# uv run pre-commit autoupdate
+# uv run pre-commit run --all-files
+#
+# May need: git config --unset-all core.hooksPath
+# if: [ERROR] Cowardly refusing to install hooks with `core.hooksPath` set.
+
+# Tool settings: single source of truth.
+# Preferred location for any tool setting, in order:
+#   pyproject.toml  >  .pre-commit-config.yaml  >  .github/workflows/tests.yml
+# Put a setting as high in this chain as the tool allows. Only drop to a lower
+# file when the higher one cannot express it (e.g. a CLI-only flag with no
+# config key). pyproject.toml holds tool config; .pre-commit-config.yaml is the
+# sole source for how hooks run (thread/worker counts, heap caps);
+# .github/workflows/tests.yml only invokes the hooks and must not redefine any
+# of these.
+#
+# Philosophy: Only fail if there's things which cannot be auto-fixed.
+# Hooks fix files in place; if anything changes, pre-commit reports
+# "files were modified" and the commit is aborted. Run `git add -u`
+# then re-commit -- the second attempt always passes.
+fail_fast: false
+default_stages: [pre-commit]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+
+      - id: end-of-file-fixer
+        stages: [pre-commit]
+        exclude: |
+          (?x)^(
+            (.*/)?third_party/
+          )
+
+      - id: trailing-whitespace
+        stages: [pre-commit]
+        exclude: |
+          (?x)^(
+            (.*/)?third_party/
+          )
+
+      - id: check-added-large-files
+        stages: [pre-commit]
+        args: [--maxkb=500, --enforce-all]
+        exclude: |
+          (?x)^(
+            |typings/
+            |uv\.lock
+          )
+
+      - id: check-merge-conflict
+        stages: [pre-commit]
+        args: [--assume-in-merge]
+
+      - id: check-yaml
+        stages: [pre-commit]
+
+      - id: check-toml
+        stages: [pre-commit]
+
+  # Validates uv.lock matches pyproject.toml (no network needed).
+  # Run `uv lock` manually when changing dependencies.
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.11.22
+    hooks:
+      - id: uv-lock
+        stages: [pre-commit]
+        files: ^(pyproject\.toml|uv\.lock)$
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.18
+    hooks:
+      # Exclusions defined in pyproject.toml.
+      - id: ruff-check
+        stages: [pre-commit]
+        types_or: [python, pyi, jupyter]
+        args: [--fix]
+      - id: ruff-format
+        stages: [pre-commit]
+        types_or: [python, pyi, jupyter]
+
+  - repo: local
+    hooks:
+
+      - id: codespell
+        name: codespell
+        language: system
+        stages: [pre-commit]
+        types_or: [python, markdown, jupyter, shell]
+        entry: uv --quiet run --frozen --group lint codespell
+        args: [-w]
+        exclude: |
+          (?x)^(
+            typings/
+            |(.*/)?third_party/
+          )
+
+  # No official ty pre-commit hook yet (https://github.com/astral-sh/ty/issues/269).
+  - repo: local
+    hooks:
+      - id: ty
+        name: ty check
+        language: system
+        stages: [pre-commit]
+        # Annoyingly there's no good choice.
+        #   pass_filenames: true
+        #     Pro: Only what you touch is checked.
+        #     Con: pyproject.toml ``[tool.ty.src].exclude`` are ignored.
+        #   pass_filenames: false
+        #     Pro: pyproject.toml ``[tool.ty.src].exclude`` is honored.
+        #     Con: repo-wide
+        # Compromise: duplication; the exclusion list below must mirror
+        # pyproject.toml's ``[tool.ty.src]``.
+        types_or: [python, pyi]
+        entry: uv --quiet run --frozen --group typecheck ty check
+        # Exclusions defined in pyproject.toml.
+
+  # To enable:  uv run pre-commit install --hook-type pre-push
+  # To disable: uv run pre-commit uninstall --hook-type pre-push
+  - repo: local
+    hooks:
+      - id: ty-global
+        name: ty check global
+        language: system
+        always_run: true
+        pass_filenames: false
+        stages: [pre-push]
+        entry: uv --quiet run --frozen --group typecheck ty check
+        # Exclusions defined in pyproject.toml.
+
+  - repo: local
+    hooks:
+      - id: basedpyright-global
+        name: basedpyright-global
+        language: system
+        always_run: true
+        pass_filenames: false
+        stages: [pre-push]
+        entry: >-
+          bash -c '
+            workers=$(nproc);
+            workers=$((workers / 2));
+            ((workers < 2)) && workers=2;
+            ((workers > 32)) && workers=32;
+            exec env NODE_OPTIONS=--max-old-space-size=2048
+            uv --quiet run --frozen --group typecheck
+            basedpyright --threads="$workers"
+          '
+
+  - repo: local
+    hooks:
+      - id: pytest
+        name: pytest
+        language: system
+        always_run: true
+        pass_filenames: false
+        stages: [pre-push]
+        entry: &pytest-entry >-
+          bash -c '
+            if [ -n "$CI" ]; then
+              workers=1;
+            else
+              workers=$(nproc);
+              workers=$((workers / 2));
+              ((workers < 2)) && workers=2;
+              ((workers > 32)) && workers=32;
+            fi;
+            exec uv --quiet run --frozen --group test
+            pytest -n="$workers" "$@"
+          ' pytest
+        args: [-q, --tb=short]
+
+      - id: pytest-integration
+        name: pytest (integration)
+        language: system
+        always_run: true
+        pass_filenames: false
+        stages: [pre-push]
+        entry: *pytest-entry
+        args: [-q, --tb=short, -m, integration]

priml-0.1.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable priml changes are documented here. This project follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## Unreleased
+
+- Initial public release of priml: malleable ML building blocks for training
+  experiments (models, optimizers, losses, metrics, math, training loop, and
+  data pipeline).

priml-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Code of Conduct
+
+We want priml to be a respectful, productive project for contributors and users.
+
+This file gives maintainers a public moderation policy before the repository accepts outside issues and pull requests.
+
+## Expected behavior
+
+- Be respectful and constructive.
+- Assume good intent.
+- Focus criticism on ideas and code, not people.
+- Help keep discussions clear and actionable.
+
+## Unacceptable behavior
+
+- Harassment, threats, or discriminatory language.
+- Personal attacks or sustained disruption.
+- Publishing private information without consent.
+
+## Enforcement
+
+Project maintainers may moderate discussions, close issues, or restrict participation when necessary to keep the project safe and productive. Report concerns privately to hello@rekursiv.ai.

priml-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to priml
+
+Thanks for helping improve priml.
+
+## Why this file exists
+
+priml accepts public changes through a generated public repository while the source tree stays canonical. Contributors need to know how to validate changes locally and which branches are safe to edit.
+
+## Development setup
+
+Requires Python 3.12 and uv.
+
+```bash
+uv sync --all-groups
+uv run pytest
+```
+
+Before opening a pull request, run:
+
+```bash
+uv run ruff check --no-fix --no-cache .
+uv run ruff format --check --no-cache .
+uv run codespell .
+uv run ty check
+uv run basedpyright priml
+uv run pytest
+uv run python -c "import priml"
+uv build
+```
+
+## Public contribution flow
+
+The public repository is synchronized with the canonical source tree. Public
+changes should be made on normal contributor branches. After validation, the
+sync workflow imports accepted changes back to the source repository for review.
+
+Do not edit generated `priml/export/*` branches directly.
+
+## Pull request expectations
+
+- Keep changes focused.
+- Include tests for behavior changes.
+- Update README or docs when public behavior changes.
+- Do not include secrets, private credentials, generated caches, or local environment files.

priml-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

priml-0.1.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: priml
+Version: 0.1.0
+Summary: Malleable ML building blocks for training experiments.
+Project-URL: Homepage, https://www.rekursiv.ai
+Project-URL: Repository, https://github.com/rekursiv-ai/priml
+Project-URL: Documentation, https://github.com/rekursiv-ai/priml/tree/main/docs
+Project-URL: Source, https://github.com/rekursiv-ai/priml
+Project-URL: Issues, https://github.com/rekursiv-ai/priml/issues
+Project-URL: Changelog, https://github.com/rekursiv-ai/priml/releases
+Author-email: "rekursiv.ai" <hello@rekursiv.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: experiments,ml,pytorch,training
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.12
+Requires-Dist: configgle>=1.3.3
+Requires-Dist: imagesize>=1.4
+Requires-Dist: jaxtyping
+Requires-Dist: lpips
+Requires-Dist: numpy>=2.1
+Requires-Dist: pyturbojpeg<2,>=1.8.2
+Requires-Dist: scipy
+Requires-Dist: torch==2.11.0
+Requires-Dist: torchao==0.17.0
+Requires-Dist: torchvision==0.26.0
+Requires-Dist: tqdm
+Requires-Dist: typeguard
+Requires-Dist: typing-extensions
+Requires-Dist: wandb>=0.22.2
+Requires-Dist: webp>=0.4.0
+Requires-Dist: wrapt
+Provides-Extra: hub
+Requires-Dist: accelerate>=1.13.0; extra == 'hub'
+Requires-Dist: safetensors; extra == 'hub'
+Requires-Dist: transformers>=4.57.0; extra == 'hub'
+Description-Content-Type: text/markdown
+
+# priml
+
+Malleable ML building blocks for training experiments.
+
+## Install
+
+```bash
+pip install priml
+```
+
+Requires Python 3.12 or newer.
+
+## What's inside
+
+- **models** — composable model definitions and building blocks.
+- **optimizers** — optimizer implementations for training.
+- **loss** — loss functions.
+- **metrics** — evaluation metrics.
+- **math** — numerical and math utilities.
+- **train** — the training loop and experiment scaffolding.
+- **data** — the data pipeline and dataset utilities.
+- **inference** — inference helpers.
+
+## Development
+
+This package is developed in a monorepo and synced to this public repository.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for local validation and the public
+contribution flow.
+
+## License
+
+Apache License 2.0