saymrwulf/stable-baselines3
1
0
Fork 0
mirror of https://github.com/saymrwulf/stable-baselines3.git synced 2026-05-18 21:30:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update doc before 2.0 release

Browse source
This commit is contained in:
Antonin Raffin 2023-06-23 12:31:14 +02:00
parent 1036c05680
commit cc103ff725
No known key found for this signature in database
GPG key ID: B8B48F65CAD6232C
3 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -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

2
docs/guide/examples.rst
View file

@ -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

14
docs/guide/install.rst
View file

@ -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 <https://stackoverflow.com/a/30539963>`_.
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
-------------------