Update Citation (#684)

* Update citation

* Remove cff file
This commit is contained in:
Antonin RAFFIN 2021-12-01 18:55:21 +01:00 committed by GitHub
parent 52c29dc497
commit 2ebb8aa22b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 33 additions and 49 deletions

10
CITATION.bib Normal file
View file

@ -0,0 +1,10 @@
@article{stable-baselines3,
author = {Antonin Raffin and Ashley Hill and Adam Gleave and Anssi Kanervisto and Maximilian Ernestus and Noah Dormann},
title = {Stable-Baselines3: Reliable Reinforcement Learning Implementations},
journal = {Journal of Machine Learning Research},
year = {2021},
volume = {22},
number = {268},
pages = {1-8},
url = {http://jmlr.org/papers/v22/20-1364.html}
}

View file

@ -1,33 +0,0 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
-
family-names: Raffin
given-names: Antonin
orcid: "https://orcid.org/0000-0001-6036-6950"
-
family-names: Hill
given-names: Ashley
-
family-names: Enerstus
given-names: Maximilian
-
family-names: Gleave
given-names: Adam
orcid: "https://orcid.org/0000-0002-3467-528X"
-
family-names: Kanervisto
given-names: Anssi
orcid: "https://orcid.org/0000-0002-7479-4574"
-
family-names: Dormann
given-names: Noah
title: "Stable Baselines3"
abbreviation: SB3
url: "https://github.com/DLR-RM/stable-baselines3"
repository-code: "https://github.com/DLR-RM/stable-baselines3"
version: 1.1.0
date-released: 2020-05-05
license: MIT
# doi: # TODO when paper is released

View file

@ -8,7 +8,7 @@
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).
You can read a detailed presentation of Stable Baselines3 in the [v1.0 blog post](https://araffin.github.io/post/sb3/).
You can read a detailed presentation of Stable Baselines3 in the [v1.0 blog post](https://araffin.github.io/post/sb3/) or our [JMLR paper](https://jmlr.org/papers/volume22/20-1364/20-1364.pdf).
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.
@ -210,13 +210,15 @@ please tell us when if you want your project to appear on this page ;)
To cite this repository in publications:
```bibtex
@misc{stable-baselines3,
author = {Raffin, Antonin and Hill, Ashley and Ernestus, Maximilian and Gleave, Adam and Kanervisto, Anssi and Dormann, Noah},
title = {Stable Baselines3},
year = {2019},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/DLR-RM/stable-baselines3}},
@article{stable-baselines3,
author = {Antonin Raffin and Ashley Hill and Adam Gleave and Anssi Kanervisto and Maximilian Ernestus and Noah Dormann},
title = {Stable-Baselines3: Reliable Reinforcement Learning Implementations},
journal = {Journal of Machine Learning Research},
year = {2021},
volume = {22},
number = {268},
pages = {1-8},
url = {http://jmlr.org/papers/v22/20-1364.html}
}
```

View file

@ -12,6 +12,8 @@ It is the next major version of `Stable Baselines <https://github.com/hill-a/sta
Github repository: https://github.com/DLR-RM/stable-baselines3
Paper: https://jmlr.org/papers/volume22/20-1364/20-1364.pdf
RL Baselines3 Zoo (training framework for SB3): https://github.com/DLR-RM/rl-baselines3-zoo
RL Baselines3 Zoo provides a collection of pre-trained agents, scripts for training, evaluating agents, tuning hyperparameters, plotting results and recording videos.
@ -98,14 +100,16 @@ To cite this project in publications:
.. code-block:: bibtex
@misc{stable-baselines3,
author = {Raffin, Antonin and Hill, Ashley and Ernestus, Maximilian and Gleave, Adam and Kanervisto, Anssi and Dormann, Noah},
title = {Stable Baselines3},
year = {2019},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/DLR-RM/stable-baselines3}},
}
@article{stable-baselines3,
author = {Antonin Raffin and Ashley Hill and Adam Gleave and Anssi Kanervisto and Maximilian Ernestus and Noah Dormann},
title = {Stable-Baselines3: Reliable Reinforcement Learning Implementations},
journal = {Journal of Machine Learning Research},
year = {2021},
volume = {22},
number = {268},
pages = {1-8},
url = {http://jmlr.org/papers/v22/20-1364.html}
}
Contributing
------------

View file

@ -37,6 +37,7 @@ Documentation:
- Fix indentation in the RL tips page (@cove9988)
- Update GAE computation docstring
- Add documentation on exporting to TFLite/Coral
- Added JMLR paper and updated citation
Release 1.3.0 (2021-10-23)