DOC: clarify r_pred is the predicted absolute residual #759
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR corrects a misleading docstring description in the get_signed_conformity_scores function to accurately reflect that the residual estimator predicts absolute residuals rather than signed residuals.
- Updates docstring to clarify that
r_predrepresentsabs(y - y_pred)instead of(y - y_pred)
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR corrects a misleading description in the docstring of the
get_signed_conformity_scoresfunction withinmapie/conformity_scores/bounds/residuals.py.The previous docstring incorrectly stated that the
r_predparameter was the predicted signed residual(y - y_pred). In reality, the underlying model (residual_estimator_) predicts the absolute residual. This change updates the docstring toabs(y - y_pred)to accurately reflect the model's behavior and prevent confusion for users and developers. It also coordinates with the docstring in this line.