Skip to main content

💌 Envelope: a JAX-native environment interface

xkcd: Standards
# Create environments from JAX-native suites you have installed, ...
env = envelope.create("gymnax::CartPole-v1")
<p># ... interact with the environments using a simple interface, ...
state, info = env.init(key)
states, infos = jax.lax.scan(env.step, state, actions)
plt.plot(infos.reward.cumsum())</p>
<p># ... and enjoy a powerful ecosystem of wrappers.
env = envelope.wrappers.AutoResetWrapper(env)
env = envelope.wrappers.VmapWrapper(env)
env = envelope.wrappers.ObservationNormalizationWrapper(env)

What I have to say in defense of yet another Jax RL library

Envelope is an environment interface.

  • You will be able to set up the same experiments and get the same results with Gymnax or Jumanji.
  • If you use coding agents, you easily set up any wrappers, logging, or compatibility you need.
  • If what you care about is results, Envelope has little value to you.

But I made it because I care, and I want to get things right. Squeezing gym into Jax is hard. Envelope is my best attempt.

  • Envelope gets things right that other libraries get wrong: spaces, wrappers, and adapters.
  • It was designed purely by me, not coding agents. Not because I don't like them, but because they wouldn't get it right (as of July 2026).
  • Agents have a better time using Envelope over other interfaces, in my subjective experience.
  • It supports many popular suites, so you can interact with many environments in the same way.
  • It's only requirement is Jax.

It's really good.

The rest of the readme was also written by me, despite the vibe-coding-coded vibes.

🌍 Simple, expressive interaction!

  • Environments are pytrees. Squish them through JAX transformations and trace their parameters.
  • Idiomatic jax-y interface of init(key: Key) -> State, Info and step(state: State, action: PyTree) -> State, Info. You can directly jax.scan over a step(...)!
  • Spaces are super simple. No Tuple, Dict nonsense! There are two spaces: Continuous and Discrete, which you can compose into a PyTreeSpace.
  • Explicit episode truncation supports correctly handling bootstrapping for value-function targets.
  • No auto-reset by default. Resetting every step can be expensive! Obviously Envelope has a wrapper for this.

💪 Powerful, composable wrappers!

  • Carry state across episodes to track running statistics, for example to normalize observations.
  • Explicit wrapper composition keeps episode boundaries correct. See the wrapper compatibility guide for enforced constraints and ordering examples.

🔌 Adapters for existing suites

📦 # 🤖 # 🌍
brax 🕺 12
craftax 🕺 4
gymnax 🕺 24
jumanji 🕺 / 👯 25 / 1
kinetix 🕺 4
mujoco_playground 🕺 54
navix 🕺 41
Total 🕺 / 👯 164 / 1
envelope.create("📦::🌍")

lets you create environments from any of the above!

📝 Testing

  • Default (no optional adapters deps required): uv run pytest -m "not adapters"
  • Adapters suite (requires full adapters dependency group):
    • uv sync --group adapters
    • uv run pytest -m adapters
    • Tests for suites unavailable in a partial installation are skipped.

🏗️ Installation

pip install jax-envelope
pip install "jax-envelope[navix]"       # one published adapter
pip install "jax-envelope[adapters]"    # all published adapters

Gymnax and Kinetix are temporarily source-backed development adapters rather than published extras.

  • stoa is a very similar project that provides adapters and wrappers for the jumanji-like interface.
  • Check out all the great suites we have adapters for! gymnax, brax, jumanji, kinetix, craftax, navix, mujoco_playground.
  • We will be adding support for jaxmarl and pgx in the future, as soon as we figured out the best ever MARL interface for JAX!

Metadata

Release files for jax-envelope 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jax-envelope 0.6.1
File Size Uploaded Provenance Actions
jax_envelope-0.6.1.tar.gz 111.4 kB With provenance Details for jax_envelope-0.6.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jax-envelope 0.6.1
File Interpreter ABI Platform Actions
jax_envelope-0.6.1-py3-none-any.whl Python 3 none any Details for jax_envelope-0.6.1-py3-none-any.whl

Total release size: 161.9 kB

Release files / jax_envelope-0.6.1.tar.gz

Download URL jax_envelope-0.6.1.tar.gz
Size 111.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3ad298bb2b5eaa0295a0c2a65f04b2516708eb4ab3bf151192a695a7bd0d0612
BLAKE2b-256 checksum
How to use checksums
37aa9c7187cfb02c2c7456f6d06027a2c43a121a83d3ac2cce3a759bfeb267cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 21, 2026.

Transparency log

Release files / jax_envelope-0.6.1-py3-none-any.whl

Download URL jax_envelope-0.6.1-py3-none-any.whl
Size 50.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8143a97ee4ec3492adc61fc0c748354fc803f37ad46c91b31a688e702ab2c3a1
BLAKE2b-256 checksum
How to use checksums
f24a388422b051d1ce7b8a5b061f3134a3c72dffa6fe2f8d5fed68dfa6dbd8e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 21, 2026.

Transparency log

Security for jax-envelope 0.6.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for jax_envelope-0.6.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 21, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page