stable-baselines3/docs
Jan-Hendrik Ewers 4a1137ba3a
Add np.ndarray as a recognized type for TB histograms. (#1635)
* Add np.ndarray as a recognized type for TB histograms.

Torch histograms allow th.Tensor, np.ndarray, and caffe2 formatted strings. This commits expands the TensorBoardOutputFormat's capabilities to log the two former types.

* Update changelog to reflect bug fix

* fix: try/catch for if either np or torch aren't at the required versions. See https://github.com/DLR-RM/stable-baselines3/pull/1635 for more details

* fix: Add comment describing the test for when add_histogram should not have been called

* Cleanup

---------

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2024-08-02 11:55:27 +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 np.ndarray as a recognized type for TB histograms. (#1635) 2024-08-02 11:55:27 +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 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