stable-baselines3/docs
Mark Towers 8f0b488bc5
Update Gymnasium to v1.0.0 (#1837)
* Update Gymnasium to v1.0.0a1

* Comment out `gymnasium.wrappers.monitor` (todo update to VideoRecord)

* Fix ruff warnings

* Register Atari envs

* Update `getattr` to `Env.get_wrapper_attr`

* Reorder imports

* Fix `seed` order

* Fix collecting `max_steps`

* Copy and paste video recorder to prevent the need to rewrite the vec vide recorder wrapper

* Use `typing.List` rather than list

* Fix env attribute forwarding

* Separate out env attribute collection from its utilisation

* Update for Gymnasium alpha 2

* Remove assert for OrderedDict

* Update setup.py

* Add type: ignore

* Test with Gymnasium main

* Remove `gymnasium.logger.debug/info`

* Fix github CI yaml

* Run gym 0.29.1 on python 3.10

* Update lower bounds

* Integrate video recorder

* Remove ordered dict

* Update changelog

---------

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2024-11-04 12:03:12 +01: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 readme and clarify planned features (#2030) 2024-10-29 12:23:13 +01:00
misc Update Gymnasium to v1.0.0 (#1837) 2024-11-04 12:03:12 +01:00
modules Add warning when using PPO on GPU and update doc (#2017) 2024-10-07 11:24:47 +02:00
conda_env.yml Update Gymnasium to v1.0.0 (#1837) 2024-11-04 12:03:12 +01:00
conf.py Update dependencies (remove sphinx type hint plugin), protect type aliases 2023-10-23 20:14:15 +02:00
index.rst Update readme and clarify planned features (#2030) 2024-10-29 12:23:13 +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 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