DOC Add example link to KNeighborsClassifier class #26979
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
glemaitre
reviewed
Aug 2, 2023
sklearn/neighbors/_classification.py
Outdated
| @@ -37,6 +37,7 @@ class KNeighborsClassifier(KNeighborsMixin, ClassifierMixin, NeighborsBase): | |||
|
|
|||
| Read more in the :ref:`User Guide <classification>`. | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
Suggested change
By removing this line, it should solve the CI failure.
There was a problem hiding this comment.
Thanks for pointing out the CI failure, I hadn't noticed it.
sklearn/neighbors/_classification.py
Outdated
Comment on lines
176
to
178
|
|
||
| See :ref:`sphx_glr_auto_examples_neighbors_plot_classification.py` | ||
| for an example on how to use the API. |
There was a problem hiding this comment.
I think that we should put this example reference in the weights parameter description.
Indeed, it shows two different classification decision boundaries that change due to this parameter. So I would move and rephrase to:
Refer to the example entitled
:ref:`sphx_glr_auto_examples_neighbors_plot_classification.py`
showing the impact of the `weights` parameter on the decision
boundary.There was a problem hiding this comment.
Indeed. I've now moved and rephrased the reference link.
glemaitre
approved these changes
Aug 11, 2023
TamaraAtanasoska
pushed a commit
to TamaraAtanasoska/scikit-learn
that referenced
this pull request
Aug 21, 2023
akaashpatelmns
pushed a commit
to akaashp2000/scikit-learn
that referenced
this pull request
Aug 25, 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.
This adds a link to the example from plot_classification to KNearestNeighbors class to make it more discoverable.
@adrinjalali