mujou 0.1.0__tar.gz

mujou-0.1.0/Cargo.lock

@@ -0,0 +1,267 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "anyhow"
+version = "1.0.104"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "330a5ed07fa54e4702c9d6c4174f74427fc0ef6e214bbd677ae50a5099946470"
+
+[[package]]
+name = "goblin"
+version = "0.10.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "17582616a7718cca54cec18e534a76c7c4aec11a8b9a85695712f262fd15a4c8"
+dependencies = [
+ "log",
+ "plain",
+ "scroll",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "itoa"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
+
+[[package]]
+name = "libc"
+version = "0.2.190"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce5d3ddc6d3fa000eb1536d85e147bfe31aacaba692ed6a876f95cb7c855be78"
+
+[[package]]
+name = "log"
+version = "0.4.34"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f9f8bd3e56ce4dfc153cf470fffbfa98c7620958b312ca5c3a4b8d5181fd13c6"
+
+[[package]]
+name = "memchr"
+version = "2.8.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98"
+
+[[package]]
+name = "mujou-core"
+version = "0.1.0"
+
+[[package]]
+name = "mujou-python"
+version = "0.1.0"
+dependencies = [
+ "mujou-core",
+ "pyo3",
+]
+
+[[package]]
+name = "mujou-stubgen"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "pyo3-introspection",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "plain"
+version = "0.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b4596b6d070b27117e987119b4dac604f3c58cfb0b191112e24771b2faeac1a6"
+
+[[package]]
+name = "portable-atomic"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "05c8b63e8d9609db387f0324918f81d68fe27748f084ef092fb35954d0539a85"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.107"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.30.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "229ca13b8a15bb0d1487b81ab975bfcd97513416499a8312011b6036e42e0de4"
+dependencies = [
+ "libc",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.30.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "70130e2b6dd1ee589a8788026a429561ca5c40fa7a2fa7914c2282eddae24700"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.30.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5e7ff73c555c286d212d4ce7e5fbda845a973c4f61bd5f160f5f2c3c2a04d1c4"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-introspection"
+version = "0.30.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3b2ac30f128e6ab4ca1c464d6eabd30c84c7adc5955c3bb2eb7d203ea24ebd18"
+dependencies = [
+ "anyhow",
+ "goblin",
+ "serde",
+ "serde_json",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.30.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c46d2e5862c7bb8207e3b639f713dda3c499933444784154c11d013c5a691b60"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.30.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "38b89f066f2ae72a2aef52d1537ca2fcd104440ebfadee06e97aa90738a25b9b"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "scroll"
+version = "0.13.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c1257cd4248b4132760d6524d6dda4e053bc648c9070b960929bf50cfb1e7add"
+dependencies = [
+ "scroll_derive",
+]
+
+[[package]]
+name = "scroll_derive"
+version = "0.13.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e1a36a382ed65dbcc0ab47fd5e9a94112417ccd34560a392ef3b7b0f0ec39148"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "serde"
+version = "1.0.229"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4148590afebada386688f18773da617792bf2ef03ffc1e4cbd2b1d45b023e0ba"
+dependencies = [
+ "serde_core",
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_core"
+version = "1.0.229"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "67dca2c9c51e58a4791a4b1ed58308b39c64224d349a935ab5039aa360942a48"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.229"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "serde_json"
+version = "1.0.154"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e7e9cc8b1b85264074fbcc02a88680c4096b1e47df8f739dceb03bf482f04bd6"
+dependencies = [
+ "itoa",
+ "memchr",
+ "serde",
+ "serde_core",
+ "zmij",
+]
+
+[[package]]
+name = "syn"
+version = "3.0.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d78c8dee4c7bf0e14673097256fed6142ce9d3b85a408189d07482442145823b"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.27"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a2c754d6c33795a1c324727428e5a7dedb5b06195f9890bdbcba760d3e246563"
+
+[[package]]
+name = "zmij"
+version = "1.0.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "29666d0abbfad1e3dc4dcf6144730dd3a3ab225bbbdac83319345b1b44ccfc1b"

mujou-0.1.0/Cargo.toml

@@ -0,0 +1,10 @@
+[workspace]
+members = ["crates/*"]
+resolver = "3"
+
+# The version of the Python package `mujou` too (maturin reads it).
+[workspace.package]
+version = "0.1.0"
+edition = "2024"
+rust-version = "1.85"
+license = "MIT"

mujou-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Geson-anko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mujou-0.1.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: mujou
+Version: 0.1.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Free Threading
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Rust
+Requires-Dist: torch>=2.14.1
+License-File: LICENSE
+Summary: Asynchronous Distributed Deep Learning Library for Continuous Learning
+License-Expression: MIT
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/Geson-anko/mujou/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://geson-anko.github.io/mujou/
+Project-URL: Issues, https://github.com/Geson-anko/mujou/issues
+Project-URL: Repository, https://github.com/Geson-anko/mujou
+
+# Mujou
+
+**Asynchronous Distributed Deep Learning Library for Continuous Learning.**
+
+[![Test](https://github.com/Geson-anko/mujou/actions/workflows/test.yml/badge.svg)](https://github.com/Geson-anko/mujou/actions/workflows/test.yml)
+[![Type Check](https://github.com/Geson-anko/mujou/actions/workflows/type-check.yml/badge.svg)](https://github.com/Geson-anko/mujou/actions/workflows/type-check.yml)
+[![Format & Lint](https://github.com/Geson-anko/mujou/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/Geson-anko/mujou/actions/workflows/pre-commit.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Geson-anko/mujou/blob/main/LICENSE)
+[![Python 3.14](https://img.shields.io/badge/python-3.14-blue.svg)](https://www.python.org/)
+
+Mujou (無常, "impermanence") is a deep learning framework where inference and learning happen at the same time. You write nodes in PyTorch code and connect them into a network that runs in the background. Most models are trained once and then frozen; Mujou is for machines that keep learning from a stream, such as real-time systems and robots.
+
+> **Status: early development (0.x).** The API works but will still change; a minor release (0.x.0) may break it. See the [changelog](https://github.com/Geson-anko/mujou/blob/main/CHANGELOG.md).
+
+## Key ideas
+
+- **No epochs, no train/inference modes.** A running network takes input, produces output and learns, all at once.
+- **Synchronous inside, asynchronous outside.** Each node computes synchronously in ordinary PyTorch code. Nodes never wait for each other; a node reads the latest value its neighbour sent.
+- **One time axis per run.** A node updates by an amount proportional to `dt`, the time since its last update, so nodes that update at different rates share one flow of time.
+- **Any update rule.** The rule is written inside the nodes: [PC-ALM](https://pub.sakana.ai/pc-alm/) (Augmented Lagrangian Predictive Coding, the nodes of `mujou.pc`), which learns with updates local to each node, backpropagation kept inside one node, or a rule of your own.
+
+## Install
+
+Mujou is on PyPI. It needs Python 3.14 or later; the free-threaded build 3.14t is recommended, because the nodes run on several threads at once.
+
+```sh
+uv add mujou       # in a uv project
+pip install mujou  # or in a virtual environment with Python 3.14
+```
+
+Wheels are built for Linux (x86_64, aarch64), macOS (arm64) and Windows (x86_64), for both 3.14 and 3.14t. PyTorch is installed as a dependency. On other platforms, pip builds Mujou from the source, which needs a Rust toolchain ([rustup](https://rustup.rs/)). The [installation guide](https://geson-anko.github.io/mujou/latest/install/) also explains how to build from a clone of the repository.
+
+## Example
+
+Two nodes compute `y = 2x + 1` in the background; the program writes `x` and waits for `y` ([`examples/quickstart.py`](https://github.com/Geson-anko/mujou/blob/main/examples/quickstart.py)).
+
+```python
+from typing import override
+
+import torch
+
+import mujou
+from mujou import Network, Node, Port, TensorSpec
+
+VECTOR = TensorSpec((3,))  # every message here is a float32 vector of 3
+
+
+class Affine(Node):
+    """Sends ``a * x + b``, where ``x`` is the latest input."""
+
+    def __init__(self, a: float, b: float) -> None:
+        super().__init__()
+        self.a, self.b = a, b  # settings, not state
+        self.prev = Port(recv=VECTOR)  # receives from the previous node
+        self.next = Port(send=VECTOR)  # sends to the next node
+
+    @override
+    def on_update(self, dt: float) -> None:
+        super().on_update(dt)
+        self.next.send(self.a * self.prev.recv() + self.b)  # recv() never waits
+
+
+class Pipeline(Network):
+    """``x -> scale -> shift ->``: y = 2 x + 1."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.scale = Affine(2.0, 0.0)
+        self.shift = Affine(1.0, 1.0)
+        self.scale.next.connect(self.shift.prev)
+        self.prev, self.next = self.scale.prev, self.shift.next  # exposed as its own
+
+
+net = Pipeline()
+x = torch.tensor([1.0, 2.0, 3.0])
+# The nodes run on the run's worker threads until the end of the `with` block.
+with mujou.run(net) as run:
+    run.write({net.prev: x})
+    # x takes a few updates to pass through the nodes: wait until y arrives, with
+    # the time it was sent (TimeoutError after 5 s of real time).
+    y, t = run.wait_for(net.next, lambda y: torch.equal(y, 2 * x + 1), timeout=5.0)
+    assert t is not None  # None only for the zeros before the first send
+
+print(f"y = {y} at t = {float(t):.3f} s")
+```
+
+More programs, from writing a node to learning MNIST with PC-ALM, are in [`examples/`](https://github.com/Geson-anko/mujou/blob/main/examples/).
+
+## Documentation
+
+The documentation is at <https://geson-anko.github.io/mujou/> (English and Japanese). To serve it locally, run `just docs` (needs [just](https://just.systems/)) and open <http://127.0.0.1:8000>. You can also read the Markdown in [`docs/en/`](https://github.com/Geson-anko/mujou/blob/main/docs/en/) (English) and [`docs/ja/`](https://github.com/Geson-anko/mujou/blob/main/docs/ja/) (Japanese).
+
+## Contributing
+
+Issues and pull requests are welcome. See [CONTRIBUTING.md](https://github.com/Geson-anko/mujou/blob/main/CONTRIBUTING.md) for the development setup, the dev container, the commands and the rules.
+
+## License
+
+MIT. See [LICENSE](https://github.com/Geson-anko/mujou/blob/main/LICENSE).
+

mujou-0.1.0/README.md

@@ -0,0 +1,99 @@
+# Mujou
+
+**Asynchronous Distributed Deep Learning Library for Continuous Learning.**
+
+[![Test](https://github.com/Geson-anko/mujou/actions/workflows/test.yml/badge.svg)](https://github.com/Geson-anko/mujou/actions/workflows/test.yml)
+[![Type Check](https://github.com/Geson-anko/mujou/actions/workflows/type-check.yml/badge.svg)](https://github.com/Geson-anko/mujou/actions/workflows/type-check.yml)
+[![Format & Lint](https://github.com/Geson-anko/mujou/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/Geson-anko/mujou/actions/workflows/pre-commit.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Geson-anko/mujou/blob/main/LICENSE)
+[![Python 3.14](https://img.shields.io/badge/python-3.14-blue.svg)](https://www.python.org/)
+
+Mujou (無常, "impermanence") is a deep learning framework where inference and learning happen at the same time. You write nodes in PyTorch code and connect them into a network that runs in the background. Most models are trained once and then frozen; Mujou is for machines that keep learning from a stream, such as real-time systems and robots.
+
+> **Status: early development (0.x).** The API works but will still change; a minor release (0.x.0) may break it. See the [changelog](https://github.com/Geson-anko/mujou/blob/main/CHANGELOG.md).
+
+## Key ideas
+
+- **No epochs, no train/inference modes.** A running network takes input, produces output and learns, all at once.
+- **Synchronous inside, asynchronous outside.** Each node computes synchronously in ordinary PyTorch code. Nodes never wait for each other; a node reads the latest value its neighbour sent.
+- **One time axis per run.** A node updates by an amount proportional to `dt`, the time since its last update, so nodes that update at different rates share one flow of time.
+- **Any update rule.** The rule is written inside the nodes: [PC-ALM](https://pub.sakana.ai/pc-alm/) (Augmented Lagrangian Predictive Coding, the nodes of `mujou.pc`), which learns with updates local to each node, backpropagation kept inside one node, or a rule of your own.
+
+## Install
+
+Mujou is on PyPI. It needs Python 3.14 or later; the free-threaded build 3.14t is recommended, because the nodes run on several threads at once.
+
+```sh
+uv add mujou       # in a uv project
+pip install mujou  # or in a virtual environment with Python 3.14
+```
+
+Wheels are built for Linux (x86_64, aarch64), macOS (arm64) and Windows (x86_64), for both 3.14 and 3.14t. PyTorch is installed as a dependency. On other platforms, pip builds Mujou from the source, which needs a Rust toolchain ([rustup](https://rustup.rs/)). The [installation guide](https://geson-anko.github.io/mujou/latest/install/) also explains how to build from a clone of the repository.
+
+## Example
+
+Two nodes compute `y = 2x + 1` in the background; the program writes `x` and waits for `y` ([`examples/quickstart.py`](https://github.com/Geson-anko/mujou/blob/main/examples/quickstart.py)).
+
+```python
+from typing import override
+
+import torch
+
+import mujou
+from mujou import Network, Node, Port, TensorSpec
+
+VECTOR = TensorSpec((3,))  # every message here is a float32 vector of 3
+
+
+class Affine(Node):
+    """Sends ``a * x + b``, where ``x`` is the latest input."""
+
+    def __init__(self, a: float, b: float) -> None:
+        super().__init__()
+        self.a, self.b = a, b  # settings, not state
+        self.prev = Port(recv=VECTOR)  # receives from the previous node
+        self.next = Port(send=VECTOR)  # sends to the next node
+
+    @override
+    def on_update(self, dt: float) -> None:
+        super().on_update(dt)
+        self.next.send(self.a * self.prev.recv() + self.b)  # recv() never waits
+
+
+class Pipeline(Network):
+    """``x -> scale -> shift ->``: y = 2 x + 1."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.scale = Affine(2.0, 0.0)
+        self.shift = Affine(1.0, 1.0)
+        self.scale.next.connect(self.shift.prev)
+        self.prev, self.next = self.scale.prev, self.shift.next  # exposed as its own
+
+
+net = Pipeline()
+x = torch.tensor([1.0, 2.0, 3.0])
+# The nodes run on the run's worker threads until the end of the `with` block.
+with mujou.run(net) as run:
+    run.write({net.prev: x})
+    # x takes a few updates to pass through the nodes: wait until y arrives, with
+    # the time it was sent (TimeoutError after 5 s of real time).
+    y, t = run.wait_for(net.next, lambda y: torch.equal(y, 2 * x + 1), timeout=5.0)
+    assert t is not None  # None only for the zeros before the first send
+
+print(f"y = {y} at t = {float(t):.3f} s")
+```
+
+More programs, from writing a node to learning MNIST with PC-ALM, are in [`examples/`](https://github.com/Geson-anko/mujou/blob/main/examples/).
+
+## Documentation
+
+The documentation is at <https://geson-anko.github.io/mujou/> (English and Japanese). To serve it locally, run `just docs` (needs [just](https://just.systems/)) and open <http://127.0.0.1:8000>. You can also read the Markdown in [`docs/en/`](https://github.com/Geson-anko/mujou/blob/main/docs/en/) (English) and [`docs/ja/`](https://github.com/Geson-anko/mujou/blob/main/docs/ja/) (Japanese).
+
+## Contributing
+
+Issues and pull requests are welcome. See [CONTRIBUTING.md](https://github.com/Geson-anko/mujou/blob/main/CONTRIBUTING.md) for the development setup, the dev container, the commands and the rules.
+
+## License
+
+MIT. See [LICENSE](https://github.com/Geson-anko/mujou/blob/main/LICENSE).

mujou-0.1.0/crates/mujou-core/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "mujou-core"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+
+[dependencies]