Metadata-Version: 2.1
Name: moss-rl
Version: 0.0.3
Summary: A Python library for Reinforcement Learning.
Home-page: https://github.com/hilanzy/moss
Author: lanzhiyi
Author-email: lanzhiy.mail@qq.com
License: MIT
Keywords: reinforcement-learning python machine learning
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: absl-py
Requires-Dist: envpool
Requires-Dist: dm-env
Requires-Dist: dm-tree
Requires-Dist: numpy
Requires-Dist: pillow
Requires-Dist: tqdm
Requires-Dist: typing-extensions
Requires-Dist: jax
Requires-Dist: chex
Requires-Dist: dm-haiku
Requires-Dist: flax
Requires-Dist: optax
Requires-Dist: rlax
Requires-Dist: tensorflow (==2.8.0)
Requires-Dist: tensorflow-probability (==0.15.0)
Requires-Dist: tensorflow-datasets (==4.6.0)
Requires-Dist: dm-reverb (==0.11.0)
Requires-Dist: dm-launchpad (==0.5.2)
Provides-Extra: dev
Requires-Dist: sphinx (<4) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: jinja2 (<3.2) ; extra == 'dev'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: flake8-bugbear ; extra == 'dev'
Requires-Dist: yapf ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pydocstyle ; extra == 'dev'
Requires-Dist: doc8 ; extra == 'dev'
Requires-Dist: pyenchant ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'

<div align="center">
  <img src="docs/_static/images/moss.jpg" width="65%">
</div>

# Moss: A Python library for Reinforcement Learning

[![PyPI](https://img.shields.io/pypi/v/moss-rl)](https://pypi.org/project/moss-rl/)
[![GitHub license](https://img.shields.io/github/license/hilanzy/moss)](https://github.com/hilanzy/moss/blob/master/LICENSE)

**Moss** is a Python library for Reinforcement Learning based on [jax](https://github.com/google/jax).

## Installation

To get up and running quickly just follow the steps below:

  **Installing from PyPI**: Moss is currently hosted on [PyPI](https://pypi.org/project/moss-rl/),
  you can simply install Moss from PyPI with the following command:

  ```bash
  pip install moss-rl
  ```

  **Installing from github**: If you are interested in running Moss as a developer,
  you can do so by cloning the Moss GitHub repository and then executing following command
  from the main directory (where `setup.py` is located):

  ```bash
  pip install .["dev"]
  ```

After installation, open your python console and type

  ```python
  import moss
  print(moss.__version__)
  ```

If no error occurs, you have successfully installed Moss.

## Quick Start

This is an example of Impala to train Atari game(use [envpool](https://github.com/sail-sg/envpool)).
  ```bash
  python examples/atari/impala.py --task_id Pong-v5 --learning_rate 1e-3
  ```
