mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-11-17 08:56:08 +00:00
Bump min PyTorch version (#855)
This commit is contained in:
parent
16703b1314
commit
248f082cdc
7 changed files with 12 additions and 10 deletions
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
|
|
@ -28,7 +28,7 @@ jobs:
|
||||||
run: |
|
run: |
|
||||||
python -m pip install --upgrade pip
|
python -m pip install --upgrade pip
|
||||||
# cpu version of pytorch
|
# cpu version of pytorch
|
||||||
pip install torch==1.8.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
|
pip install torch==1.11+cpu -f https://download.pytorch.org/whl/torch_stable.html
|
||||||
pip install .[extra,tests,docs]
|
pip install .[extra,tests,docs]
|
||||||
# Use headless version
|
# Use headless version
|
||||||
pip install opencv-python-headless
|
pip install opencv-python-headless
|
||||||
|
|
|
||||||
|
|
@ -84,7 +84,7 @@ Documentation is available online: [https://sb3-contrib.readthedocs.io/](https:/
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
**Note:** Stable-Baselines3 supports PyTorch >= 1.8.1.
|
**Note:** Stable-Baselines3 supports PyTorch >= 1.11
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
Stable Baselines3 requires Python 3.7+.
|
Stable Baselines3 requires Python 3.7+.
|
||||||
|
|
|
||||||
|
|
@ -61,7 +61,7 @@ Then you can define and train a RL agent with:
|
||||||
model = A2C('CnnPolicy', env).learn(total_timesteps=1000)
|
model = A2C('CnnPolicy', env).learn(total_timesteps=1000)
|
||||||
|
|
||||||
|
|
||||||
To check that your environment follows the gym interface, please use:
|
To check that your environment follows the Gym interface that SB3 supports, please use:
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
|
|
@ -71,11 +71,11 @@ To check that your environment follows the gym interface, please use:
|
||||||
# It will check your custom environment and output additional warnings if needed
|
# It will check your custom environment and output additional warnings if needed
|
||||||
check_env(env)
|
check_env(env)
|
||||||
|
|
||||||
|
Gym also have its own `env checker <https://www.gymlibrary.ml/content/api/#checking-api-conformity>`_ but it checks a superset of what SB3 supports (SB3 does not support all Gym features).
|
||||||
|
|
||||||
We have created a `colab notebook <https://colab.research.google.com/github/araffin/rl-tutorial-jnrr19/blob/master/5_custom_gym_env.ipynb>`_ for a concrete example on creating a custom environment along with an example of using it with Stable-Baselines3 interface.
|
We have created a `colab notebook <https://colab.research.google.com/github/araffin/rl-tutorial-jnrr19/blob/master/5_custom_gym_env.ipynb>`_ for a concrete example on creating a custom environment along with an example of using it with Stable-Baselines3 interface.
|
||||||
|
|
||||||
Alternatively, you may look at OpenAI Gym `built-in environments <https://gym.openai.com/docs/#available-environments>`_. However, the readers are cautioned as per OpenAI Gym `official wiki <https://github.com/openai/gym/wiki/FAQ>`_, its advised not to customize their built-in environments. It is better to copy and create new ones if you need to modify them.
|
Alternatively, you may look at OpenAI Gym `built-in environments <https://www.gymlibrary.ml/>`_. However, the readers are cautioned as per OpenAI Gym `official wiki <https://github.com/openai/gym/wiki/FAQ>`_, its advised not to customize their built-in environments. It is better to copy and create new ones if you need to modify them.
|
||||||
|
|
||||||
Optionally, you can also register the environment with gym, that will allow you to create the RL agent in one line (and use ``gym.make()`` to instantiate the env):
|
Optionally, you can also register the environment with gym, that will allow you to create the RL agent in one line (and use ``gym.make()`` to instantiate the env):
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,7 @@ Installation
|
||||||
Prerequisites
|
Prerequisites
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
Stable-Baselines3 requires python 3.7+ and PyTorch >= 1.8.1.
|
Stable-Baselines3 requires python 3.7+ and PyTorch >= 1.11
|
||||||
|
|
||||||
Windows 10
|
Windows 10
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
|
|
|
||||||
|
|
@ -4,13 +4,14 @@ Changelog
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
|
||||||
Release 1.5.1a2(WIP)
|
Release 1.5.1a3 (WIP)
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
Breaking Changes:
|
Breaking Changes:
|
||||||
^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^
|
||||||
- Changed the way policy "aliases" are handled ("MlpPolicy", "CnnPolicy", ...), removing the former
|
- Changed the way policy "aliases" are handled ("MlpPolicy", "CnnPolicy", ...), removing the former
|
||||||
``register_policy`` helper, ``policy_base`` parameter and using ``policy_aliases`` static attributes instead (@Gregwar)
|
``register_policy`` helper, ``policy_base`` parameter and using ``policy_aliases`` static attributes instead (@Gregwar)
|
||||||
|
- SB3 now requires PyTorch >= 1.11
|
||||||
|
|
||||||
New Features:
|
New Features:
|
||||||
^^^^^^^^^^^^^
|
^^^^^^^^^^^^^
|
||||||
|
|
@ -31,6 +32,7 @@ Others:
|
||||||
|
|
||||||
Documentation:
|
Documentation:
|
||||||
^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^
|
||||||
|
- Added link to gym doc and gym env checker
|
||||||
|
|
||||||
|
|
||||||
Release 1.5.0 (2022-03-25)
|
Release 1.5.0 (2022-03-25)
|
||||||
|
|
|
||||||
2
setup.py
2
setup.py
|
|
@ -75,7 +75,7 @@ setup(
|
||||||
install_requires=[
|
install_requires=[
|
||||||
"gym==0.21", # Fixed version due to breaking changes in 0.22
|
"gym==0.21", # Fixed version due to breaking changes in 0.22
|
||||||
"numpy",
|
"numpy",
|
||||||
"torch>=1.8.1",
|
"torch>=1.11",
|
||||||
# For saving models
|
# For saving models
|
||||||
"cloudpickle",
|
"cloudpickle",
|
||||||
# For reading logs
|
# For reading logs
|
||||||
|
|
|
||||||
|
|
@ -1 +1 @@
|
||||||
1.5.1a2
|
1.5.1a3
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue