haliax 1.4.dev367__tar.gz → 1.4.dev368__tar.gz

haliax-1.4.dev368/.playbooks/add-types.md

@@ -0,0 +1,45 @@
+# Adding NamedArray Type Annotations
+
+This playbook explains how to migrate existing code to use the new type
+annotation helpers described in `docs/typing.md`.
+
+1. **Read the documentation**: Familiarise yourself with `docs/typing.md`.
+   It describes the `Named[...]` syntax and the dtype aware helpers in
+   `haliax.typing`.
+2. **Annotate parameters**: Replace plain `NamedArray` annotations with
+   `Named[...]` that lists the required axes.  Use ellipses or sets when the
+   exact order is flexible.
+
+   ```python
+   from haliax import Named
+
+   # old
+   def foo(x: NamedArray) -> NamedArray:
+       ...
+
+   # new
+   def foo(x: Named["batch", "embed"]) -> Named["batch", "embed"]:
+       ...
+   ```
+3. **Annotate dtypes when needed**: If the dtype matters, import symbolic dtypes
+   from `haliax.typing` (e.g. `ht.f32`, `ht.i32`).  They can be indexed just
+   like `Named`.
+
+   ```python
+   import haliax.typing as ht
+
+   def bar(x: ht.f32["batch"]):
+       ...
+   ```
+4. **Runtime validation**: Use `arr.matches_axes(...)` to check that a
+   `NamedArray` conforms to the expected axes and dtype at runtime.
+
+   ```python
+   if not arr.matches_axes(Named["batch embed ..."]):
+       raise ValueError("unexpected axes")
+   ```
+5. **Update return types**: Functions returning `NamedArray` should annotate
+   their return values using the same conventions.
+
+Following these steps will gradually port legacy code to the new
+annotation style.

{haliax-1.4.dev367 → haliax-1.4.dev368}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: haliax
-Version: 1.4.dev367
+Version: 1.4.dev368
 Summary: Named Tensors for Legible Deep Learning in JAX
 Project-URL: Homepage, https://github.com/stanford-crfm/haliax
 Project-URL: Bug Tracker, https://github.com/stanford-crfm/haliax/issues/

haliax-1.4.dev368/src/haliax/__about__.py

@@ -0,0 +1 @@
+__version__ = "1.4.dev368"

haliax-1.4.dev367/src/haliax/__about__.py

@@ -1 +0,0 @@
-__version__ = "1.4.dev367"