Metadata-Version: 2.1
Name: coax
Version: 0.1.9
Summary: Plug-n-play reinforcement learning with OpenAI Gym and JAX
Home-page: https://coax.readthedocs.io
Author: Kristian Holsheimer
Author-email: kristian.holsheimer@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: GPU :: NVIDIA CUDA
Classifier: Framework :: Flake8
Classifier: Framework :: IPython
Classifier: Framework :: Jupyter
Classifier: Framework :: Pytest
Classifier: Framework :: Sphinx
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: ~=3.6
Requires-Dist: Pillow (>=7.1.2)
Requires-Dist: gym[accept-rom-license,atari] (>=0.21.0)
Requires-Dist: numpy (>=1.19.5)
Requires-Dist: scipy (>=1.4.1)
Requires-Dist: pandas (>=1.1.5)
Requires-Dist: dm-haiku (>=0.0.2)
Requires-Dist: chex (>=0.0.3)
Requires-Dist: optax (>=0.0.1)
Requires-Dist: tensorboard (>=2.7.0)
Requires-Dist: tensorboardX (>=2.1)
Requires-Dist: lz4 (>=3.1.1)
Requires-Dist: cloudpickle (>=1.3.0)
Provides-Extra: dev
Requires-Dist: jax (>=0.2.25) ; extra == 'dev'
Requires-Dist: jaxlib (>=0.1.71) ; extra == 'dev'
Requires-Dist: flake8 (>=3.8.4) ; extra == 'dev'
Requires-Dist: pylint (>=2.6.0) ; extra == 'dev'
Requires-Dist: pur (>=5.3.0) ; extra == 'dev'
Requires-Dist: pytest (>=6.1.2) ; extra == 'dev'
Requires-Dist: pytest-cov (>=2.10.1) ; extra == 'dev'
Requires-Dist: pytest-xdist (>=2.1.0) ; extra == 'dev'
Requires-Dist: twine (>=3.2.0) ; extra == 'dev'
Requires-Dist: gym[box2d] (>=0.21.0) ; extra == 'dev'
Requires-Dist: jupyter (>=1.0.0) ; extra == 'dev'
Requires-Dist: sphinx-autobuild (>=2020.9.1) ; extra == 'dev'
Provides-Extra: doc
Requires-Dist: jax (>=0.2.25) ; extra == 'doc'
Requires-Dist: jaxlib (>=0.1.71) ; extra == 'doc'
Requires-Dist: Sphinx (>=3.3.1) ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme (>=0.5.0) ; extra == 'doc'
Requires-Dist: nbsphinx (>=0.8.0) ; extra == 'doc'
Requires-Dist: sphinx-tabs (>=1.3.0) ; extra == 'doc'
Requires-Dist: sphinx-copybutton (>=0.3.1) ; extra == 'doc'
Requires-Dist: sphinx-notfound-page (>=0.5) ; extra == 'doc'
Provides-Extra: ray
Requires-Dist: ray (>1.9.0) ; extra == 'ray'

|tests| |pypi| |docs| |License|


coax
====

Plug-n-Play Reinforcement Learning in Python with `OpenAI Gym <https://gym.openai.com>`_ and
`JAX <https://jax.readthedocs.io>`_

|readthedocs|

For the full documentation, including many examples, go to https://coax.readthedocs.io/


Install
-------

**coax** is built on top of JAX, but it doesn't have an explicit dependence on the ``jax`` python
package. The reason is that your version of ``jaxlib`` will depend on your CUDA version. To install
without CUDA, simply run:

.. code-block::

    $ pip install jaxlib jax coax --upgrade


If you do require CUDA support, please check out the
`Installation Guide <https://coax.readthedocs.io/examples/getting_started/install.html>`_.


Getting Started
---------------

Have a look at the
`Getting Started <https://coax.readthedocs.io/examples/getting_started/prereq_jax.html>`_ page to
train your first RL agent.


....................................................................................................

.. |readthedocs| image:: https://raw.githubusercontent.com/coax-dev/coax/main/doc/_static/img/readthedocs.gif
    :target: https://coax.readthedocs.io/
    :width: 400
    :alt: readthedocs

.. |tests| image:: https://github.com/coax-dev/coax/workflows/tests/badge.svg
    :target: https://github.com/coax-dev/coax/actions?query=workflow%3Atests
    :alt: tests badge

.. |pypi| image:: https://img.shields.io/pypi/v/coax
    :target: https://pypi.org/project/coax
    :alt: pypi badge

.. |docs| image:: https://readthedocs.org/projects/coax/badge/?version=latest
    :target: https://coax.readthedocs.io
    :alt: docs badge

.. |license| image:: https://img.shields.io/github/license/coax-dev/coax
    :target: https://github.com/coax-dev/coax/blob/main/LICENSE
    :alt: license badge


