Skip to content

oxmera

license crates.io MSRV GPU ci stress

A Rust-native tensor and deep-learning framework: multi-threaded CPU and Apple-Silicon Metal backends, tape-based reverse-mode autograd, neural-network layers and optimizers, safetensors weights, and an interactive terminal training dashboard — every terminal surface tested through a real PTY with deterministic golden frames.

use oxmera::nn::{CrossEntropyLoss, Linear, Module, Sequential};
use oxmera::optim::{Adam, Optimizer};
use oxmera::{Device, Tensor};

let model = Sequential::new()
    .push(Linear::new(2, 32, 1))
    .push(Linear::new(32, 2, 2));
let mut opt = Adam::new(model.parameters(), 1e-2);

let x = Tensor::randn([64, 2]).to_device(Device::Metal { index: 0 })?;
let logits = model.forward(&x)?;
// … loss.backward()?; opt.step()?;

What's inside

area what you get
tensors f32 (and CPU f64) strided views (reshape/permute/narrow/broadcast_to are zero-copy), NumPy broadcasting, batched matmul, operator overloading (&a + &b, a * 2.0)
devices CPU (rayon-parallel, cache-tiled GEMM), Apple Metal (MSL compute kernels, threadgroup reductions, tiled GEMM over unified memory) and NVIDIA CUDA (the same kernels in CUDA C, shipped as PTX and driven through the driver API — no CUDA toolkit needed to build, libcuda found at runtime); tensor.to_device(...) moves data, autograd flows across the move
autograd tape-based reverse mode: requires_grad, backward(), gradient accumulation, no_grad RAII guard — every VJP validated by finite differences in CI
nn Linear, Conv2d, Embedding, LayerNorm, BatchNorm2d, Dropout, Sequential; MSELoss, CrossEntropyLoss, BCEWithLogitsLoss; Kaiming/Xavier initializers
optim SGD (momentum, weight decay), Adam, AdamW, RMSprop — all with per-group learning rate and weight decay (ParamGroup); one fused launch per parameter on Metal and CUDA
linalg eye/diag/diag_embed/trace, batched cholesky (differentiable), logdet/det, eigh; rank-4+ matmul broadcasting and a two-operand einsum
weights zero-config safetensors save/load by parameter name
terminal oxmera doctor (hardware, devices, capabilities) and oxmera train --tui (live loss/accuracy sparklines, progress gauges, throughput, unified-memory usage) — both golden-tested through a real PTY with a 100-iteration determinism stress

Quick start

cargo add oxmera                     # library
cargo install oxmera-cli             # the `oxmera` binary
oxmera doctor                        # what can this machine do?
oxmera train --tui --device metal    # watch a model train, live (Apple Silicon)
oxmera train --tui --device cuda     # … or on an NVIDIA GPU

CUDA needs only the NVIDIA driver at runtime (libcuda); if the driver is older than the toolkit that produced the shipped PTX, the kernels are rebuilt for your GPU through NVRTC when libnvrtc is present.

Run the example (MNIST if ./data/mnist holds the IDX files, a synthetic dataset otherwise):

cargo run --release -p oxmera --example train_mnist -- --device metal

Correctness, not vibes

  • The CPU backend is the reference; the Metal and CUDA backends are asserted equal to it within 1e-5 across every op family, in tests that run on real hardware (Apple Silicon; an NVIDIA A10G, where the CUDA suite also runs clean under Compute Sanitizer's memcheck, racecheck and synccheck).
  • Every backward pass is checked against central finite differences.
  • Terminal output is captured from a real PTY (via termlens) and compared to golden frames; a 100-iteration stress proves frame-for-frame determinism. No clocks, no absolute paths, no flaky snapshots.
  • cargo clippy -D warnings, doc-warnings-as-errors, cargo deny (licenses, bans, advisories), and a measured MSRV (1.88), all in CI.

What this deliberately is not (yet)

  • Two CUDA paths, deliberately. oxmera-cuda is the shipped backend: CUDA C kernels through the driver API, no compiler research involved. research/oxmera-cuda-oxide is the separate research line — kernels written in Rust with cuda-oxide, statically verified by reconverge and launchbound on plain CI runners. The research toolchain never becomes a dependency of the stable workspace; deny.toml enforces that firewall.
  • CUDA is correctness-first for now. One stream, no cuBLAS, f32 only; timings are not claimed until they are measured.
  • f32-first. f64 tensors live on the CPU (every op, autograd, to_dtype); the GPU backends are f32. Integer tensors exist for indices and targets.
  • No performance claims without measurements. See docs/LIMITATIONS.md for what is and is not promised — including why tiny-batch Metal runs are slower than CPU.

History

oxmera began as a public learning workbench whose computational parts were deliberately reserved for the maintainer to implement by hand (ADR-0006 records the pivot to full production development on 2026-08-22). The exercise specs from that era live on as this repository's integration tests.

License

Dual-licensed under MIT or Apache-2.0, at your option. See CONTRIBUTING.md: DCO + signed commits, Conventional Commits, zero AI attribution in history, and a dependency firewall around the cuda-oxide research toolchain.

About

A Rust-native ML/GPU framework built from first principles as a learning project.

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages