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?

  • Composable training steps — Use Trainer or SafetyTrainStep with your own loss functions and optimizers
  • Safety-checked arithmetic — Avoid NaN/Inf propagation with safe operations (safe_norm, safe_reciprocal)
  • Flexible tiling strategies — Partition computations with AxisSpec, BatchPlan, and Vmap/SafeMap for data and model parallelism
  • Inference sparsification — Apply structured sparsity masks with SparseConfig and sparsify_model
  • Distributed helpers — Initialize and coordinate multi-GPU/TPU training with init_dist, LogicalMesh, and sharding utilities

Installation

pip install xtrax

Requires Python 3.13 or later.

Quick Start

import jax
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.3.0},
  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.3.0.tar.gz (864.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.3.0-py3-none-any.whl (112.6 kB view details)

Uploaded Python 3

File details

Details for the file xtrax-0.3.0.tar.gz.

File metadata

  • Download URL: xtrax-0.3.0.tar.gz
  • Upload date:
  • Size: 864.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.3.0.tar.gz
Algorithm Hash digest
SHA256 d3d374331b05a5cfc41dd2173b01dd9a4cf9419296d346011b928526bab6dec1
MD5 fd6e18b9a64455f27736c6afa7e43d45
BLAKE2b-256 b27cc5530858dc77cb007c679cebaf8f4cd8b94a30ffb54e79ff50839c09048c

See more details on using hashes here.

Provenance

The following attestation bundles were made for xtrax-0.3.0.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.3.0-py3-none-any.whl.

File metadata

  • Download URL: xtrax-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 112.6 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9d22c2fe985c9253528573e344291f5acff2af4382ab56794a49385cf229a5c0
MD5 e1f3660ebce86e3be643e6b9fb46269b
BLAKE2b-256 17a08c77f5a31f573081bf843e5ad09aec829a0bede2669d3eee4a401fe587f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for xtrax-0.3.0-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