Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

DOC Fix doc for single linkage in feature agglomeration #19715

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

cliffordEmmanuel
Copy link
Contributor

@cliffordEmmanuel cliffordEmmanuel commented Mar 18, 2021

Reference Issues/PRs

Fixes #15259

What does this implement/fix? Explain your changes.

Changes the description of the 'single' value for the linkage parameter for the feature agglomeration function from 'single uses the minimum of the distances between all observations of the two sets.' to 'single uses the minimum of the distances between all features of the two sets.'

Any other comments?

Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR @cliffordEmmanuel !

The documentation for AgglomerativeClustering does not need to change. We update it for FeatureAgglomeration.

@thomasjpfan
Copy link
Member

For future PRs, try to create a title that describes the changes more explicitly. The title will become the git commit message when we merge the PR.

@cliffordEmmanuel
Copy link
Contributor Author

For future PRs, try to create a title that describes the changes more explicitly. The title will become the git commit message when we merge the PR.

Thank you @thomasjpfan for the feedback, I will make this and future titles more descriptive
But please does this mean I updated the wrong file?

@thomasjpfan
Copy link
Member

But please does this mean I updated the wrong file?

Yup we need to update the docstring for FeatureAgglomeration.

@cliffordEmmanuel cliffordEmmanuel changed the title fixes error in documentation DOC: Fix doc regarding description for linkage = single in feature agglomeration function Mar 19, 2021
@cliffordEmmanuel
Copy link
Contributor Author

cliffordEmmanuel commented Mar 19, 2021

But please does this mean I updated the wrong file?

Yup we need to update the docstring for FeatureAgglomeration.

Thank you I'll roll back this change and update the featureAgglomeration instead.
I really appreciate your feedback @thomasjpfan

@cliffordEmmanuel
Copy link
Contributor Author

Hi @thomasjpfan I'm unsure where to locate the FeatureAgglomeration docstring, I'm currently looking at the sklearn/doc/modules/clustering.rst.

Could you please advise on what to do? I think I'm pretty clueless on this

@thomasjpfan
Copy link
Member

class FeatureAgglomeration(AgglomerativeClustering, AgglomerationTransform):

You can use your editor and search for "class FeatureAgglomeration" to find the location of a class or go to the api docs and click the "source"
Screen Shot 2021-03-19 at 4 36 22 PM

@cliffordEmmanuel
Copy link
Contributor Author

cliffordEmmanuel commented Mar 20, 2021

Thank you @thomasjpfan, this is way faster than the ctrl+shift+f I was using

Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@thomasjpfan thomasjpfan changed the title DOC: Fix doc regarding description for linkage = single in feature agglomeration function DOC Fix doc for single linkage in feature agglomeration Mar 21, 2021
@thomasjpfan thomasjpfan merged commit e377d85 into scikit-learn:main Mar 21, 2021
@cliffordEmmanuel cliffordEmmanuel deleted the doc_feature_agglomeration branch March 22, 2021 05:46
@glemaitre glemaitre mentioned this pull request Apr 22, 2021
12 tasks
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Apr 22, 2021
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.

FeatureAgglomeration documentation error
2 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.