Skip to content

Commit d0d55f3

Browse files
authored
Beta is over =)! V1.0rc0 (#334)
* Fix doc + bump version * Removed cmd util * Remove test
1 parent b2c94a6 commit d0d55f3

File tree

6 files changed

+16
-18
lines changed

6 files changed

+16
-18
lines changed

README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,12 @@
33
[![pipeline status](https://gitlab.com/araffin/stable-baselines3/badges/master/pipeline.svg)](https://gitlab.com/araffin/stable-baselines3/-/commits/master) [![Documentation Status](https://readthedocs.org/projects/stable-baselines/badge/?version=master)](https://stable-baselines3.readthedocs.io/en/master/?badge=master) [![coverage report](https://gitlab.com/araffin/stable-baselines3/badges/master/coverage.svg)](https://gitlab.com/araffin/stable-baselines3/-/commits/master)
44
[![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
55

6-
**WARNING: Stable Baselines3 is currently in a beta version, breaking changes may occur before 1.0 is released**
7-
86

97
# Stable Baselines3
108

119
Stable Baselines3 (SB3) is a set of reliable implementations of reinforcement learning algorithms in PyTorch. It is the next major version of [Stable Baselines](https://github.com/hill-a/stable-baselines).
1210

13-
You can read a detailed presentation of Stable Baselines in the [Medium article](https://medium.com/@araffin/stable-baselines-a-fork-of-openai-baselines-reinforcement-learning-made-easy-df87c4b2fc82).
11+
You can read a detailed presentation of Stable Baselines3 in the [v1.0 blog post](https://araffin.github.io/post/sb3/).
1412

1513

1614
These algorithms will make it easier for the research community and industry to replicate, refine, and identify new ideas, and will create good baselines to build projects on top of. We expect these tools will be used as a base around which new ideas can be added, and as a tool for comparing a new approach against existing ones. We also hope that the simplicity of these tools will allow beginners to experiment with a more advanced toolset, without being buried in implementation details.

docs/guide/examples.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ will compute a running average and standard deviation of input features (it can
312312

313313
.. code-block:: python
314314
315+
import os
315316
import gym
316317
import pybullet_envs
317318
@@ -521,7 +522,7 @@ Behind the scene, SB3 uses an :ref:`EvalCallback <callbacks>`.
521522
# Note: if you don't save the complete model with `model.save()`
522523
# you cannot continue training afterward
523524
policy = model.policy
524-
policy.save("sac_policy_pendulum.pkl")
525+
policy.save("sac_policy_pendulum")
525526
526527
# Retrieve the environment
527528
env = model.get_env()

docs/misc/changelog.rst

+12
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
Changelog
44
==========
55

6+
Release 1.0rc0 (2021-02-28)
7+
-------------------------------
8+
9+
Breaking Changes:
10+
^^^^^^^^^^^^^^^^^
11+
- Removed ``stable_baselines3.common.cmd_util`` (already deprecated), please use ``env_util`` instead
12+
13+
Documentation:
14+
^^^^^^^^^^^^^^
15+
- Fixed examples
16+
17+
618
Pre-Release 0.11.1 (2021-02-27)
719
-------------------------------
820

stable_baselines3/common/cmd_util.py

-7
This file was deleted.

stable_baselines3/version.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.11.1
1+
1.0rc0

tests/test_utils.py

-6
Original file line numberDiff line numberDiff line change
@@ -321,12 +321,6 @@ def test_zip_strict():
321321
pass
322322

323323

324-
def test_cmd_util_rename():
325-
"""Test that importing cmd_util still works but raises warning"""
326-
with pytest.warns(FutureWarning):
327-
from stable_baselines3.common.cmd_util import make_vec_env # noqa: F401
328-
329-
330324
def test_is_wrapped():
331325
"""Test that is_wrapped correctly detects wraps"""
332326
env = gym.make("Pendulum-v0")

0 commit comments

Comments
 (0)