DOC Add reference to CalibrationDisplay from calibration_curve's docstring #31312
Conversation
There was a problem hiding this comment.
Thanks for the PR. I checked the rendered HTML doc linked from the CI report of this PR (Check the rendered docs here!, reachable by expanding the "All checks have passed" menu) and the results look good:
Maybe we could be a little bit more descriptive as suggested below, but otherwise LGTM.
sklearn/calibration.py
Outdated
| @@ -1005,6 +1005,10 @@ def calibration_curve( | |||
| prob_pred : ndarray of shape (n_bins,) or smaller | |||
| The mean predicted probability in each bin. | |||
|
|
|||
| See Also | |||
| -------- | |||
| sklearn.calibration.CalibrationDisplay : Calibration curve visualization. | |||
There was a problem hiding this comment.
| sklearn.calibration.CalibrationDisplay : Calibration curve visualization. | |
| sklearn.calibration.CalibrationDisplay : Calibration curve visualization | |
| based on matplotlib. |
There was a problem hiding this comment.
Actually, rather than linking to the class itself, I think we should directly link to the sklearn.calibration.CalibrationDisplay.from_estimator and from_predictions factory methods.
There was a problem hiding this comment.
I modified as suggested, I copied the sklearn.calibration.CalibrationDisplay.from_estimator and from_predictions description from another function for consistency, waiting for test to get approved
There was a problem hiding this comment.
Thanks @metlouf and congrats on your first merge in scikit-learn!
Reference Issues/PRs
Fixes #31311. See also #31302
Reference CalibrationDisplay from calibration_curve's docstring in a "See also section"
What does this implement/fix? Explain your changes.
Modify Doc of CalibrationDisplay
Any other comments?