Merge pull request #442 from scikit-learn-contrib/400-create-citations-using-github

400 create citations using GitHub

Author: LacombeLouis

.bumpversion.cfg

@@ -14,3 +14,8 @@ replace = __version__ = "{new_version}"
 [bumpversion:file:doc/conf.py]
 search = version = "{current_version}"
 replace = version = "{new_version}"
+
+[bumpversion:file:CITATION.cff]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+

CITATION.cff

@@ -0,0 +1,48 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Cordier"
+  given-names: "Thibault"
+  orcid: "https://orcid.org/0000-0000-0000-0000"
+title: "MAPIE - Model Agnostic Prediction Interval Estimator"
+version: 0.8.3
+date-released: 2019-04-30
+url: "https://github.com/scikit-learn-contrib/MAPIE"
+preferred-citation:
+  type: conference-paper
+  title: "Flexible and Systematic Uncertainty Estimation with Conformal Prediction via the MAPIE library"
+  authors:
+  - family-names: "Cordier"
+    given-names: "Thibault"
+  - family-names: "Blot"
+    given-names: "Vincent"
+  - family-names: "Lacombe"
+    given-names: "Louis"
+  - family-names: "Morzadec"
+    given-names: "Thomas"
+  - family-names: "Capitaine"
+    given-names: "Arnaud"
+  - family-names: "Brunel"
+    given-names: "Nicolas"
+  collection-title: "Conformal and Probabilistic Prediction with Applications"
+  collection-type: proceedings
+  pages: "549--581"
+  year: 2023
+  organization: "PMLR"
+old-citation:
+  type: article
+  authors:
+  - family-names: "Taquet"
+    given-names: "Vianney"
+  - family-names: "Blot"
+    given-names: "Vincent"
+  - family-names: "Morzadec"
+    given-names: "Thomas"
+  - family-names: "Lacombe"
+    given-names: "Louis"
+  - family-names: "Brunel"
+    given-names: "Nicolas"
+  doi: "10.48550/arXiv.2207.12274"
+  journal: "arXiv preprint arXiv:2207.12274"
+  title: "MAPIE: an open-source library for distribution-free uncertainty quantification"
+  year: 2021

HISTORY.rst

@@ -8,6 +8,7 @@ History
 * Fix conda versionning.
 * Reduce precision for test in `MapieCalibrator`.
 * Fix invalid certificate when downloading data.
+* Add citations utility to the documentation.
 
 0.8.3 (2024-03-01)
 ------------------

README.rst

@@ -12,7 +12,7 @@
     :target: https://mapie.readthedocs.io/en/stable/?badge=stable
     :alt: Documentation Status
 
-.. |License| image:: https://img.shields.io/github/license/simai-ml/MAPIE
+.. |License| image:: https://img.shields.io/github/license/scikit-learn-contrib/MAPIE
    :target: https://github.com/scikit-learn-contrib/MAPIE/blob/master/LICENSE
 
 .. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/mapie
@@ -33,7 +33,7 @@
 .. |DOI| image:: https://img.shields.io/badge/10.48550/arXiv.2207.12274-B31B1B.svg
    :target: https://arxiv.org/abs/2207.12274
 
-.. image:: https://github.com/simai-ml/MAPIE/raw/master/doc/images/mapie_logo_nobg_cut.png
+.. image:: https://github.com/scikit-learn-contrib/MAPIE/raw/master/doc/images/mapie_logo_nobg_cut.png
     :width: 400
     :align: center
 
@@ -158,7 +158,7 @@ The full documentation can be found `on this link <https://mapie.readthedocs.io/
 ===============
 
 You are welcome to propose and contribute new ideas.
-We encourage you to `open an issue <https://github.com/simai-ml/MAPIE/issues>`_ so that we can align on the work to be done.
+We encourage you to `open an issue <https://github.com/scikit-learn-contrib/MAPIE/issues>`_ so that we can align on the work to be done.
 It is generally a good idea to have a quick discussion before opening a pull request that is potentially out-of-scope.
 For more information on the contribution process, please go `here <CONTRIBUTING.rst>`_.
 
@@ -223,4 +223,10 @@ and with the financial support from Région Ile de France and Confiance.ai.
 📝 License
 ==========
 
-MAPIE is free and open-source software licensed under the `3-clause BSD license <https://github.com/simai-ml/MAPIE/blob/master/LICENSE>`_.
+MAPIE is free and open-source software licensed under the `3-clause BSD license <LICENSE>`_.
+
+
+📚 Citation
+===========
+
+If you use MAPIE in your research, please cite using `citations file <CITATION.cff>`_ on our repository.