stable-baselines3/docs
Sidney Tio d6ddee9366
Add evalcallback example (#1468)
* Moved 'Monitoring Training' to subsubsection of 'Using callbacks'

* Added EvalCallback example

* Updated Changelogs

* Edited the language

* Moved subsection headers up one level

* added make_vec_env into Evalcallback example

* Added parameters to the top for readability

* Added note on multiple training environments

* Added more clarity to eval_freq note

* Apply suggestions from code review

---------

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2023-05-02 18:02:36 +02:00
..
_static Adds info on split tensorboard graphs (#989) 2022-07-30 12:44:25 +02:00
common Add stats window argument (#1424) 2023-04-05 11:33:26 +02:00
guide Add evalcallback example (#1468) 2023-05-02 18:02:36 +02:00
misc Add evalcallback example (#1468) 2023-05-02 18:02:36 +02:00
modules Add Gymnasium support (#1327) 2023-04-14 13:13:59 +02:00
conda_env.yml Add Gymnasium support (#1327) 2023-04-14 13:13:59 +02:00
conf.py Mypy type checking (#1143) 2022-11-16 13:22:57 +01:00
index.rst Add documentation about default network architecture (#1353) 2023-03-02 14:14:57 +01:00
make.bat Add doc 2019-09-26 11:46:40 +02:00
Makefile Dictionary Observations (#243) 2021-05-11 12:29:30 +02:00
README.md Add package to install (#378) 2021-04-10 14:04:37 +02:00
spelling_wordlist.txt Add custom objects support + bug fix (#336) 2021-03-06 15:17:43 +02:00

Stable Baselines3 Documentation

This folder contains documentation for the RL baselines.

Build the Documentation

Install Sphinx and Theme

Execute this command in the project root:

pip install -e .[docs]

Building the Docs

In the docs/ folder:

make html

if you want to building each time a file is changed:

sphinx-autobuild . _build/html