mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-05-17 21:20:11 +00:00
d8a430e088
* Adds deprecation warning if `eval_env` or `eval_freq` parameters are used. See #925 * added changelog entry * added missing backtick * deprecating `create_eval_env` parameter as well and adding comments to explain the `stacklevel` parameter used * Updated tests to ignore DeprecationWarnings * Updated changelog entry * - Removed the `create_eval_env` parameter from the examples in the docs - Removed information about the `create_eval_env` parameter from the migration docs - Added information about deprecation of the `create_eval_env` parameter in the docs * Add alternative in docstring * Update docstrings * `eval_freq` warning in docstring * Add deprecation comments in tests Co-authored-by: Quentin Gallouédec <45557362+qgallouedec@users.noreply.github.com> Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org> Co-authored-by: Quentin GALLOUÉDEC <gallouedec.quentin@gmail.com> |
||
|---|---|---|
| .. | ||
| _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