.. Stable Baselines3 documentation master file, created by
   sphinx-quickstart on Thu Sep 26 11:06:54 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Stable Baselines3 Contrib docs!
==========================================

Contrib package for `Stable Baselines3 (SB3) <https://github.com/DLR-RM/stable-baselines3>`_ - Experimental code.


Github repository: https://github.com/Stable-Baselines-Team/stable-baselines3-contrib

SB3 repository: https://github.com/DLR-RM/stable-baselines3

RL Baselines3 Zoo (collection of pre-trained agents): https://github.com/DLR-RM/rl-baselines3-zoo

RL Baselines3 Zoo also offers a simple interface to train, evaluate agents and do hyperparameter tuning.


.. toctree::
   :maxdepth: 2
   :caption: User Guide

   guide/install
   guide/algos
   guide/examples


.. toctree::
  :maxdepth: 1
  :caption: RL Algorithms

  modules/ars
  modules/ppo_mask
  modules/qrdqn
  modules/tqc
  modules/trpo

.. toctree::
  :maxdepth: 1
  :caption: Common

  common/utils
  common/wrappers

.. toctree::
  :maxdepth: 1
  :caption: Misc

  misc/changelog


Citing Stable Baselines3
------------------------
To cite this project in publications:

.. code-block:: bibtex

    @misc{stable-baselines3,
      author = {Raffin, Antonin and Hill, Ashley and Ernestus, Maximilian and Gleave, Adam and Kanervisto, Anssi and Dormann, Noah},
      title = {Stable Baselines3},
      year = {2019},
      publisher = {GitHub},
      journal = {GitHub repository},
      howpublished = {\url{https://github.com/DLR-RM/stable-baselines3}},
    }

Contributing
------------

If you want to contribute, please read `CONTRIBUTING.md <https://github.com/Stable-Baselines-Team/stable-baselines3-contrib/blob/master/CONTRIBUTING.md>`_ first.

Indices and tables
-------------------

* :ref:`genindex`
* :ref:`search`
* :ref:`modindex`
