[Docs] Update citation

facebookresearch · Dec 5, 2023 · ca2b935 · ca2b935
1 parent bb04829
commit ca2b935
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 21 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -1,13 +1,19 @@
 cff-version: 1.2.0
 message: If you use this software, please cite it as below.
 type: software
-title: "BenchMARL: Benchmarking Multi-Agent Reinforcement Learning"
+title: "BenchMARL"
 authors:
-- family-names: Bettini
-  given-names: Matteo
-- family-names: Prorok
-  given-names: Amanda
-- family-names: Moens
-  given-names: Vincent
+- family-names: BenchMARL team
 url: "https://github.com/facebookresearch/BenchMARL"
-year: 2023
+preferred-citation:
+    type: article
+    title: "BenchMARL: Benchmarking Multi-Agent Reinforcement Learning"
+    authors:
+    - family-names: Bettini
+      given-names: Matteo
+    - family-names: Prorok
+      given-names: Amanda
+    - family-names: Moens
+      given-names: Vincent
+    journal: "arXiv preprint arXiv:2312.01472"
+    year: 2023
diff --git a/README.md b/README.md
@@ -479,12 +479,11 @@ as `on_batch_collected`, `on_train_end`, and `on_evaluation_end`.
 If you use BenchMARL in your research please use the following BibTeX entry:
 
 ```BibTeX
-@software{bettini2023benchmarl,
-  author =       {Bettini, Matteo and Prorok, Amanda and and Moens, Vincent},
-  title =        {BenchMARL: Benchmarking Multi-Agent Reinforcement Learning},
-  howpublished = {Github},
-  year =         {2023},
-  url =          {https://github.com/facebookresearch/BenchMARL}
+@article{bettini2023benchmarl,
+      title={BenchMARL: Benchmarking Multi-Agent Reinforcement Learning},
+      author={Matteo Bettini and Amanda Prorok and Vincent Moens},
+      year={2023},
+      journal={arXiv preprint arXiv:2312.01472},
 }
 ```
 

diff --git a/docs/source/usage/citing.rst b/docs/source/usage/citing.rst
@@ -6,10 +6,9 @@ If you use BenchMARL in your research please use the following BibTeX entry:
 
 .. code-block:: bibtex
 
-   @software{bettini2023benchmarl,
-     author =       {Bettini, Matteo and Prorok, Amanda and and Moens, Vincent},
-     title =        {BenchMARL: Benchmarking Multi-Agent Reinforcement Learning},
-     howpublished = {Github},
-     year =         {2023},
-     url =          {https://github.com/facebookresearch/BenchMARL}
-   }
+    @article{bettini2023benchmarl,
+      title={BenchMARL: Benchmarking Multi-Agent Reinforcement Learning},
+      author={Matteo Bettini and Amanda Prorok and Vincent Moens},
+      year={2023},
+      journal={arXiv preprint arXiv:2312.01472},
+    }