scikit-learn-contrib / MAPIE

A scikit-learn-compatible module to estimate prediction intervals and control risks based on conformal predictions.
https://mapie.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
1.2k stars 99 forks source link

400 create citations using GitHub #442

Closed LacombeLouis closed 1 month ago

LacombeLouis commented 1 month ago

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.

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

Checklist

codecov-commenter commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.