Accelerated RL
PyTorch framework for RL research.
It was developed with a focus on reproducibility,
fast experimentation and code/ideas reusing.
Being able to research/develop something new,
rather than write another regular train loop.
Break the cycle - use the Catalyst!
Project manifest. Part of PyTorch Ecosystem. Part of Catalyst Ecosystem:
- Alchemy - Experiments logging & visualization
- Catalyst - Accelerated Deep Learning Research and Development
- Reaction - Convenient Deep Learning models serving
Common installation:
pip install -U catalyst-rlCatalyst.RL is compatible with: Python 3.6+. PyTorch 1.0.0+.
For Catalyst.RL introduction, please follow OpenAI Gym example.
- Demo with minimal examples for CV, NLP, RecSys and GANs
- Detailed classification tutorial
- Advanced segmentation tutorial
- Comprehensive classification pipeline
- Binary and semantic segmentation pipeline
API documentation and an overview of the library can be found here
In the examples folder
of the repository, you can find advanced tutorials and Catalyst best practices.
To learn more about Catalyst internals and to be aware of the most important features, you can read Catalyst-info – our blog where we regularly write facts about the framework.
We also supervise Awesome Catalyst list – Catalyst-powered projects, tutorials and talks.
Feel free to make a PR with your project to the list. And don't forget to check out current list, there are many interesting projects.
We deploy a major release once a month with a name like YY.MM.
And micro-releases with framework improvements during a month in the format YY.MM.#.
You can view the changelog on the GitHub Releases page.
Current version:
Catalyst.RL helps you write compact but full-featured RL pipelines in a few lines of code. You get a training loop with metrics, early-stopping, model checkpointing and other features without the boilerplate.
- Universal train/inference loop.
- Configuration files for model/data hyperparameters.
- Reproducibility – all source code and environment variables will be saved.
- Callbacks – reusable train/inference pipeline parts.
- Training stages support.
- Easy customization.
- PyTorch best practices (SWA, AdamW, Ranger optimizer, OneCycle, FP16 and more).
- RL – scalable Reinforcement Learning, all popular model-free algorithms implementations and their improvements with distributed training support.
- contrib - additional modules contributed by Catalyst users.
- utils - different useful utils for Deep Learning research.
We appreciate all contributions. If you are planning to contribute back bug-fixes, please do so without any further discussion. If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the feature with us.
- Please see the contribution guide for more information.
- By participating in this project, you agree to abide by its Code of Conduct.
This project is licensed under the Apache License, Version 2.0 see the LICENSE file for details
Please use this bibtex if you want to cite this repository in your publications:
@misc{catalyst,
author = {Kolesnikov, Sergey},
title = {Accelerated RL.},
year = {2018},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/catalyst-team/catalyst-rl}},
}