Metadata-Version: 2.4
Name: toyrl
Version: 0.3.1
Summary: A clean reinforcement learning library
Author-email: Xiangzhuang Shen <datahonor@gmail.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://ai-glimpse.github.io/toyrl
Project-URL: Bug Tracker, https://github.com/ai-glimpse/toyrl/issues
Project-URL: Documentation, https://ai-glimpse.github.io/toyrl
Project-URL: Source Code, https://github.com/ai-glimpse/toyrl
Project-URL: Release Notes, https://github.com/ai-glimpse/toyrl/releases
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: gymnasium[classic-control]>=1.1.1
Requires-Dist: numpy>=2.2.5
Requires-Dist: torch>=2.7.0
Requires-Dist: wandb>=0.19.10
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: ipython; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-sugar; extra == "dev"
Requires-Dist: hypothesis>=6.112.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocs-material-extensions; extra == "docs"
Requires-Dist: mkdocstrings; extra == "docs"
Requires-Dist: mkdocs-bibtex; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Requires-Dist: mkdocs-autorefs; extra == "docs"
Requires-Dist: mkdocs-git-committers-plugin-2; extra == "docs"
Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == "docs"
Dynamic: license-file

# ToyRL

[![Python](https://img.shields.io/pypi/pyversions/toyrl.svg?color=%2334D058)](https://pypi.org/project/toyrl/)
[![PyPI](https://img.shields.io/pypi/v/toyrl?color=%2334D058&label=pypi%20package)](https://pypi.org/project/toyrl/)
[![PyPI Downloads](https://static.pepy.tech/badge/toyrl)](https://pepy.tech/projects/toyrl)
[![GitHub License](https://img.shields.io/github/license/ai-glimpse/toyrl)](https://github.com/ai-glimpse/toyrl/blob/master/LICENSE)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ai-glimpse/toyrl)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Build Docs](https://github.com/ai-glimpse/toyrl/actions/workflows/build_docs.yaml/badge.svg)](https://github.com/ai-glimpse/toyrl/actions/workflows/build_docs.yaml)
[![Test](https://github.com/ai-glimpse/toyrl/actions/workflows/test.yaml/badge.svg)](https://github.com/ai-glimpse/toyrl/actions/workflows/test.yaml)
[![Codecov](https://codecov.io/gh/ai-glimpse/toyrl/branch/master/graph/badge.svg)](https://codecov.io/gh/ai-glimpse/toyrl)

## Documentation

[https://ai-glimpse.github.io/toyrl](https://ai-glimpse.github.io/toyrl)

## Installation

```bash
pip install toyrl
```

## Algorithms

- [x] REINFORCE
- [x] SARSA
- [x] DQN & Double DQN
- [x] A2C
- [x] PPO


## References
- [kengz/SLM-Lab](https://github.com/kengz/SLM-Lab): Our implementations are inspired by the book "Foundations of Deep Reinforcement Learning" and the implementation of SLM-Lab.
- [vwxyzjn/cleanrl](https://github.com/vwxyzjn/cleanrl): The main reference for the implementation of the PPO implementation.
