From 2ebb8aa22bb17138c9b02c07ad45885abbf2afa2 Mon Sep 17 00:00:00 2001 From: Antonin RAFFIN Date: Wed, 1 Dec 2021 18:55:21 +0100 Subject: [PATCH] Update Citation (#684) * Update citation * Remove cff file --- CITATION.bib | 10 ++++++++++ CITATION.cff | 33 --------------------------------- README.md | 18 ++++++++++-------- docs/index.rst | 20 ++++++++++++-------- docs/misc/changelog.rst | 1 + 5 files changed, 33 insertions(+), 49 deletions(-) create mode 100644 CITATION.bib delete mode 100644 CITATION.cff diff --git a/CITATION.bib b/CITATION.bib new file mode 100644 index 0000000..1f24b40 --- /dev/null +++ b/CITATION.bib @@ -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} +} diff --git a/CITATION.cff b/CITATION.cff deleted file mode 100644 index 8696aa0..0000000 --- a/CITATION.cff +++ /dev/null @@ -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 diff --git a/README.md b/README.md index be7cf74..2cce33e 100644 --- a/README.md +++ b/README.md @@ -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} } ``` diff --git a/docs/index.rst b/docs/index.rst index d55a35c..48746b7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,6 +12,8 @@ It is the next major version of `Stable Baselines