stable-baselines3/docs
Ole Petersen 6c00565778
Fix memory leak in base_class.py (#1908)
* Fix memory leak in base_class.py

Loading the data return value is not necessary since it is unused. Loading the data causes a memory leak through the ep_info_buffer variable. I found this while loading a PPO learner from storage on a multi-GPU system since the ep_info_buffer is loaded to the memory location it was on while it was saved to disk, instead of the target loading location, and is then not cleaned up.

* Update changelog.rst

* Update changelog

---------

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2024-05-15 15:59:32 +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 Fix various typos (#1926) 2024-05-15 15:19:39 +02:00
misc Fix memory leak in base_class.py (#1908) 2024-05-15 15:59:32 +02:00
modules Fixed broken link in ppo.rst (#1884) 2024-04-08 15:48:26 +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
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

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