blut-core 0.1.0__tar.gz

blut_core-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+/target/
+/Cargo.lock.bak
+**/__pycache__/
+*.pyc
+.DS_Store
+*.swp

blut_core-0.1.0/LICENSE

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

blut_core-0.1.0/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.5
+Name: blut-core
+Version: 0.1.0
+Summary: Shared Python runtime for BLUT cookbooks: run context, metric log, status wire, run manifest, checkpoint contract, ingredient registry.
+Project-URL: Repository, https://github.com/Quitetall/blut-cookbooks
+Author: Brian Lam
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: blut,cookbook,metrics,provenance,training
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Provides-Extra: parquet
+Requires-Dist: pyarrow>=15; extra == 'parquet'
+Provides-Extra: torch
+Requires-Dist: torch>=2.5; extra == 'torch'
+Description-Content-Type: text/markdown
+
+# blut-core
+
+The shared Python runtime for [BLUT](https://github.com/Quitetall/blut) cookbooks:
+domain-agnostic building blocks any cookbook can reuse.
+
+- `runctx` — run identity and filesystem anchors from the BLUT environment
+- `MetricLog` — atomic per-epoch CSV/Parquet metric writer
+- `read_metric` — verbatim metric/log reader (no model in the path)
+- `status` — the StatusUpdate wire protocol
+- `RunManifest` — run provenance, written even on crash
+- `checkpoint` — corruption-safe save/load and the resume payload contract
+- `sysgauge` — best-effort GPU/host snapshot for the metric stream
+- `async_io` — bounded, backpressured delivery for persistence work
+- the ingredient specs and builders the generic training recipes build on
+
+`torch` is imported lazily, inside `checkpoint` and `sysgauge` only, so
+`import blut_core` stays cheap. Install `blut-core[torch]` if you call those, and `blut-core[parquet]` for
+Parquet metric logs.
+
+Apache-2.0. Published from the `blut-cookbooks` repository.

blut_core-0.1.0/README.md

@@ -0,0 +1,20 @@
+# blut-core
+
+The shared Python runtime for [BLUT](https://github.com/Quitetall/blut) cookbooks:
+domain-agnostic building blocks any cookbook can reuse.
+
+- `runctx` — run identity and filesystem anchors from the BLUT environment
+- `MetricLog` — atomic per-epoch CSV/Parquet metric writer
+- `read_metric` — verbatim metric/log reader (no model in the path)
+- `status` — the StatusUpdate wire protocol
+- `RunManifest` — run provenance, written even on crash
+- `checkpoint` — corruption-safe save/load and the resume payload contract
+- `sysgauge` — best-effort GPU/host snapshot for the metric stream
+- `async_io` — bounded, backpressured delivery for persistence work
+- the ingredient specs and builders the generic training recipes build on
+
+`torch` is imported lazily, inside `checkpoint` and `sysgauge` only, so
+`import blut_core` stays cheap. Install `blut-core[torch]` if you call those, and `blut-core[parquet]` for
+Parquet metric logs.
+
+Apache-2.0. Published from the `blut-cookbooks` repository.

blut_core-0.1.0/blut_core/__init__.py

@@ -0,0 +1,54 @@
+"""Shared Python runtime and ingredient registry for BLUT cookbooks.
+
+The package contains domain-agnostic building blocks reusable by any cookbook:
+
+- ``async_io``     — bounded, backpressured delivery for persistence work
+- ``runctx``       — run identity + filesystem anchors from the BLUT env (P10)
+- ``MetricLog``    — atomic per-epoch CSV/Parquet metric writer
+- ``read_metric``  — verbatim metric/log reader (no LLM in the path; ADR 0038)
+- ``status``       — emit/read the StatusUpdate wire protocol (P4)
+- ``RunManifest``  — run provenance, written even on crash (P8)
+- ``checkpoint``   — corruption-safe save/load + resume payload contract (P7)
+- ``sysgauge``     — best-effort GPU/host snapshot for the metric stream (P10)
+- ingredient specs and builders used by generic training recipes
+
+``torch`` is lazy-imported only inside ``checkpoint``/``sysgauge`` functions, so
+``import blut_core`` stays cheap and dependency-light. See ``blut/docs/metrics.md``
+and decisions/0037, 0044.
+"""
+
+from blut_core.registry import (
+    build_ingredient,
+    get_spec,
+    list_ingredients,
+    register_ingredient,
+)
+from blut_core.spec import KINDS, IngredientSpec
+
+# Register generic ingredient specs on package import.
+from blut_core.ingredients import _specs as _ingredient_specs  # noqa: F401
+
+from . import async_io, checkpoint, runctx, status, sysgauge
+from .metric_log import MetricLog
+from .run_manifest import RunManifest
+
+# read_metric is a CLI module (`python -m blut_core.read_metric`); it is NOT
+# eager-imported here (that triggers a runpy double-import warning under -m).
+# `from blut_core import read_metric` still works (submodule import).
+
+__all__ = [
+    "IngredientSpec",
+    "KINDS",
+    "MetricLog",
+    "RunManifest",
+    "async_io",
+    "build_ingredient",
+    "checkpoint",
+    "get_spec",
+    "list_ingredients",
+    "read_metric",
+    "register_ingredient",
+    "runctx",
+    "status",
+    "sysgauge",
+]

blut_core-0.1.0/blut_core/async_io.py

@@ -0,0 +1,246 @@
+"""Bounded, backpressured asynchronous I/O for cookbook runtimes.
+
+Bounded workers are daemons so an exceptional interpreter shutdown cannot hang
+on an idle worker. Successful callers must still call :meth:`AsyncSink.close`;
+that is the only boundary that drains accepted work and surfaces worker errors.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from queue import Queue
+from threading import BoundedSemaphore, Condition, Thread, local
+from typing import Callable, Generic, TypeVar, cast
+
+
+__all__ = [
+    "AsyncSink",
+    "AsyncSinkWorkerError",
+    "Bounded",
+    "Inline",
+    "ItemTooLargeError",
+    "SinkClosedError",
+]
+
+
+ItemT = TypeVar("ItemT")
+
+
+def _identity(item: ItemT) -> ItemT:
+    return item
+
+
+class ItemTooLargeError(ValueError):
+    """A submitted item exceeds the sink's declared retention limit."""
+
+    def __init__(self, size_bytes: int, max_item_bytes: int) -> None:
+        self.size_bytes = size_bytes
+        self.max_item_bytes = max_item_bytes
+        super().__init__(f"item is {size_bytes} bytes; limit is {max_item_bytes}")
+
+
+class SinkClosedError(RuntimeError):
+    """Work was submitted after sink shutdown began."""
+
+
+class AsyncSinkWorkerError(RuntimeError):
+    """A sink worker failed while delivering an accepted item."""
+
+    def __init__(self, worker_error_type: str, message: str) -> None:
+        self.worker_error_type = worker_error_type
+        super().__init__(message)
+
+
+@dataclass(frozen=True)
+class _WorkerFailure:
+    worker_error_type: str
+    message: str
+
+    @classmethod
+    def capture(cls, error: BaseException) -> _WorkerFailure:
+        error_type = type(error)
+        worker_error_type = f"{error_type.__module__}.{error_type.__qualname__}"
+        try:
+            message = str(error)
+        except BaseException:
+            message = "worker failure with an unprintable message"
+        return cls(worker_error_type=worker_error_type, message=message)
+
+    def to_exception(self) -> AsyncSinkWorkerError:
+        return AsyncSinkWorkerError(self.worker_error_type, self.message)
+
+
+@dataclass(frozen=True)
+class Inline:
+    """Run the installed handler synchronously on the submitting thread."""
+
+
+@dataclass(frozen=True)
+class Bounded:
+    """Run work on one worker with bounded retained residency."""
+
+    capacity: int
+    max_item_bytes: int
+
+    def __post_init__(self) -> None:
+        if isinstance(self.capacity, bool) or not isinstance(self.capacity, int):
+            raise TypeError("capacity must be an integer")
+        if isinstance(self.max_item_bytes, bool) or not isinstance(
+            self.max_item_bytes, int
+        ):
+            raise TypeError("max_item_bytes must be an integer")
+        if self.capacity <= 0:
+            raise ValueError("capacity must be greater than zero")
+        if self.max_item_bytes <= 0:
+            raise ValueError("max_item_bytes must be greater than zero")
+
+
+_STOP = object()
+
+
+class AsyncSink(Generic[ItemT]):
+    """Deliver items to one handler under an explicit, close-required mode."""
+
+    def __init__(
+        self,
+        handler: Callable[[ItemT], None],
+        mode: Inline | Bounded,
+        *,
+        item_size: Callable[[ItemT], int] | None = None,
+        retain: Callable[[ItemT], ItemT] = _identity,
+        retained_size: Callable[[ItemT], int] | None = None,
+        thread_name: str = "blut-async-io",
+    ) -> None:
+        self._handler = handler
+        self._mode = mode
+        self._item_size = item_size
+        self._retain = retain
+        self._retained_size = retained_size
+        self._closed = False
+        self._failure: _WorkerFailure | None = None
+        self._state = Condition()
+        self._active_submits = 0
+        self._stop_enqueued = False
+        self._callback_state = local()
+        self._queue: Queue[ItemT | object] | None = None
+        self._slots: BoundedSemaphore | None = None
+        self._worker: Thread | None = None
+        if isinstance(mode, Bounded):
+            self._queue = Queue(maxsize=mode.capacity)
+            self._slots = BoundedSemaphore(mode.capacity)
+            self._worker = Thread(target=self._run, name=thread_name, daemon=True)
+            self._worker.start()
+
+    def submit(self, item: ItemT, *, size_bytes: int | None = None) -> None:
+        """Deliver one item according to the configured mode."""
+
+        if getattr(self._callback_state, "active", False):
+            raise RuntimeError("submit cannot be called from a sink callback")
+
+        with self._state:
+            self._raise_if_failed_locked()
+            if self._closed:
+                raise SinkClosedError("sink is closed")
+            self._active_submits += 1
+
+        acquired_slot = False
+        try:
+            if isinstance(self._mode, Inline):
+                self._invoke_handler(self._invoke_callback(self._retain, item))
+                return
+
+            if size_bytes is None and self._item_size is not None:
+                size_bytes = self._invoke_callback(self._item_size, item)
+            if size_bytes is None and self._retained_size is None:
+                raise TypeError(
+                    "bounded submit requires size_bytes, item_size, or retained_size"
+                )
+            if size_bytes is not None:
+                if isinstance(size_bytes, bool) or not isinstance(size_bytes, int):
+                    raise TypeError("item size must be an integer byte count")
+                if size_bytes < 0:
+                    raise ValueError("item size must not be negative")
+                if size_bytes > self._mode.max_item_bytes:
+                    raise ItemTooLargeError(size_bytes, self._mode.max_item_bytes)
+
+            slots = cast(BoundedSemaphore, self._slots)
+            queue = cast(Queue[ItemT | object], self._queue)
+            slots.acquire()
+            acquired_slot = True
+            with self._state:
+                self._raise_if_failed_locked()
+                if self._closed:
+                    raise SinkClosedError("sink is closed")
+            retained = self._invoke_callback(self._retain, item)
+            if self._retained_size is not None:
+                retained_bytes = self._invoke_callback(self._retained_size, retained)
+                if isinstance(retained_bytes, bool) or not isinstance(retained_bytes, int):
+                    raise TypeError("retained item size must be an integer byte count")
+                if retained_bytes < 0:
+                    raise ValueError("retained item size must not be negative")
+                if retained_bytes > self._mode.max_item_bytes:
+                    raise ItemTooLargeError(retained_bytes, self._mode.max_item_bytes)
+            queue.put(retained)
+            acquired_slot = False
+        finally:
+            if acquired_slot:
+                cast(BoundedSemaphore, self._slots).release()
+            with self._state:
+                self._active_submits -= 1
+                self._state.notify_all()
+
+    def close(self) -> None:
+        """Drain accepted work and stop the sink."""
+
+        if getattr(self._callback_state, "active", False):
+            raise RuntimeError("close cannot be called from a sink callback")
+
+        with self._state:
+            self._closed = True
+            while self._active_submits:
+                self._state.wait()
+            if self._worker is not None and not self._stop_enqueued:
+                cast(Queue[ItemT | object], self._queue).put(_STOP)
+                self._stop_enqueued = True
+
+        if self._worker is not None:
+            self._worker.join()
+        self._raise_if_failed()
+
+    def _run(self) -> None:
+        queue = cast(Queue[ItemT | object], self._queue)
+        slots = cast(BoundedSemaphore, self._slots)
+        while True:
+            item = queue.get()
+            if item is _STOP:
+                return
+            try:
+                self._invoke_handler(cast(ItemT, item))
+            except BaseException as error:
+                with self._state:
+                    if self._failure is None:
+                        self._failure = _WorkerFailure.capture(error)
+            finally:
+                del item
+                slots.release()
+
+    def _invoke_handler(self, item: ItemT) -> None:
+        self._invoke_callback(self._handler, item)
+
+    def _invoke_callback(self, callback, item):
+        previous = getattr(self._callback_state, "active", False)
+        self._callback_state.active = True
+        try:
+            return callback(item)
+        finally:
+            self._callback_state.active = previous
+
+    def _raise_if_failed_locked(self) -> None:
+        if self._failure is not None:
+            raise self._failure.to_exception()
+
+    def _raise_if_failed(self) -> None:
+        with self._state:
+            failure = self._failure
+        if failure is not None:
+            raise failure.to_exception()