From 07e23937c536b0a0d6defe9b636043b300236683 Mon Sep 17 00:00:00 2001 From: Antonin RAFFIN Date: Mon, 20 Aug 2018 15:21:13 +0200 Subject: [PATCH] First Stable version --- README.md | 21 +++++++++++++++++++++ setup.py | 8 ++++---- 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 55c0198ec6..b629e0eba7 100644 --- a/README.md +++ b/README.md @@ -426,6 +426,13 @@ More thorough tutorial on virtualenvs and options can be found [here](https://vi ## Installation Install the Stable Baselines package + +Using pip from pypi: +``` +pip install stable-baselines +``` + +From source: ```bash pip install git+https://github.com/hill-a/stable-baselines ``` @@ -453,6 +460,20 @@ pytest --cov-config .coveragerc --cov-report html --cov-report term --cov=. - [TRPO](stable_baselines/trpo_mpi) +To cite this repository in publications: + +``` + @misc{stable-baselines, + author = {Hill, Ashley and Raffin, Antonin and Traore, Rene and Dhariwal, Prafulla and Hesse, Christopher and Klimov, Oleg and Nichol, Alex and Plappert, Matthias and Radford, Alec and Schulman, John and Sidor, Szymon and Wu, Yuhuai}, + title = {Stable Baselines}, + year = {2018}, + publisher = {GitHub}, + journal = {GitHub repository}, + howpublished = {\url{https://github.com/hill-a/stable-baselines}}, + } +``` + + ## Bonus Make a gif of a trained agent (you need to install imageio): diff --git a/setup.py b/setup.py index 3bae8f3040..91b1876bb0 100644 --- a/setup.py +++ b/setup.py @@ -29,8 +29,8 @@ 'seaborn', 'glob2' ], - description='A fork of OpenAI Baselines, implementations of reinforcement learning algorithms ', - author='OpenAI', + description='A fork of OpenAI Baselines, implementations of reinforcement learning algorithms.', + author='Ashley Hill', url='https://github.com/openai/stable_baselines', - author_email='gym@openai.com', - version='0.2.0') + author_email='ashley.hill@u-psud.fr', + version='1.0.0')