Skip to main content

PFRL

Documentation Status PyPI

PFRL is a deep reinforcement learning library that implements various state-of-the-art deep reinforcement algorithms in Python using PyTorch.

Boxing Humanoid Grasping Atlas SlimeVolley

Installation

PFRL is tested with Python 3.7.7. For other requirements, see requirements.txt.

PFRL can be installed via PyPI:

pip install pfrl

It can also be installed from the source code:

python setup.py install

Refer to Installation for more information on installation.

Getting started

You can try PFRL Quickstart Guide first, or check the examples ready for Atari 2600 and Open AI Gym.

For more information, you can refer to PFRL's documentation.

Blog Posts

Algorithms

Algorithm Discrete Action Continous Action Recurrent Model Batch Training CPU Async Training Pretrained models*
DQN (including DoubleDQN etc.) ✓ ✓ (NAF) ✓ ✓ x ✓
Categorical DQN ✓ x ✓ ✓ x x
Rainbow ✓ x ✓ ✓ x ✓
IQN ✓ x ✓ ✓ x ✓
DDPG x ✓ x ✓ x ✓
A3C ✓ ✓ ✓ ✓ (A2C) ✓ ✓
ACER ✓ ✓ ✓ x ✓ x
PPO ✓ ✓ ✓ ✓ x ✓
TRPO ✓ ✓ ✓ ✓ x ✓
TD3 x ✓ x ✓ x ✓
SAC x ✓ x ✓ x ✓

*Note on Pretrained models: PFRL provides pretrained models (sometimes called a 'model zoo') for our reproducibility scripts on Atari environments (DQN, IQN, Rainbow, and A3C) and Mujoco environments (DDPG, TRPO, PPO, TD3, SAC), for each benchmarked environment.

Following algorithms have been implemented in PFRL:

Following useful techniques have been also implemented in PFRL:

Environments

Environments that support the subset of OpenAI Gym's interface (reset and step methods) can be used.

Contributing

Any kind of contribution to PFRL would be highly appreciated! If you are interested in contributing to PFRL, please read CONTRIBUTING.md.

License

MIT License.

Citations

To cite PFRL in publications, please cite our paper on ChainerRL, the library on which PFRL is based:

@article{JMLR:v22:20-376,
  author  = {Yasuhiro Fujita and Prabhat Nagarajan and Toshiki Kataoka and Takahiro Ishikawa},
  title   = {ChainerRL: A Deep Reinforcement Learning Library},
  journal = {Journal of Machine Learning Research},
  year    = {2021},
  volume  = {22},
  number  = {77},
  pages   = {1-14},
  url     = {http://jmlr.org/papers/v22/20-376.html}
}

Metadata

Release files for pfrl 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pfrl 0.4.0
File Size Uploaded Provenance Actions
pfrl-0.4.0.tar.gz 112.6 kB Without provenance Details for pfrl-0.4.0.tar.gz

Release files / pfrl-0.4.0.tar.gz

Download URL pfrl-0.4.0.tar.gz
Size 112.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d0619a7db847c1eea02e01fdc80b8dcfbabd25f03bfe6e815f9f6bcb3f236fcd
BLAKE2b-256 checksum
How to use checksums
5b9a402600084ade77264e0df6916891fbfd86b30ce04c63aef3608f6989fcff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Security for pfrl 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page