From cc103ff72517795df2fbfb93c81b3b22ebbddd0b Mon Sep 17 00:00:00 2001 From: Antonin Raffin Date: Fri, 23 Jun 2023 12:31:14 +0200 Subject: [PATCH] Update doc before 2.0 release --- README.md | 2 +- docs/guide/examples.rst | 2 +- docs/guide/install.rst | 14 +++++++------- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b34ec92f8..45740fedc 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ Most of the code in the library tries to follow a sklearn-like syntax for the Re Here is a quick example of how to train and run PPO on a cartpole environment: ```python -import gym +import gymnasium as gym from stable_baselines3 import PPO diff --git a/docs/guide/examples.rst b/docs/guide/examples.rst index caefdbe02..e5b9db0fc 100644 --- a/docs/guide/examples.rst +++ b/docs/guide/examples.rst @@ -422,7 +422,7 @@ will compute a running average and standard deviation of input features (it can # Note: pybullet is not compatible yet with Gymnasium # you might need to use `import rl_zoo3.gym_patches` - # and use gym (not Gymnasium) to instanciate the env + # and use gym (not Gymnasium) to instantiate the env # Alternatively, you can use the MuJoCo equivalent "HalfCheetah-v4" vec_env = DummyVecEnv([lambda: gym.make("HalfCheetahBulletEnv-v0")]) # Automatically normalize the input features and reward diff --git a/docs/guide/install.rst b/docs/guide/install.rst index ddca99728..6e2e0e075 100644 --- a/docs/guide/install.rst +++ b/docs/guide/install.rst @@ -3,12 +3,6 @@ Installation ============ -.. warning:: - - Only Stable-Baselines3 2.x supports Gymnasium. As SB3 2.x is currently in beta, - you will need to specify ``pip install "stable_baselines3[extra]>=2.0.0a9"`` explicitly, - or install the master version (see below). - Prerequisites ------------- @@ -40,7 +34,7 @@ To install Stable Baselines3 with pip, execute: Some shells such as Zsh require quotation marks around brackets, i.e. ``pip install 'stable-baselines3[extra]'`` `More information `_. -This includes an optional dependencies like Tensorboard, OpenCV or ``atari-py`` to train on atari games. If you do not need those, you can use: +This includes an optional dependencies like Tensorboard, OpenCV or ``ale-py`` to train on atari games. If you do not need those, you can use: .. code-block:: bash @@ -60,6 +54,12 @@ Bleeding-edge version pip install git+https://github.com/DLR-RM/stable-baselines3 +with extras: + +.. code-block:: bash + + pip install "stable_baselines3[extra,tests,docs] @ git+https://github.com/DLR-RM/stable-baselines3" + Development version -------------------