Docs examples warning - issue #526 (#530)

* Update a2c.rst

* Update ddpg.rst

* Update dqn.rst

* Update her.rst

* Update ppo.rst

* Update sac.rst

* Update td3.rst

* Update changelog.rst

* modified message

* Update examples.rst

Co-authored-by: Anssi <kaneran21@hotmail.com>
This commit is contained in:
MihaiAnca13 2021-08-09 14:23:25 +01:00 committed by GitHub
parent 3845bf9f32
commit c41368f2ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 21 additions and 1 deletions

View file

@ -3,6 +3,11 @@
Examples Examples
======== ========
.. note::
These examples are only to demonstrate the use of the library and its functions, and the trained agents may not solve the environments. Optimized hyperparameters can be found in the RL Zoo `repository <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
Try it online with Colab Notebooks! Try it online with Colab Notebooks!
----------------------------------- -----------------------------------

View file

@ -30,6 +30,7 @@ Documentation:
- Updated multiprocessing example - Updated multiprocessing example
- Added example of ``VecEnvWrapper`` - Added example of ``VecEnvWrapper``
- Added a note about logging to tensorboard more often - Added a note about logging to tensorboard more often
- Added warning about simplicity of examples and link to RL zoo (@MihaiAnca13)
Release 1.1.0 (2021-07-01) Release 1.1.0 (2021-07-01)
@ -736,4 +737,4 @@ And all the contributors:
@diditforlulz273 @liorcohen5 @ManifoldFR @mloo3 @SwamyDev @wmmc88 @megan-klaiber @thisray @diditforlulz273 @liorcohen5 @ManifoldFR @mloo3 @SwamyDev @wmmc88 @megan-klaiber @thisray
@tfederico @hn2 @LucasAlegre @AptX395 @zampanteymedio @JadenTravnik @decodyng @ardabbour @lorenz-h @mschweizer @lorepieri8 @vwxyzjn @tfederico @hn2 @LucasAlegre @AptX395 @zampanteymedio @JadenTravnik @decodyng @ardabbour @lorenz-h @mschweizer @lorepieri8 @vwxyzjn
@ShangqunYu @PierreExeter @JacopoPan @ltbd78 @tom-doerr @Atlis @liusida @09tangriro @amy12xx @juancroldan @benblack769 @bstee615 @ShangqunYu @PierreExeter @JacopoPan @ltbd78 @tom-doerr @Atlis @liusida @09tangriro @amy12xx @juancroldan @benblack769 @bstee615
@c-rizz @skandermoalla @c-rizz @skandermoalla @MihaiAnca13

View file

@ -47,6 +47,8 @@ Dict ❌ ✔️
Example Example
------- -------
This example is only to demonstrate the use of the library and its functions, and the trained agents may not solve the environments. Optimized hyperparameters can be found in RL Zoo `repository <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
Train a A2C agent on ``CartPole-v1`` using 4 environments. Train a A2C agent on ``CartPole-v1`` using 4 environments.
.. code-block:: python .. code-block:: python

View file

@ -57,6 +57,8 @@ Dict ❌ ✔️
Example Example
------- -------
This example is only to demonstrate the use of the library and its functions, and the trained agents may not solve the environments. Optimized hyperparameters can be found in RL Zoo `repository <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
.. code-block:: python .. code-block:: python
import gym import gym

View file

@ -52,6 +52,8 @@ Dict ❌ ✔️️
Example Example
------- -------
This example is only to demonstrate the use of the library and its functions, and the trained agents may not solve the environments. Optimized hyperparameters can be found in RL Zoo `repository <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
.. code-block:: python .. code-block:: python
import gym import gym

View file

@ -58,6 +58,8 @@ Please refer to the used model (DQN, QR-DQN, SAC, TQC, TD3, or DDPG) for that se
Example Example
------- -------
This example is only to demonstrate the use of the library and its functions, and the trained agents may not solve the environments. Optimized hyperparameters can be found in RL Zoo `repository <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
.. code-block:: python .. code-block:: python
from stable_baselines3 import HerReplayBuffer, DDPG, DQN, SAC, TD3 from stable_baselines3 import HerReplayBuffer, DDPG, DQN, SAC, TD3

View file

@ -48,6 +48,8 @@ Dict ❌ ✔️
Example Example
------- -------
This example is only to demonstrate the use of the library and its functions, and the trained agents may not solve the environments. Optimized hyperparameters can be found in RL Zoo `repository <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
Train a PPO agent on ``Pendulum-v0`` using 4 environments. Train a PPO agent on ``Pendulum-v0`` using 4 environments.
.. code-block:: python .. code-block:: python

View file

@ -64,6 +64,8 @@ Dict ❌ ✔️
Example Example
------- -------
This example is only to demonstrate the use of the library and its functions, and the trained agents may not solve the environments. Optimized hyperparameters can be found in RL Zoo `repository <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
.. code-block:: python .. code-block:: python
import gym import gym

View file

@ -57,6 +57,8 @@ Dict ❌ ✔️
Example Example
------- -------
This example is only to demonstrate the use of the library and its functions, and the trained agents may not solve the environments. Optimized hyperparameters can be found in RL Zoo `repository <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
.. code-block:: python .. code-block:: python
import gym import gym