search

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

[DOC] updated reference for Residual Normalised Score #380

Closed mehdi-elion closed 7 months ago

mehdi-elion commented 7 months ago

Description

Changed the reference for the residual normalized score from

[1] Angelopoulos, A. N., & Bates, S. (2021). A gentle introduction to conformal
prediction and distribution-free uncertainty quantification. arXiv preprint arXiv:2107.07511.

to

[1] Lei, J., G'Sell, M., Rinaldo, A., Tibshirani, R. J., & Wasserman, L. (2017). Distribution-Free
Predictive Inference For Regression. arXiv:1604.04173.

Fixes #366

Type of change

This is a simple documentation update.

How Has This Been Tested?

This has been tested according to the items of the checklist below.

Checklist

codecov-commenter commented 7 months ago

Codecov Report

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

Comparison is base (614293e) 100.00% compared to head (dfbf561) 100.00%. Report is 5 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #380 +/- ## ========================================== Coverage 100.00% 100.00% ========================================== Files 39 39 Lines 4616 4618 +2 Branches 487 757 +270 ========================================== + Hits 4616 4618 +2 ```

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

mehdi-elion commented 7 months ago

Sure :) I added the following bullet point in HISTORY.rst:

* Fix reference for residual normalised score in documentation
mehdi-elion commented 7 months ago

@vincentblot28 thanks a lot for approving the changes !

I'm sorry for asking but, since I still am quite unfamiliar with MAPIE's merging policy, I'm unsure about whether PRs should be merged by contributors or owners/maintainers.

Let me know if you need any additional action from me :)

vincentblot28 commented 7 months ago

@mehdi-elion, your PR is ready, you can merge it ! Thank you for taking in charge this issue

mehdi-elion commented 7 months ago

Awesome! Unfortunately I fear that don't have write access / merging rights (yet ?) to MAPIE's repository. Are you observing that on your side as well @vincentblot28 ? If so, would it be possible to grant me with sufficient rights to merge the PR :) ? (If not, I apologize for the misunderstanding, this is my 1st contribution to MAPIE)

thibaultcordier commented 7 months ago

Awesome! Unfortunately I fear that don't have write access / merging rights (yet ?) to MAPIE's repository. Are you observing that on your side as well @vincentblot28 ? If so, would it be possible to grant me with sufficient rights to merge the PR :) ? (If not, I apologize for the misunderstanding, this is my 1st contribution to MAPIE)

Don't worry :) do you see the green "Merge pull request" button below this comment? If so, you have the right to finish the pull request. If not, no problem, I'll merge the pull request for you straight away.

mehdi-elion commented 7 months ago

@thibaultcordier I actually can't see the green "Merge pull request" button at the end of this thread ^^' Here's a screenshot of what I see (just in case): image It looks like I'll have to rely on you to have it merged :)

thibaultcordier commented 7 months ago

@thibaultcordier I actually can't see the green "Merge pull request" button at the end of this thread ^^' Here's a screenshot of what I see (just in case). It looks like I'll have to rely on you to have it merged :)

No problem, I'll merge your pull request. Sorry for the wait and thanks again :)