Metadata-Version: 2.1
Name: jax-jumpy
Version: 0.2.0
Summary: Common backend for JAX or numpy.
Project-URL: Homepage, https://farama.org/
Project-URL: Repository, https://github.com/Farama-Foundation/Jumpy
Author-email: Farama Foundation <jkterry@farama.org>
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.7
Requires-Dist: numpy>=1.18.0
Provides-Extra: jax
Requires-Dist: jax>=0.3.24; extra == 'jax'
Requires-Dist: jaxlib>=0.3.24; extra == 'jax'
Provides-Extra: testing
Requires-Dist: pytest==7.1.3; extra == 'testing'
Description-Content-Type: text/markdown

<p align="center">
    <img src="https://raw.githubusercontent.com/jjshoots/Jumpy/main/jumpy-text.png" width="500px"/>
</p>

Jumpy is a common backend for [JAX](https://github.com/google/jax) or
[NumPy](https://numpy.org/):

* A Jumpy function returns a JAX outputs if given a JAX inputs
* A Jumpy function returns a JAX outputs if jitted
* Otherwise a jumpy function returns NumPy outputs

Jumpy lets you write framework agnostic code that is easy to debug by running
as raw Numpy, but is just as performant as JAX when jitted.

We maintain this repository primarily so to enable writing Gymnasium and PettingZoo wrappers that can be applied to both standard NumPy or hardware accelerated Jax based environments, however this package can be used for many more things.

## Installing Jumpy

To install Jumpy from pypi:

```
python3 -m venv env
source env/bin/activate
pip install --upgrade pip
pip install brax-jumpy
```

Alternatively, to install Jumpy from source, clone this repo, `cd` to it, and then:

```
python3 -m venv env
source env/bin/activate
pip install --upgrade pip
pip install -e .
```
