-
-
Notifications
You must be signed in to change notification settings - Fork 25.9k
DOC: replace plot_random_dataset with snippets in docstrings #29933
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
cb660ec
to
11bed7d
Compare
11bed7d
to
2283c8b
Compare
ping @ArturoAmorQ for review. |
Hi @yuanx749, Nicely done!, just a few suggestions here, in case they can help improve the readability and navigation for make_classification:
Either way, please update the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also as mention by @saldanhad, we need the redirection in conf.py
. I think that pointing the following example will be safe: https://scikit-learn.org/stable/auto_examples/classification/plot_classifier_comparison.html#sphx-glr-auto-examples-classification-plot-classifier-comparison-py
42d4dc0
to
a638937
Compare
f0dd788
to
ce6ae7c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the suggestions and I agree. @saldanhad @glemaitre . This will make the plots more compact.
doc/datasets/sample_generators.rst
Outdated
:scale: 50 | ||
:align: center | ||
:include-source: False |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code snippet is a bit long if placed here, so I just hide the code. WDYT @glemaitre ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @yuanx749
I push a small change such that we split the discussion for each function and add the snippet of code such that this we have shorted snippet. It looks more natural.
If the CI pass, I'll merge.
Reference Issues/PRs
Part of #27151
What does this implement/fix? Explain your changes.
Replace Plot randomly generated classification dataset with snippets in the respective docstrings.
Any other comments?