Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] updated reference for Residual Normalised Score #380

Merged
merged 4 commits into from
Dec 7, 2023

Conversation

mehdi-elion
Copy link
Contributor

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

  • 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

@codecov-commenter
Copy link

codecov-commenter commented Nov 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

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
@@            Coverage Diff             @@
##            master      #380    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           39        39            
  Lines         4616      4618     +2     
  Branches       487       757   +270     
==========================================
+ Hits          4616      4618     +2     

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

Copy link
Collaborator

@vincentblot28 vincentblot28 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for this PR ! Could you just update the file history.rst so that we can follow to changes for the next release. Once it's done you'll be able to merge your PR

@mehdi-elion
Copy link
Contributor Author

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

* Fix reference for residual normalised score in documentation

@mehdi-elion
Copy link
Contributor Author

mehdi-elion commented Dec 3, 2023

@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
Copy link
Collaborator

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

@mehdi-elion
Copy link
Contributor Author

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
Copy link
Collaborator

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
Copy link
Contributor Author

mehdi-elion commented Dec 7, 2023

@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
Copy link
Collaborator

@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 :)

@thibaultcordier thibaultcordier merged commit 92b578c into scikit-learn-contrib:master Dec 7, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reference for Residual Normalized Score
4 participants