saymrwulf/stable-baselines3
1
0
Fork 0
mirror of https://github.com/saymrwulf/stable-baselines3.git synced 2026-09-16 22:20:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update changelog and README

Browse source
This commit is contained in:
Antonin Raffin 2020-01-22 17:23:42 +01:00
parent 44fce7c02a
commit 9345b85cfc
2 changed files with 33 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -6,6 +6,8 @@
PyTorch version of [Stable Baselines](https://github.com/hill-a/stable-baselines), a set of improved implementations of reinforcement learning algorithms. PyTorch version of [Stable Baselines](https://github.com/hill-a/stable-baselines), a set of improved implementations of reinforcement learning algorithms.
NOTE: Python 3.6 is required!
## Implemented Algorithms ## Implemented Algorithms
- A2C - A2C
@ -22,6 +24,34 @@ PyTorch version of [Stable Baselines](https://github.com/hill-a/stable-baselines
- cf github Roadmap - cf github Roadmap
## Run the Tests
```
pip install -e .[tests]
make pytest
```
## Type check
```
pip install -e .[tests]
make type
```
## Build the Documentation
```
pip install -e .[docs]
make docs
```
Spell check for the documentation:
```
make spelling
```
## Citing the Project ## Citing the Project
To cite this repository in publications: To cite this repository in publications:

4
docs/misc/changelog.rst
View file

@ -8,6 +8,7 @@ Pre-Release 0.2.0a0 (WIP)
Breaking Changes: Breaking Changes:
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
- Python 2 support was dropped, Torchy Baselines now requires Python 3.6 or above
New Features: New Features:
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
@ -18,9 +19,10 @@ Bug Fixes:
Deprecations: Deprecations:
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
Others: Others:
^^^^^^^ ^^^^^^^
- Add type check
- Converted all format string to f-strings
Documentation: Documentation:
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^