singularic 1.0.0__tar.gz

singularic-1.0.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 2026 Singularic contributors
+
+   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.

singularic-1.0.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: singularic
+Version: 1.0.0
+Summary: Full-stack modern AI/ML library in pure JAX
+Keywords: jax,machine-learning,deep-learning,neural-networks,optimization,training,checkpoint,distributed,jax-framework
+Author: Singularic contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: jax>=0.11.0,<0.12
+Requires-Dist: numpy>=2.0,<3
+Requires-Dist: safetensors>=0.8.0,<0.9
+Requires-Python: >=3.14
+Project-URL: Repository, https://github.com/singularic/singularic
+Project-URL: Homepage, https://singularic.ai
+Project-URL: Documentation, https://singularic.ai/docs
+Project-URL: Bug Tracker, https://github.com/singularic/singularic/issues
+Project-URL: Changelog, https://github.com/singularic/singularic/releases
+Description-Content-Type: text/markdown
+
+# Singularic
+
+[![PyPI version](https://img.shields.io/pypi/v/singularic)](https://pypi.org/project/singularic/)
+[![Python version](https://img.shields.io/pypi/pyversions/singularic)](https://pypi.org/project/singularic/)
+[![CI](https://github.com/singularic/singularic/actions/workflows/ci.yml/badge.svg)](https://github.com/singularic/singularic/actions/workflows/ci.yml)
+[![License](https://img.shields.io/pypi/l/singularic)](https://github.com/singularic/singularic/blob/main/LICENSE)
+
+Singularic is a standalone, unified, JAX-native machine-learning framework. It
+combines Pythonic modules, semantic optimization, deterministic data pipelines,
+automatically compiled training, portable checkpoints, and distributed
+placement behind one state and selector system.
+
+```python
+import jax
+import jax.numpy as jnp
+from singularic.core.module import Module, child, module
+from singularic.data.dataset import Dataset
+from singularic.nn.functional import mean_squared_error
+from singularic.core.enums import ParamRole
+from singularic.nn.layers import Linear
+from singularic.optim.specs import muon
+from singularic.train.trainer import Trainer
+
+
+@module
+class MLP(Module):
+    hidden = child()
+    output = child()
+
+    def __init__(self) -> None:
+        self.hidden = Linear(8, 32)
+        self.output = Linear(32, 2, role=ParamRole.OUTPUT_WEIGHT)
+
+    def __call__(self, inputs: jax.Array) -> jax.Array:
+        return self.output(jax.nn.gelu(self.hidden(inputs)))
+
+
+def loss(model, batch, context):
+    del context
+    inputs, targets = batch
+    return mean_squared_error(model(inputs), targets)
+
+
+records = [(jnp.ones((8,)), jnp.zeros((2,))) for _ in range(1_024)]
+dataset = Dataset(records).shuffle(42).batch(32)
+trainer = Trainer(MLP(), muon(), loss)
+trainer.fit(dataset, steps=20)
+```
+
+`Trainer` owns stable JIT boundaries for training, evaluation, prediction,
+automatic differentiation, accumulation, mixed precision, donation, and
+placement. Advanced users can still use `jax.jit`, `jax.grad`, and all other JAX
+APIs directly through `singularic.core.apply.apply`, graph definitions, and `State`.
+
+## Install
+
+Singularic requires Python 3.14 or newer.
+
+```console
+uv add singularic
+```
+
+JAX is the only numerical backend. Runtime dependencies are JAX, NumPy, and
+safetensors.
+
+## Core guarantees
+
+- One metadata-rich `State` pytree for parameters, buffers, caches, RNGs,
+  metrics, and optimizer slots.
+- One composable `Selector` and ordered rule system for optimization, freezing,
+  sharding, precision, and checkpoint policy.
+- Semantic Muon/AdamW routing through `singularic.optim.specs.muon()`; output heads use
+  `nn.Linear(..., role=ParamRole.OUTPUT_WEIGHT)`.
+- Immutable deterministic data pipelines with JSON-safe global cursors;
+  non-indexed sources must declare a `ResumableStream` replay contract.
+- Exact process-count elasticity for fixed-cardinality indexed pipelines.
+  Filtering and bucketing require deterministic source plans.
+- Versioned JSON plus safetensors checkpoint bundles; never pickle. Immutable
+  objects and conditional commit records work through the dependency-free
+  `ByteStore` protocol, with a durable POSIX/shared-filesystem adapter in core.
+
+Singularic 1.0.0 is the standalone release. The root package is a deliberately
+small facade; import every other public symbol from its owning module. Read the
+[quickstart](https://github.com/singularic/singularic/blob/main/docs/quickstart.md),
+[architecture contract](https://github.com/singularic/singularic/blob/main/docs/architecture.md),
+and [API guide](https://github.com/singularic/singularic/blob/main/docs/api.md). CPU, GPU, and TPU use the same portable-JAX
+correctness contract; GPU accelerators are optional and lazily imported.
+Serving, quantization, executable export, and external dataset connectors are
+out of scope.
+
+## Development and benchmarks
+
+All operations use `uv`:
+
+```console
+uv sync --group dev
+./scripts/check.sh
+```
+
+The individual development suites are:
+
+```console
+uv run pytest tests/api tests/core
+uv run pytest tests/nn
+uv run pytest tests/optim
+uv run pytest tests/train
+uv run pytest tests/data tests/checkpoint
+uv run pytest tests/distributed
+uv run pytest tests/inspect tests/property tests/performance tests/inference
+uv run ruff format --check src tests benchmarks
+uv run ruff check src tests benchmarks
+uv run mypy src/singularic benchmarks
+uv run --group docs mkdocs build --strict
+uv build
+```
+
+Run the reproducible decoder benchmark with
+`uv run python -m benchmarks.train_decoder`; see
+[benchmark policy](https://github.com/singularic/singularic/blob/main/docs/benchmarks.md) for environment-scoped baselines and the
+10% release-regression gate.
+
+Licensed under Apache-2.0.

singularic-1.0.0/README.md

@@ -0,0 +1,122 @@
+# Singularic
+
+[![PyPI version](https://img.shields.io/pypi/v/singularic)](https://pypi.org/project/singularic/)
+[![Python version](https://img.shields.io/pypi/pyversions/singularic)](https://pypi.org/project/singularic/)
+[![CI](https://github.com/singularic/singularic/actions/workflows/ci.yml/badge.svg)](https://github.com/singularic/singularic/actions/workflows/ci.yml)
+[![License](https://img.shields.io/pypi/l/singularic)](https://github.com/singularic/singularic/blob/main/LICENSE)
+
+Singularic is a standalone, unified, JAX-native machine-learning framework. It
+combines Pythonic modules, semantic optimization, deterministic data pipelines,
+automatically compiled training, portable checkpoints, and distributed
+placement behind one state and selector system.
+
+```python
+import jax
+import jax.numpy as jnp
+from singularic.core.module import Module, child, module
+from singularic.data.dataset import Dataset
+from singularic.nn.functional import mean_squared_error
+from singularic.core.enums import ParamRole
+from singularic.nn.layers import Linear
+from singularic.optim.specs import muon
+from singularic.train.trainer import Trainer
+
+
+@module
+class MLP(Module):
+    hidden = child()
+    output = child()
+
+    def __init__(self) -> None:
+        self.hidden = Linear(8, 32)
+        self.output = Linear(32, 2, role=ParamRole.OUTPUT_WEIGHT)
+
+    def __call__(self, inputs: jax.Array) -> jax.Array:
+        return self.output(jax.nn.gelu(self.hidden(inputs)))
+
+
+def loss(model, batch, context):
+    del context
+    inputs, targets = batch
+    return mean_squared_error(model(inputs), targets)
+
+
+records = [(jnp.ones((8,)), jnp.zeros((2,))) for _ in range(1_024)]
+dataset = Dataset(records).shuffle(42).batch(32)
+trainer = Trainer(MLP(), muon(), loss)
+trainer.fit(dataset, steps=20)
+```
+
+`Trainer` owns stable JIT boundaries for training, evaluation, prediction,
+automatic differentiation, accumulation, mixed precision, donation, and
+placement. Advanced users can still use `jax.jit`, `jax.grad`, and all other JAX
+APIs directly through `singularic.core.apply.apply`, graph definitions, and `State`.
+
+## Install
+
+Singularic requires Python 3.14 or newer.
+
+```console
+uv add singularic
+```
+
+JAX is the only numerical backend. Runtime dependencies are JAX, NumPy, and
+safetensors.
+
+## Core guarantees
+
+- One metadata-rich `State` pytree for parameters, buffers, caches, RNGs,
+  metrics, and optimizer slots.
+- One composable `Selector` and ordered rule system for optimization, freezing,
+  sharding, precision, and checkpoint policy.
+- Semantic Muon/AdamW routing through `singularic.optim.specs.muon()`; output heads use
+  `nn.Linear(..., role=ParamRole.OUTPUT_WEIGHT)`.
+- Immutable deterministic data pipelines with JSON-safe global cursors;
+  non-indexed sources must declare a `ResumableStream` replay contract.
+- Exact process-count elasticity for fixed-cardinality indexed pipelines.
+  Filtering and bucketing require deterministic source plans.
+- Versioned JSON plus safetensors checkpoint bundles; never pickle. Immutable
+  objects and conditional commit records work through the dependency-free
+  `ByteStore` protocol, with a durable POSIX/shared-filesystem adapter in core.
+
+Singularic 1.0.0 is the standalone release. The root package is a deliberately
+small facade; import every other public symbol from its owning module. Read the
+[quickstart](https://github.com/singularic/singularic/blob/main/docs/quickstart.md),
+[architecture contract](https://github.com/singularic/singularic/blob/main/docs/architecture.md),
+and [API guide](https://github.com/singularic/singularic/blob/main/docs/api.md). CPU, GPU, and TPU use the same portable-JAX
+correctness contract; GPU accelerators are optional and lazily imported.
+Serving, quantization, executable export, and external dataset connectors are
+out of scope.
+
+## Development and benchmarks
+
+All operations use `uv`:
+
+```console
+uv sync --group dev
+./scripts/check.sh
+```
+
+The individual development suites are:
+
+```console
+uv run pytest tests/api tests/core
+uv run pytest tests/nn
+uv run pytest tests/optim
+uv run pytest tests/train
+uv run pytest tests/data tests/checkpoint
+uv run pytest tests/distributed
+uv run pytest tests/inspect tests/property tests/performance tests/inference
+uv run ruff format --check src tests benchmarks
+uv run ruff check src tests benchmarks
+uv run mypy src/singularic benchmarks
+uv run --group docs mkdocs build --strict
+uv build
+```
+
+Run the reproducible decoder benchmark with
+`uv run python -m benchmarks.train_decoder`; see
+[benchmark policy](https://github.com/singularic/singularic/blob/main/docs/benchmarks.md) for environment-scoped baselines and the
+10% release-regression gate.
+
+Licensed under Apache-2.0.

singularic-1.0.0/pyproject.toml

@@ -0,0 +1,119 @@
+[build-system]
+requires = ["uv_build>=0.11.26,<0.12.0"]
+build-backend = "uv_build"
+
+[project]
+name = "singularic"
+version = "1.0.0"
+description = "Full-stack modern AI/ML library in pure JAX"
+readme = "README.md"
+requires-python = ">=3.14"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Singularic contributors" }]
+keywords = [
+  "jax",
+  "machine-learning",
+  "deep-learning",
+  "neural-networks",
+  "optimization",
+  "training",
+  "checkpoint",
+  "distributed",
+  "jax-framework",
+]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Typing :: Typed",
+]
+dependencies = [
+  "jax>=0.11.0,<0.12",
+  "numpy>=2.0,<3",
+  "safetensors>=0.8.0,<0.9",
+]
+
+[project.urls]
+Repository = "https://github.com/singularic/singularic"
+Homepage = "https://singularic.ai"
+Documentation = "https://singularic.ai/docs"
+"Bug Tracker" = "https://github.com/singularic/singularic/issues"
+Changelog = "https://github.com/singularic/singularic/releases"
+
+[dependency-groups]
+dev = [
+  "hypothesis>=6.135",
+  "mypy>=1.17",
+  "pytest>=8.4",
+  "pytest-cov>=6.2",
+  "pytest-timeout>=2.4",
+  "ruff>=0.12",
+]
+docs = [
+  "mkdocs>=1.6",
+  "mkdocs-material>=9.6",
+  "mkdocstrings[python]>=0.30",
+]
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.uv.build-backend]
+module-root = "src"
+module-name = "singularic"
+# Subpackages are PEP 420 namespaces.  The root module is the only facade;
+# users import concrete APIs from their owning modules.
+namespace = true
+
+[tool.pytest.ini_options]
+addopts = "-ra --strict-config --strict-markers"
+testpaths = ["tests"]
+pythonpath = ["."]
+filterwarnings = ["error"]
+markers = [
+  "distributed: tests that create multiple virtual CPU devices",
+  "hardware: tests that require a qualified accelerator runner",
+  "performance: non-default performance and benchmark assertions",
+]
+
+[tool.coverage.run]
+branch = true
+source = ["singularic"]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+# This is an enforced non-regression floor. Raise it as the untested runtime
+# paths receive coverage; a 95% global target was not representative of the
+# current hardware-dependent codebase.
+fail_under = 75
+
+[tool.ruff]
+line-length = 88
+target-version = "py314"
+src = ["src", "tests", "benchmarks"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "RUF", "PYI"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["singularic"]
+
+[tool.mypy]
+python_version = "3.14"
+strict = true
+packages = ["singularic"]
+mypy_path = "src"
+warn_unreachable = true
+
+[[tool.mypy.overrides]]
+module = ["jax.*", "safetensors.*"]
+ignore_missing_imports = true

singularic-1.0.0/src/singularic/__init__.py

@@ -0,0 +1,13 @@
+"""Singularic's intentionally minimal package marker.
+
+Stable APIs are imported from their owning modules.  Child directories are
+PEP 420 namespaces and deliberately have no package-barrel initializers.
+"""
+
+from importlib.metadata import version as _distribution_version
+from typing import Final
+
+from .core.apply import apply as apply
+from .core.state import State as State
+
+__version__: Final = _distribution_version("singularic")

singularic-1.0.0/src/singularic/checkpoint/bundle.py

@@ -0,0 +1,59 @@
+"""Generic portable checkpoint values independent of training orchestration."""
+
+import json
+from collections.abc import Mapping
+from dataclasses import dataclass
+from types import MappingProxyType
+from typing import Any
+
+from singularic.core.state import State
+
+
+def _json_value(value: Mapping[str, Any] | None, description: str) -> Mapping[str, Any]:
+    resolved = {} if value is None else dict(value)
+    try:
+        json.dumps(resolved, allow_nan=False, sort_keys=True)
+    except (TypeError, ValueError) as error:
+        raise TypeError(
+            f"CheckpointBundle {description} must be JSON-compatible"
+        ) from error
+    return MappingProxyType(resolved)
+
+
+@dataclass(frozen=True, slots=True)
+class CheckpointBundle:
+    """Named portable :class:`State` groups plus JSON metadata and cursor data.
+
+    The bundle has no knowledge of models, optimizers, or trainers.  Group names
+    are stable storage ownership boundaries, allowing a caller to restore just
+    the local state it owns.
+    """
+
+    groups: Mapping[str, State]
+    metadata: Mapping[str, Any] | None = None
+    dataset_cursor: Mapping[str, Any] | None = None
+
+    def __post_init__(self) -> None:
+        normalized = dict(self.groups)
+        if not normalized or any(
+            not isinstance(name, str) or not name for name in normalized
+        ):
+            raise ValueError("CheckpointBundle groups must have non-empty string names")
+        if any(not isinstance(state, State) for state in normalized.values()):
+            raise TypeError("CheckpointBundle groups must be State values")
+        object.__setattr__(self, "groups", MappingProxyType(normalized))
+        object.__setattr__(self, "metadata", _json_value(self.metadata, "metadata"))
+        object.__setattr__(
+            self, "dataset_cursor", _json_value(self.dataset_cursor, "dataset cursor")
+        )
+
+    def subset(self, names: tuple[str, ...]) -> CheckpointBundle:
+        if not names or len(names) != len(set(names)):
+            raise ValueError(
+                "CheckpointBundle subset names must be non-empty and unique"
+            )
+        try:
+            groups = {name: self.groups[name] for name in names}
+        except KeyError as error:
+            raise KeyError(f"Unknown checkpoint group {error.args[0]!r}") from error
+        return CheckpointBundle(groups, self.metadata, self.dataset_cursor)