Skip to main content

High-performance composable JAX library

Project description

xtrax

PyPI - Version Tests Docs Coverage License: Apache 2.0

A set of composable building blocks for JAX/Equinox training loops — engine + trainer orchestration, safety-checked steps, axis tiling strategies, inference-time sparsification, distributed/sharding helpers, streaming output callbacks, and orbax checkpointing — extracted from the author's research code.

Status

xtrax is alpha, experimental software built primarily for the author's personal research use. APIs may change without notice between releases; no backward-compatibility guarantees pre-1.0. Issues and pull requests are welcome, but support is best-effort — the project exists first to serve the author's own JAX training workflows.

Why xtrax?

jax.jit specializes and freezes: it traces your function into a program where every shape is a compile-time constant, and XLA plans all memory for that program up front. The compiler makes the program you gave it fast, but it never restructures it — it cannot narrow a vmap that doesn't fit in memory, cannot batch ragged inputs without a recompile per shape, and cannot notice that most of a batch is duplicates. Those decisions happen in Python, before tracing — and the code that makes them is exactly what gets copy-pasted between research projects.

xtrax packages that pre-trace layer, plus the conveniences that surround it:

  • Axis tiling — declare axes with AxisSpec; BatchPlanner selects Vmap, SafeMap (chunked via jax.lax.map), Scan, bucketing, or dedup-gather per axis, and xtrax explain reports why
  • Composable training stepsTrainer or SafetyTrainStep with your own loss functions and optimizers
  • Safety-checked arithmetic — opt-in checkify NaN/Inf detection and safe ops (safe_norm, safe_reciprocal)
  • Inference sparsification — structured sparsity masks with SparseConfig and sparsify_model, fixed compile shapes
  • Distributed helpersinit_dist, LogicalMesh, and sharding utilities over JAX's native machinery

For the full rationale — why this layer has to live above the JIT boundary — see Why xtrax exists.

Installation

pip install xtrax

Requires Python 3.13 or later.

Quick Start

import jax.numpy as jnp
import optax
from xtrax import Trainer, ResumableState, Engine, save_checkpoint, load_checkpoint

# 1. Create a simple loss function
def loss_fn(model, batch):
    predictions = model(batch["inputs"])
    return jnp.mean((predictions - batch["targets"]) ** 2)

# 2. Set up trainer with optimizer
optimizer = optax.adam(1e-3)
trainer = Trainer(loss_fn=loss_fn, optimizer=optimizer)

# 3. Initialize training state
model = ...  # Your equinox model
opt_state = optimizer.init(...)
state = ResumableState(model=model, opt_state=opt_state, step=0)

# 4. Run a training step
new_state, metrics = trainer.step(state, batch={"inputs": x, "targets": y})
print(f"Loss: {metrics['loss']}")

For a complete training loop with callbacks and checkpointing, use the Engine:

from xtrax import Engine, DataModule

# Create or load a DataModule (must implement train_iter())
data = DataModule(...)

# Create an engine with trainer and optional callbacks
engine = Engine(trainer=trainer)

# Run multi-epoch training with checkpoint saving
final_state = engine.fit_sync(
    state=state,
    data=data,
    num_epochs=10,
    checkpoint_dir="./checkpoints"
)

Getting Results Out

Streaming Callbacks

Log metrics asynchronously to files or external services:

from xtrax.io import BoundedCallbackHandler, async_indexed_stream

# Create a custom async callback
class LogCallback:
    async def on_step_end(self, state, metrics):
        print(f"Step {state.step}: {metrics}")

# Use in your Engine
engine = Engine(
    trainer=trainer,
    callbacks=[LogCallback()]
)

Checkpoint Save and Load

Save model state and restore for inference or resumption:

from xtrax import save_checkpoint, load_checkpoint

# After training
save_checkpoint(checkpoint_dir="./checkpoints/final", state=final_state)

# Load for inference
restored_state = load_checkpoint(checkpoint_dir="./checkpoints/final")
model = restored_state.model

# Run inference
predictions = model(test_inputs)

Documentation

Full API docs, architecture guides, and advanced examples at xtrax.readthedocs.io.

Project links

License

Licensed under the Apache License 2.0.

Citation

If you use xtrax in research, please cite it:

@software{xtrax,
  title = {xtrax: High-Performance Composable JAX Training},
  author = {Russo, Marielle},
  version = {0.4.0a1},
  year = {2026},
  url = {https://github.com/maraxen/xtrax}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xtrax-0.4.0a1.tar.gz (986.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xtrax-0.4.0a1-py3-none-any.whl (119.7 kB view details)

Uploaded Python 3

File details

Details for the file xtrax-0.4.0a1.tar.gz.

File metadata

  • Download URL: xtrax-0.4.0a1.tar.gz
  • Upload date:
  • Size: 986.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for xtrax-0.4.0a1.tar.gz
Algorithm Hash digest
SHA256 48d4102159564587df0f9db5cceadf9ff576eed006756bae576060a12e7ad4f7
MD5 38536a7245ff3891d62e432e5d54ee87
BLAKE2b-256 9cc24cd5f8da94990920d0b97ced6ff3c1de42a420586cd1f704e08eaab3e3c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for xtrax-0.4.0a1.tar.gz:

Publisher: publish.yml on maraxen/xtrax

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xtrax-0.4.0a1-py3-none-any.whl.

File metadata

  • Download URL: xtrax-0.4.0a1-py3-none-any.whl
  • Upload date:
  • Size: 119.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for xtrax-0.4.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 fdbc2260c7d5aefd86b3013b9d131fad8170a6b9e2dbf205a04d001a41ee8f5a
MD5 1749575b063415afa53e1430ae221f03
BLAKE2b-256 a63fbd3ab9b1f3573f18aa4f90d51038c9225a4e6dc6c6617424cfd3c5a54160

See more details on using hashes here.

Provenance

The following attestation bundles were made for xtrax-0.4.0a1-py3-none-any.whl:

Publisher: publish.yml on maraxen/xtrax

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page