stable-baselines3/docs
Devin White 56c153f048
Add warning when using PPO on GPU and update doc (#2017)
* 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>
2024-10-07 11:24:47 +02:00
..
_static Adds info on split tensorboard graphs (#989) 2022-07-30 12:44:25 +02:00
common Documentation update (#1732) 2023-11-03 17:17:46 +01:00
guide Update examples.rst (#1969) 2024-07-15 23:57:24 +02:00
misc Add warning when using PPO on GPU and update doc (#2017) 2024-10-07 11:24:47 +02:00
modules Add warning when using PPO on GPU and update doc (#2017) 2024-10-07 11:24:47 +02:00
conda_env.yml Remove sphinx-autodoc-typehints 2023-10-23 20:26:33 +02:00
conf.py Update dependencies (remove sphinx type hint plugin), protect type aliases 2023-10-23 20:14:15 +02:00
index.rst Doc fix and add Stable-Baselines3 Jax (SBX) page (#1566) 2023-06-21 18:54:16 +02: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 Docs: Add mobile-env to community projects (#1617) 2023-07-21 16:33:01 +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