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
DOC Add minimal reproducer guide for scikit-learn #22401
DOC Add minimal reproducer guide for scikit-learn #22401
Conversation
…nto DOC_minimal_reproducer
Thanks @ArturoAmorQ.
This LGTM!
I left a couple of comments, nitpicks mostly.
We could also add a link to this guide in the bug report template. |
Co-authored-by: Juan Martin Loyola <[email protected]>
…nto DOC_minimal_reproducer
…t-learn into DOC_minimal_reproducer
Hi @ArturoAmorQ , this is a very useful addition.
The sphinx warning can be avoided adding a blank line before the itemizing.
Co-authored-by: Chiara Marmo <[email protected]>
Co-authored-by: Julien Jerphanion <[email protected]>
Co-authored-by: Olivier Grisel <[email protected]>
…t-learn into DOC_minimal_reproducer
To better get a feeling of what we mean by minimal, let's actually show how to simplify an overly complex code snippet that we typically get as feedback.
Co-authored-by: Olivier Grisel <[email protected]>
Co-authored-by: Olivier Grisel <[email protected]>
Co-authored-by: Olivier Grisel <[email protected]>
…nto DOC_minimal_reproducer
Co-authored-by: Olivier Grisel <[email protected]>
Reference Issues/PRs
Fixes #21945.
What does this implement/fix? Explain your changes.
This PR adds a guide to the online documentation on how to craft a minimal reproducer oriented to bug report in scikit-learn. In particular it:
sklearn.dataset.make_classification
,make_regression
,make_blobs
, or any of the scikit-learn loading dataset utilities;contributing
page;Any other comments?
This is still WIP, so any feedback on how to improve this document is always welcomed.