API Reference
Generated reference documentation for this version of Hurray. Both references are built from this version's own source tree, so they describe exactly the code the rest of this book describes.
Note (non-normative): The links below are relative to the documentation site and resolve only there — they are generated output, not files in the repository. Reading this page on GitHub, follow it on the documentation site instead.
Rust
cargo doc output for every crate in the workspace.
| Crate | What it covers |
|---|---|
hurray_core | Element types, shape, buffer handles, quantization and layout descriptors, TensorDescriptor encoding. No I/O. |
hurray_io | Async streaming interchange and the HRRYFILE container. |
hurray_ffi | The C ABI: opaque handles, function table, release callbacks. |
hurray | The Rust side of the Python bindings — the PyO3 classes behind the hurray module. |
hurray_inspect | The descriptor hex-viewer CLI. |
Python
The hurray module — every class, function, and constant the bindings
expose, with signatures and examples.
| Page | What it covers |
|---|---|
hurray | Tensor, Composite, Descriptor, layout and quantization classes, creation and interop functions, file and stream I/O, exceptions. |
hurray.dtype | The element-type constants and Dtype. |
hurray.device | The device constants and Device. |
For task-shaped introductions rather than an exhaustive surface, start from the cookbook's Python entries — Dtype, Device, and Tensor is the first one.