o41-checkpoint 0.1.0__tar.gz

o41_checkpoint-0.1.0/LICENSE

@@ -0,0 +1,176 @@
+                              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

o41_checkpoint-0.1.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: o41-checkpoint
+Version: 0.1.0
+Requires-Dist: pytest>=8.0.0 ; extra == 'dev'
+Requires-Dist: ruff>=0.15.12 ; extra == 'dev'
+Requires-Dist: ty>=0.0.34 ; extra == 'dev'
+Provides-Extra: dev
+License-File: LICENSE
+Summary: Python bindings for 041's Rust checkpoint engine
+License-Expression: Apache-2.0
+Requires-Python: >=3.14, <3.15
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# 041 Checkpoint for Python
+
+Save, resume, and fork training checkpoints with Python bindings to the
+`o41-checkpoint` Rust engine.
+
+The Rust core handles multipart uploads, parallel ranged reads, retries, signed
+URL refresh, placement, and writer fencing. The Python interface accepts bytes
+and paths and returns typed checkpoint objects. Blocking calls release the GIL.
+
+## Install
+
+```sh
+uv add o41-checkpoint
+```
+
+Requires Python 3.14. Wheels target Linux x86-64, Linux arm64, and macOS arm64.
+Building from source requires Rust.
+
+## Resume and save
+
+```python
+from pathlib import Path
+from o41_checkpoint import Checkpoints, step_name
+
+checkpoints = Checkpoints("o41://experiments/run-1")
+writer = checkpoints.resume()
+
+if writer.resumed is not None:
+    writer.resumed.download("./restored")
+
+saved = writer.save(
+    step_name(600),
+    {
+        "weights.safetensors": Path("weights.safetensors"),
+        "state.json": b'{"step": 600}',
+    },
+    meta={"step": 600, "loss": 0.42},
+)
+print(saved.path, saved.size)
+```
+
+`resume()` returns a writer whose `resumed` checkpoint is the latest, or `None`
+when the location is empty. The same writer can save many checkpoints.
+`writer.latest` is the name that the next save must exceed. Use `start()` to
+require an empty location.
+
+Each file value is bytes or a filesystem path. Strings are paths. Rust reads
+paths one upload part at a time. Keep source files unchanged until `save()`
+returns. The core commits the manifest last, so interrupted saves do not appear
+in `load()` or `list()`.
+
+`save()` returns a `Saved` receipt with `name`, `path`, `committed`, `size`,
+`placement`, and `warning`. It returns after commit, without a follow-up read.
+Names must ascend in byte order. `step_name(600)` produces `step-00000600`. Use
+your own naming scheme for runs beyond 99,999,999 steps.
+
+## Read a checkpoint
+
+```python
+latest = checkpoints.load()  # None when no checkpoint is committed
+at_step = checkpoints.load(step_name(600))
+
+if at_step is not None:
+    state = at_step["state.json"].read()
+    header = at_step["weights.safetensors"].read(start=0, stop=8)
+    at_step["weights.safetensors"].download("./weights.safetensors")
+    at_step.download("./checkpoint")
+    print(at_step.meta, at_step.committed)
+
+for checkpoint in checkpoints.list():
+    print(checkpoint.name, checkpoint.size)
+```
+
+Reading and listing do not open a writer. `load()` and `load("latest")` return
+the latest checkpoint. A missing checkpoint returns `None`.
+
+`checkpoint.files` maps names to files with `name` and `size`. Checkpoints also
+expose `path`, `name`, `committed`, `size`, `meta`, `source`, `location`, and
+`transfer`. Commit times are timezone-aware `datetime` values. `location` and
+`transfer` are `None` for local directories and raw buckets.
+
+`read()` returns bytes. Ranges use Python's exclusive `stop` convention. Large
+reads use the core's parallel range reader. `download()` transfers files in
+bounded windows and returns a `Path`. It stages downloads beside the target and
+replaces files after successful transfer. A checkpoint download stages all files
+before moving them into the destination, one file at a time. Other files in the
+destination remain in place. It downloads the checkpoint's data files; it does
+not create a checkpoint catalog at the destination.
+
+## Fork a run
+
+```python
+source = checkpoints.load(step_name(600))
+if source is not None:
+    fork = Checkpoints("o41://experiments/run-2").fork(source)
+    assert fork.resumed is not None
+    fork.resumed.download("./fork-source")
+    fork.save(step_name(700), {"state.json": b'{"step": 700}'})
+```
+
+`fork()` requires an empty destination. It accepts a `Checkpoint` or a concrete
+checkpoint path, such as `o41://experiments/run-1/step-00000600`. Load the
+latest checkpoint first to fork it. The source stays in its existing location.
+The first save records `checkpoint.source`; subsequent saves do not.
+
+## Choose storage
+
+The same API supports these locations:
+
+| Location                          | Storage                                 | Writer fencing |
+| --------------------------------- | --------------------------------------- | -------------- |
+| `./checkpoints/run-1` or a `Path` | Local directory                         | No             |
+| `s3://bucket/run-1`               | S3-compatible bucket                    | No             |
+| `gs://bucket/run-1`               | Google Cloud Storage                    | No             |
+| `az://account/container/run-1`    | Azure Blob Storage                      | No             |
+| `o41://experiments/run-1`         | 041 Artifacts placement and signed URLs | Yes            |
+
+Local directories need no credentials. Raw buckets use the Rust `object_store`
+credential configuration. Pass overrides through
+`store_options={"aws_region": "us-east-1"}`, using `object_store` option names.
+
+For `o41://`, set `O41_ARTIFACTS_API_KEY` to an organization API key.
+`O41_ARTIFACTS_URL` overrides `https://artifacts.041.io`. `O41_ARTIFACTS_CLOUD`
+and `O41_ARTIFACTS_REGION` override placement together. Otherwise the core
+detects placement through SkyPilot or VM metadata and uses the organization's
+fallback when unknown.
+
+`Checkpoints(location, api_key=..., url=..., organization=..., cloud=..., region=..., retry_for=..., store_options=...)`
+overrides the core's environment configuration. `retry_for` is a duration in
+seconds. Omitted options use the Rust defaults, including its retry rules and
+longer begin/commit deadlines.
+
+## Notes and failures
+
+```python
+checkpoints.write_note("evaluated.json", b'{"step": 600}')
+note = checkpoints.note("evaluated.json")  # bytes, or None when absent
+```
+
+Notes hold up to 64 KiB beside the checkpoints and do not require a writer. A
+checkpoint holds 1 to 1000 files and up to 16 KiB of JSON metadata. File names
+cannot contain directories.
+
+`CheckpointError` reports failures from the Rust engine. `NotEmpty` and
+`Superseded` derive from it. On `o41://`, another writer opening the artifact
+fences the old writer. Catch `Superseded` to stop that run. Exceptions expose
+`code`, `status`, `epoch`, and `location` when the core supplies them. Python
+argument conversion errors use `TypeError` or `ValueError`, and local staging
+failures can raise `OSError`.
+
+Handles retain the Rust runtime for as long as they are referenced. Create them
+inside each worker process rather than sharing them across a process fork.
+

o41_checkpoint-0.1.0/README.md

@@ -0,0 +1,152 @@
+# 041 Checkpoint for Python
+
+Save, resume, and fork training checkpoints with Python bindings to the
+`o41-checkpoint` Rust engine.
+
+The Rust core handles multipart uploads, parallel ranged reads, retries, signed
+URL refresh, placement, and writer fencing. The Python interface accepts bytes
+and paths and returns typed checkpoint objects. Blocking calls release the GIL.
+
+## Install
+
+```sh
+uv add o41-checkpoint
+```
+
+Requires Python 3.14. Wheels target Linux x86-64, Linux arm64, and macOS arm64.
+Building from source requires Rust.
+
+## Resume and save
+
+```python
+from pathlib import Path
+from o41_checkpoint import Checkpoints, step_name
+
+checkpoints = Checkpoints("o41://experiments/run-1")
+writer = checkpoints.resume()
+
+if writer.resumed is not None:
+    writer.resumed.download("./restored")
+
+saved = writer.save(
+    step_name(600),
+    {
+        "weights.safetensors": Path("weights.safetensors"),
+        "state.json": b'{"step": 600}',
+    },
+    meta={"step": 600, "loss": 0.42},
+)
+print(saved.path, saved.size)
+```
+
+`resume()` returns a writer whose `resumed` checkpoint is the latest, or `None`
+when the location is empty. The same writer can save many checkpoints.
+`writer.latest` is the name that the next save must exceed. Use `start()` to
+require an empty location.
+
+Each file value is bytes or a filesystem path. Strings are paths. Rust reads
+paths one upload part at a time. Keep source files unchanged until `save()`
+returns. The core commits the manifest last, so interrupted saves do not appear
+in `load()` or `list()`.
+
+`save()` returns a `Saved` receipt with `name`, `path`, `committed`, `size`,
+`placement`, and `warning`. It returns after commit, without a follow-up read.
+Names must ascend in byte order. `step_name(600)` produces `step-00000600`. Use
+your own naming scheme for runs beyond 99,999,999 steps.
+
+## Read a checkpoint
+
+```python
+latest = checkpoints.load()  # None when no checkpoint is committed
+at_step = checkpoints.load(step_name(600))
+
+if at_step is not None:
+    state = at_step["state.json"].read()
+    header = at_step["weights.safetensors"].read(start=0, stop=8)
+    at_step["weights.safetensors"].download("./weights.safetensors")
+    at_step.download("./checkpoint")
+    print(at_step.meta, at_step.committed)
+
+for checkpoint in checkpoints.list():
+    print(checkpoint.name, checkpoint.size)
+```
+
+Reading and listing do not open a writer. `load()` and `load("latest")` return
+the latest checkpoint. A missing checkpoint returns `None`.
+
+`checkpoint.files` maps names to files with `name` and `size`. Checkpoints also
+expose `path`, `name`, `committed`, `size`, `meta`, `source`, `location`, and
+`transfer`. Commit times are timezone-aware `datetime` values. `location` and
+`transfer` are `None` for local directories and raw buckets.
+
+`read()` returns bytes. Ranges use Python's exclusive `stop` convention. Large
+reads use the core's parallel range reader. `download()` transfers files in
+bounded windows and returns a `Path`. It stages downloads beside the target and
+replaces files after successful transfer. A checkpoint download stages all files
+before moving them into the destination, one file at a time. Other files in the
+destination remain in place. It downloads the checkpoint's data files; it does
+not create a checkpoint catalog at the destination.
+
+## Fork a run
+
+```python
+source = checkpoints.load(step_name(600))
+if source is not None:
+    fork = Checkpoints("o41://experiments/run-2").fork(source)
+    assert fork.resumed is not None
+    fork.resumed.download("./fork-source")
+    fork.save(step_name(700), {"state.json": b'{"step": 700}'})
+```
+
+`fork()` requires an empty destination. It accepts a `Checkpoint` or a concrete
+checkpoint path, such as `o41://experiments/run-1/step-00000600`. Load the
+latest checkpoint first to fork it. The source stays in its existing location.
+The first save records `checkpoint.source`; subsequent saves do not.
+
+## Choose storage
+
+The same API supports these locations:
+
+| Location                          | Storage                                 | Writer fencing |
+| --------------------------------- | --------------------------------------- | -------------- |
+| `./checkpoints/run-1` or a `Path` | Local directory                         | No             |
+| `s3://bucket/run-1`               | S3-compatible bucket                    | No             |
+| `gs://bucket/run-1`               | Google Cloud Storage                    | No             |
+| `az://account/container/run-1`    | Azure Blob Storage                      | No             |
+| `o41://experiments/run-1`         | 041 Artifacts placement and signed URLs | Yes            |
+
+Local directories need no credentials. Raw buckets use the Rust `object_store`
+credential configuration. Pass overrides through
+`store_options={"aws_region": "us-east-1"}`, using `object_store` option names.
+
+For `o41://`, set `O41_ARTIFACTS_API_KEY` to an organization API key.
+`O41_ARTIFACTS_URL` overrides `https://artifacts.041.io`. `O41_ARTIFACTS_CLOUD`
+and `O41_ARTIFACTS_REGION` override placement together. Otherwise the core
+detects placement through SkyPilot or VM metadata and uses the organization's
+fallback when unknown.
+
+`Checkpoints(location, api_key=..., url=..., organization=..., cloud=..., region=..., retry_for=..., store_options=...)`
+overrides the core's environment configuration. `retry_for` is a duration in
+seconds. Omitted options use the Rust defaults, including its retry rules and
+longer begin/commit deadlines.
+
+## Notes and failures
+
+```python
+checkpoints.write_note("evaluated.json", b'{"step": 600}')
+note = checkpoints.note("evaluated.json")  # bytes, or None when absent
+```
+
+Notes hold up to 64 KiB beside the checkpoints and do not require a writer. A
+checkpoint holds 1 to 1000 files and up to 16 KiB of JSON metadata. File names
+cannot contain directories.
+
+`CheckpointError` reports failures from the Rust engine. `NotEmpty` and
+`Superseded` derive from it. On `o41://`, another writer opening the artifact
+fences the old writer. Catch `Superseded` to stop that run. Exceptions expose
+`code`, `status`, `epoch`, and `location` when the core supplies them. Python
+argument conversion errors use `TypeError` or `ValueError`, and local staging
+failures can raise `OSError`.
+
+Handles retain the Rust runtime for as long as they are referenced. Create them
+inside each worker process rather than sharing them across a process fork.

o41_checkpoint-0.1.0/crates/o41-checkpoint/.gitignore

@@ -0,0 +1 @@
+/target/