Skip to content

DOC Ensures that SpectralCoclustering passes numpydoc validation #21282

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

Closed
wants to merge 2 commits into from
Closed

DOC Ensures that SpectralCoclustering passes numpydoc validation #21282

wants to merge 2 commits into from

Conversation

pdavis327
Copy link

Reference Issues/PRs

Addresses #20308

What does this implement/fix? Explain your changes.

Any other comments?

Comment on lines +302 to +304
SpectralClustering: Performs a low-dimension embedding of the
affinity matrix between samples, followed by clustering, e.g., by KMeans,
of the components of the eigenvectors in the low dimensional space.
Copy link
Member

Choose a reason for hiding this comment

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

I am not able to make suggestions. I assume that when opening the PR, you unchecked the checkbox that allows maintainers to make some editing.

Here, you should replace with:

SpectralClustering : Apply clustering to a projection of the normalized Laplacian.


Returns
-------
self: object
Copy link
Member

Choose a reason for hiding this comment

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

Replace with

self : object

Returns
-------
self: object
Fitted biclustering for X.
Copy link
Member

Choose a reason for hiding this comment

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

Replace with

Returns a fitted instance.


y : Ignored
Not used.
Copy link
Member

Choose a reason for hiding this comment

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

Replace with

        y : Ignored
            Not used, present for API consistency by convention.

@glemaitre
Copy link
Member

Addressed in #21463

@glemaitre glemaitre closed this Oct 26, 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.

2 participants