From 9345b85cfc5c46b7b0033398c3374082f92797b3 Mon Sep 17 00:00:00 2001 From: Antonin Raffin Date: Wed, 22 Jan 2020 17:23:42 +0100 Subject: [PATCH] Update changelog and README --- README.md | 30 ++++++++++++++++++++++++++++++ docs/misc/changelog.rst | 4 +++- 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 018eb35..7ae8981 100644 --- a/README.md +++ b/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: diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index 39e30db..b774e02 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -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: ^^^^^^^^^^^^^^