diff --git a/docs/guide/examples.rst b/docs/guide/examples.rst index b02b8c3..7e870f6 100644 --- a/docs/guide/examples.rst +++ b/docs/guide/examples.rst @@ -3,6 +3,11 @@ 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 `_. + + Try it online with Colab Notebooks! ----------------------------------- diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index 6a42b17..6513f5c 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -30,6 +30,7 @@ Documentation: - Updated multiprocessing example - Added example of ``VecEnvWrapper`` - 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) @@ -736,4 +737,4 @@ And all the contributors: @diditforlulz273 @liorcohen5 @ManifoldFR @mloo3 @SwamyDev @wmmc88 @megan-klaiber @thisray @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 -@c-rizz @skandermoalla +@c-rizz @skandermoalla @MihaiAnca13 diff --git a/docs/modules/a2c.rst b/docs/modules/a2c.rst index 3eb4d79..3f672ee 100644 --- a/docs/modules/a2c.rst +++ b/docs/modules/a2c.rst @@ -47,6 +47,8 @@ Dict ❌ ✔️ 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 `_. + Train a A2C agent on ``CartPole-v1`` using 4 environments. .. code-block:: python diff --git a/docs/modules/ddpg.rst b/docs/modules/ddpg.rst index 40bef65..dd07c22 100644 --- a/docs/modules/ddpg.rst +++ b/docs/modules/ddpg.rst @@ -57,6 +57,8 @@ Dict ❌ ✔️ 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 `_. + .. code-block:: python import gym diff --git a/docs/modules/dqn.rst b/docs/modules/dqn.rst index 6144fc9..0c497ad 100644 --- a/docs/modules/dqn.rst +++ b/docs/modules/dqn.rst @@ -52,6 +52,8 @@ Dict ❌ ✔️️ 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 `_. + .. code-block:: python import gym diff --git a/docs/modules/her.rst b/docs/modules/her.rst index 047809a..82bf745 100644 --- a/docs/modules/her.rst +++ b/docs/modules/her.rst @@ -58,6 +58,8 @@ Please refer to the used model (DQN, QR-DQN, SAC, TQC, TD3, or DDPG) for that se 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 `_. + .. code-block:: python from stable_baselines3 import HerReplayBuffer, DDPG, DQN, SAC, TD3 diff --git a/docs/modules/ppo.rst b/docs/modules/ppo.rst index abc50af..3b0d720 100644 --- a/docs/modules/ppo.rst +++ b/docs/modules/ppo.rst @@ -48,6 +48,8 @@ Dict ❌ ✔️ 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 `_. + Train a PPO agent on ``Pendulum-v0`` using 4 environments. .. code-block:: python diff --git a/docs/modules/sac.rst b/docs/modules/sac.rst index 818d8c2..2f68047 100644 --- a/docs/modules/sac.rst +++ b/docs/modules/sac.rst @@ -64,6 +64,8 @@ Dict ❌ ✔️ 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 `_. + .. code-block:: python import gym diff --git a/docs/modules/td3.rst b/docs/modules/td3.rst index 13fb235..33cb38f 100644 --- a/docs/modules/td3.rst +++ b/docs/modules/td3.rst @@ -57,6 +57,8 @@ Dict ❌ ✔️ 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 `_. + .. code-block:: python import gym