mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-06-05 00:00:04 +00:00
bb01253261
* init commit tensorboard-integration * Added tb logger to ppo (with output exclusions) * fixed truncated stdout * categorize stdout outputs by tag * separated exclusions from values, added missing logs * saving exclusions as dict instead of list * reformatting, auto run indexing * included renaming suggestions, fixed tests * tb support for sac * linting * moved logging to base class * tb support for td3 * removed histograms, non-verbose output working * modifed changelog * linting * fixed type error * moved logger config to utils * removed episode_rewards log from ppo * Enable tensorboard in tests * Remove unused import * Update logger sub titles * Minor edit for PPO * Update logger and tb log folder * Pass correct logger to Callbacks * updated docs * added tb example image to docs * add support for continuing training in tensorboard * added tensorboard to docs index * added tb test * moved logger config to _setup_learn, updated tests * accessing verbose from base class * Update doc and tests * Rename session -> time * Update version * Update logger truncate * Update types * Remove duplicated code Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
104 lines
2.4 KiB
ReStructuredText
104 lines
2.4 KiB
ReStructuredText
.. 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 docs! - RL Baselines Made Easy
|
|
===========================================================
|
|
|
|
`Stable Baselines3 <https://github.com/DLR-RM/stable-baselines3>`_ is a set of improved implementations of reinforcement learning algorithms in PyTorch.
|
|
It is the next major version of `Stable Baselines <https://github.com/hill-a/stable-baselines>`_.
|
|
|
|
|
|
Github 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.
|
|
|
|
|
|
Main Features
|
|
--------------
|
|
|
|
- Unified structure for all algorithms
|
|
- PEP8 compliant (unified code style)
|
|
- Documented functions and classes
|
|
- Tests, high code coverage and type hints
|
|
- Clean code
|
|
- Tensorboard support
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: User Guide
|
|
|
|
guide/install
|
|
guide/quickstart
|
|
guide/rl_tips
|
|
guide/rl
|
|
guide/algos
|
|
guide/examples
|
|
guide/vec_envs
|
|
guide/custom_env
|
|
guide/custom_policy
|
|
guide/callbacks
|
|
guide/tensorboard
|
|
guide/rl_zoo
|
|
guide/migration
|
|
guide/checking_nan
|
|
guide/developer
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: RL Algorithms
|
|
|
|
modules/base
|
|
modules/a2c
|
|
modules/ppo
|
|
modules/sac
|
|
modules/td3
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Common
|
|
|
|
common/atari_wrappers
|
|
common/cmd_util
|
|
common/distributions
|
|
common/evaluation
|
|
common/env_checker
|
|
common/monitor
|
|
common/logger
|
|
common/noise
|
|
common/utils
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Misc
|
|
|
|
misc/changelog
|
|
misc/projects
|
|
|
|
|
|
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}},
|
|
}
|
|
|
|
Indices and tables
|
|
-------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|
|
* :ref:`modindex`
|