mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-09-16 22:20:26 +00:00
Update changelog and README
This commit is contained in:
parent
44fce7c02a
commit
9345b85cfc
2 changed files with 33 additions and 1 deletions
30
README.md
30
README.md
|
|
@ -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.
|
||||
|
||||
NOTE: Python 3.6 is required!
|
||||
|
||||
## Implemented Algorithms
|
||||
|
||||
- A2C
|
||||
|
|
@ -22,6 +24,34 @@ PyTorch version of [Stable Baselines](https://github.com/hill-a/stable-baselines
|
|||
- 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
|
||||
|
||||
To cite this repository in publications:
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ Pre-Release 0.2.0a0 (WIP)
|
|||
|
||||
Breaking Changes:
|
||||
^^^^^^^^^^^^^^^^^
|
||||
- Python 2 support was dropped, Torchy Baselines now requires Python 3.6 or above
|
||||
|
||||
New Features:
|
||||
^^^^^^^^^^^^^
|
||||
|
|
@ -18,9 +19,10 @@ Bug Fixes:
|
|||
Deprecations:
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
|
||||
Others:
|
||||
^^^^^^^
|
||||
- Add type check
|
||||
- Converted all format string to f-strings
|
||||
|
||||
Documentation:
|
||||
^^^^^^^^^^^^^^
|
||||
|
|
|
|||
Loading…
Reference in a new issue