Doc add link self training#31514
Conversation
StefanieSenger
left a comment
There was a problem hiding this comment.
Hey @Vedant-Kalbhor,
thanks for your PR. It needs some more work:
a) on the linting (see comments)
b) on the location to put the link: Here we have the chance to put it in a specific spot where it is most useful for the users, because the example shows a specific thing.
What do you think of putting it into the param description for oob_score to show of to evaluate it's output with oob_score=True (while the default is False). Please also add a more specialised description pointing to what is shown on the example.
Thank you!
|
|
||
|
|
There was a problem hiding this comment.
Can you please revert this? It makes the linter fail.
|
|
||
| .. versionadded:: 1.4 | ||
|
|
||
|
|
There was a problem hiding this comment.
Also this would make the linter fail.
|
|
||
| .. versionadded:: 1.4 | ||
|
|
||
| Examples |
There was a problem hiding this comment.
Please don't add a new Examples section into a docstring. These are reserved for code snippets. I wrote this in the issue.
Reference Issues/PRs
What does this implement/fix? Explain your changes.
Towards #30621
This PR adds a hyperlink to the
plot_semi_supervised_versus_svm_iris.pyexample in theSelfTrainingClassifierdocstring, improving discoverability of semi-supervised learning examples.Optionally, it also updates the User Guide section on semi-supervised learning to reference this tutorial.
Any other comments?