Skip to content

DOC Ensures that TransformedTargetRegressor passes numpydoc validation #21261

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

Merged

Conversation

jmloyola
Copy link
Member

@jmloyola jmloyola commented Oct 7, 2021

Reference Issues/PRs

Addresses #20308

What does this implement/fix? Explain your changes.

This PR ensures TransformedTargetRegressor is compatible with numpydoc:

  • Remove TransformedTargetRegressor from DOCSTRING_IGNORE_LIST.
  • Verify that all tests are passing.
  • Change docstrings to maintain consistency

Any other comments?

This is work in progress because there still remains a failing test. The class docstring does not have a See Also section. I didn't know what to include there. @thomasjpfan, @glemaitre, what do you think we can add here?

@glemaitre
Copy link
Member

Sorry for the delay.

Yes, it is not obvious which other estimator we should link to. I was thinking that we could provide an entry for FunctionTransformer. It would a counterpart where you can modify X with an arbitrary function.

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@jmloyola
Copy link
Member Author

Thanks for answering @glemaitre 🤓
I agree FunctionTransformer could be a good fit here.
I've just added it to the See Also section.

@glemaitre glemaitre changed the title WIP DOC Ensures that TransformedTargetRegressor passes numpydoc validation DOC Ensures that TransformedTargetRegressor passes numpydoc validation Oct 18, 2021
@glemaitre glemaitre merged commit f1b010e into scikit-learn:main Oct 18, 2021
@glemaitre
Copy link
Member

Thanks @jmloyola LGTM

@jmloyola jmloyola deleted the fix_numpydoc_transformedtargetregressor branch October 18, 2021 14:12
@glemaitre glemaitre mentioned this pull request Oct 23, 2021
10 tasks
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Oct 23, 2021
scikit-learn#21261)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit that referenced this pull request Oct 25, 2021
#21261)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Dec 24, 2021
scikit-learn#21261)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants