Registry / ai-ml / orbax-export

orbax-export

JSON →
library0.0.8pypypi✓ verified 22d ago

Orbax Export is a Python library designed for JAX users, providing utilities to serialize and export JAX models into the TensorFlow SavedModel format. It is a specialized component within the broader Orbax ecosystem, which offers common training utilities for JAX. The library is actively maintained, with its latest version being 0.0.8, released in September 2025, and maintains a regular release cadence to support JAX users.

pip install orbax-export
INSTALL
IMPORT
SIG · ORBAX-EXPORT
O
orbax-export
ai-mlpythonv0.0.8
Install
19.0s avg
Import
13310ms
Disk
352MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v0.0.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.910 runs
installs and imports cleanly · install 0.0s · import 0.000s · 17.8MB
glibc
py 3.103.910 runs
installs and imports cleanly · install 19.0s · import 2.662s · 661MB
352MB installed
● package 352MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

ExportManager
from orbax.export import ExportManager
from orbax.export import ExportManager

This quickstart demonstrates how to define a simple JAX model, wrap it with `JaxModule`, configure serving signatures with `ServingConfig`, and then export it to the TensorFlow SavedModel format using `ExportManager.save()`. It includes optional TensorFlow pre- and post-processing functions that will be integrated into the SavedModel graph. Ensure `tensorflow` is installed to run this example.

import os import jax import jax.numpy as jnp import tensorflow as tf # Required for SavedModel export from orbax.export import ExportManager, JaxModule, ServingConfig # Dummy JAX model and parameters for demonstration class SimpleJAXModel: def apply(self, params, inputs): return params['w'] * inputs + params['b'] model_instance = SimpleJAXModel() final_model_params_to_save = {'w': jnp.array(2.0), 'b': jnp.array(1.0)} # JAX Apply Function: The core JAX logic for the model's forward pass. @jax.jit def jax_model_apply_fn_for_export(params, inputs): return model_instance.apply(params, inputs) # Optional: TF Pre-processing Function def tf_preprocess_fn_for_export(input_tensor: tf.Tensor) -> tf.Tensor: return tf.cast(input_tensor, tf.float32) / 255.0 # Optional: TF Post-processing Function def tf_postprocess_fn_for_export(output_tensor: tf.Tensor) -> dict[str, tf.Tensor]: return {'output': output_tensor} # Create a JaxModule jax_module = JaxModule( apply_fn=jax_model_apply_fn_for_export, params=final_model_params_to_save, preprocess_fn=tf_preprocess_fn_for_export, postprocess_fn=tf_postprocess_fn_for_export ) # Define serving signatures serving_signatures = { 'serving_default': ServingConfig( input_signature=[ tf.TensorSpec(shape=[None, 1], dtype=tf.int32, name='input') ], output_signature={ 'output': tf.TensorSpec(shape=[None, 1], dtype=tf.float32, name='output') } ) } # Define export path export_path = os.environ.get('ORBAX_EXPORT_PATH', '/tmp/my_jax_model_export') # Export the model export_manager = ExportManager( jax_module, serving_signatures=serving_signatures ) export_manager.save(export_path) print(f"JAX model exported to TensorFlow SavedModel at: {export_path}") # Basic verification (optional) loaded_model = tf.saved_model.load(export_path) input_data = tf.constant([[5]], dtype=tf.int32) output = loaded_model.signatures['serving_default'](input_data) print(f"Loaded model output for input {input_data.numpy()}: {output['output'].numpy()}")
Debug
Known issues
gotchaOrbax Export requires TensorFlow for its core functionality (exporting to SavedModel), but TensorFlow is *not* installed by default. Users must explicitly install it using `pip install tensorflow` or by installing `orbax-export` with the `[all]` extra: `pip install orbax-export[all]`.
fix
Install TensorFlow manually: `pip install tensorflow` or use the `[all]` extra: `pip install orbax-export[all]`.
affects: All versions
breakingThe original `orbax` PyPI package (frozen at 0.1.6/0.1.9) is no longer the primary installation target. Users should directly install specific sub-packages like `orbax-export` or `orbax-checkpoint` to avoid dependency bloat. While existing `from orbax import export` statements may still work due to namespace preservation, installing the specific sub-package is the recommended approach.
fix
Ensure you install `orbax-export` directly via `pip install orbax-export` instead of relying on the legacy `orbax` package.
affects: Users migrating from `orbax<0.1.9` to `orbax-export`
gotchaThere can be version incompatibilities between `orbax-export` and `orbax-checkpoint` (e.g., `orbax-export 0.0.5` was incompatible with `orbax-checkpoint 0.9.0`). When using both, always ensure they are compatible by checking release notes or testing your setup.
fix
Consult the Orbax GitHub repository or documentation for recommended compatible versions of `orbax-export` and `orbax-checkpoint`. Update both packages to their latest compatible releases.
affects: All versions when used with `orbax-checkpoint`
deprecatedMany internal Orbax implementations were refactored into a private `_src` directory. While most public APIs should remain unaffected, some lightly-used public APIs might have become private. This might lead to `ImportError` or `AttributeError` for users relying on such paths.
fix
If encountering issues, refer to the official Orbax documentation and API reference for the correct, currently public API paths. Contact the Orbax team if a needed API has become private.
affects: Versions released after 2024-10-01
Upgrade
Version history
0.0.8latest on PyPI · released Sep 17, 2025
Audit
Dependencies
tensorflowoptionalEssential for its primary functionality: exporting JAX models to the TensorFlow SavedModel format. Not installed by default.
jaxrequiredCore library for defining JAX models that are to be exported.
orbax-checkpointoptionalOften used in conjunction for checkpointing JAX models before export; compatibility between versions is crucial.
Agent activity
13 hits · last 30 days
node
10
Resources
orbax-export — pip install orbax-export · libregistry