mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-07-04 04:07:27 +00:00
* Update documentation Added comment to PPO documentation that CPU should primarily be used unless using CNN as well as sample code. Added warning to user for both PPO and A2C that CPU should be used if the user is running GPU without using a CNN, reference Issue #1245. * Add warning to base class and add test --------- Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org> |
||
|---|---|---|
| .. | ||
| _static | ||
| common | ||
| guide | ||
| misc | ||
| modules | ||
| conda_env.yml | ||
| conf.py | ||
| index.rst | ||
| make.bat | ||
| Makefile | ||
| README.md | ||
| spelling_wordlist.txt | ||
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