Skip to main content

Extensible offline reinforcement learning framework built with JAX, Flax, and Optax

Project description

ORLax - Offline Reinforcement Learning with JAX

ORLax is an extensible, research-friendly offline reinforcement learning framework built with JAX, Flax, and Optax. It provides clean, typed APIs optimized for editor autocompletion, modular algorithm implementations, and production-ready features like WandB logging and GPU acceleration.

Features

  • 🔥 Modern JAX Stack: Built on JAX, Flax, and Optax for high-performance GPU/TPU training
  • 📦 Modular Design: Clean separation of concerns with pluggable algorithms, models, and datasets
  • 🎯 Type-Safe: Comprehensive type hints with dataclasses instead of dict-heavy patterns
  • 📊 Built-in Logging: WandB integration with terminal progress bars (tqdm)
  • 🚀 Production-Ready: Checkpointing, multi-device training, and reproducible experiments
  • 🧪 Research-Friendly: Clear interfaces, and easy extensibility

Algorithms

  • BC (Behavioral Cloning) - Supervised learning from expert demonstrations
  • CQL (Conservative Q-Learning) - Conservative offline RL with Q-value penalties
  • IQL (Implicit Q-Learning) - Expectile regression-based offline RL

Installation

Using uv (Recommended)

# Clone the repository
git clone https://github.com/yourusername/orlax.git
cd orlax

# Install with uv
uv sync

Using pip

# Clone the repository
git clone https://github.com/yourusername/orlax.git
cd orlax

# Install in editable mode
pip install -e .

GPU Support

For CUDA support, install JAX with CUDA:

# For CUDA 12
pip install --upgrade "jax[cuda12]"

Quick Start

Training

# Train IQL on Hopper-Medium
uv run orlax-train --config configs/iql_hopper.toml

Citation

If you use ORLax in your research, please cite:

@software{orlax2025,
  title = {ORLax: Offline Reinforcement Learning with JAX},
  author = {sql-hkr},
  year = {2025},
  url = {https://github.com/sql-hkr/orlax}
}

Acknowledgments

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feat/amazing-feature)
  3. Commit your changes (git commit -m 'feat: add amazing feature')
  4. Push to the branch (git push origin feat/amazing-feature)
  5. Open a Pull Request

Contact


Note: This software is under active development. API stability is not guaranteed until version 1.0.0.

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

orlax-0.1.0.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

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

orlax-0.1.0-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

Details for the file orlax-0.1.0.tar.gz.

File metadata

  • Download URL: orlax-0.1.0.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for orlax-0.1.0.tar.gz
Algorithm Hash digest
SHA256 eb6eda6a87a44120a84f788321617c6ab9ce25c7feac4dc892d4d9c91f726269
MD5 e71e3c0e265682ab8f513cb16b220cd7
BLAKE2b-256 7d886ddd5cf5feb42ebbfd5ff5dfdfd529b3f2032e9105b9a17b32dea058ef95

See more details on using hashes here.

Provenance

The following attestation bundles were made for orlax-0.1.0.tar.gz:

Publisher: pypi-publish.yml on sql-hkr/orlax

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

File details

Details for the file orlax-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: orlax-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 30.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for orlax-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 48c3561e82b45c1634efe3db6bbe78580655c9287335eeb6411e0151a949ccbb
MD5 04d6bf3a3c22476333ae663fbdfde121
BLAKE2b-256 7c6396dbf101c128239541b4e53856f5c9fd2301be4a628084bad97107199ce9

See more details on using hashes here.

Provenance

The following attestation bundles were made for orlax-0.1.0-py3-none-any.whl:

Publisher: pypi-publish.yml on sql-hkr/orlax

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