DOC fix description of tolerance in OMP #26823
Merged
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
The phrasing of the documentation suggested that the result was so that the resulting regression coefficients had the property that the norm of the residual was less than `tol`, when in fact all that was guaranteed was that the norm square would be less than `tol`. Looking at the implementation, the latter is very much the intended behavior, so we change the documentation instead of the implementation.
jeremiedbb
approved these changes
Jul 12, 2023
There was a problem hiding this comment.
Thanks for the PR @fuglede. I agree that from the implementation, checking the squared norm of the residuals is clearly intended, so I'm +1 to fix the docstring. LGTM
punndcoder28
pushed a commit
to punndcoder28/scikit-learn
that referenced
this pull request
Jul 29, 2023
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Sep 18, 2023
jeremiedbb
pushed a commit
that referenced
this pull request
Sep 20, 2023
REDVM
pushed a commit
to REDVM/scikit-learn
that referenced
this pull request
Nov 16, 2023
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.
The phrasing of the documentation suggested that the result was so that the resulting regression coefficients had the property that the norm of the residual was less than
tol, when in fact all that was guaranteed was that the norm square would be less thantol. Looking at the implementation, the latter is very much the intended behavior, so we change the documentation instead of the implementation.