400 create citations using GitHub

[LacombeLouis]

Description

This pull request introduces the addition of citation details to the MAPIE project by including a CITATIONS.cff file. The goal is to facilitate proper citation of MAPIE in academic and professional work by providing a standardized citation format. This change addresses the issue raised regarding the beneficial use of citations directly from the GitHub features. The CITATIONS.cff file includes author details, software title, version, release date, URL, and a preferred citation format.

Fixes #400.

Type of change:

Please remove options that are irrelevant.

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Verified that the CITATIONS.cff file is properly formatted and recognized by GitHub
• Ensured the citation information is correct and matches the required format

Checklist

• I have read the contributing guidelines
• I have updated the HISTORY.rst and AUTHORS.rst files
• Linting passes successfully : make lint
• Typing passes successfully : make type-check
• Unit tests pass successfully : make tests
• Coverage is 100% : make coverage
• Documentation builds successfully : make doc

[thibaultcordier]

Thank you for this PR, which will enable the project to be more widely cited.

Is it also possible to add a citation at the end of the readme? (https://github.com/scikit-learn/scikit-learn?tab=readme-ov-file#citation)

[thibaultcordier]

Is it possible to quote the paper presented to COPA (as a replacement or in addition)?

[LacombeLouis]

Could you remind me the link to this paper? My only concern is that this paper also presented a new insight and was not a general overview of the library.

What do you think @vincentblot28 ?

[vincentblot28]

I think we must add the COPA paper as we also present MAPIE in it. https://proceedings.mlr.press/v204/cordier23a/cordier23a.pdf

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (614293e) to head (2b156ce).
Report is 362 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##            master      #442    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           39        41     +2     
  Lines         4616      4907   +291     
  Branches       487       523    +36     
==========================================
+ Hits          4616      4907   +291     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[thibaultcordier]

Thank you for these changes. Once again, these are just a few harmonised changes. At the same time, I don't understand why we don't see all the citation information in the "Cite the repository" function...

[thibaultcordier]

Great! Let's merge them!