Skip to content

[WIP] DOC Description of X missing in KMeans.fit (#7772) #7775

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 3 commits into from

Conversation

ditenberg
Copy link
Contributor

@ditenberg ditenberg commented Oct 28, 2016

Addressed issue #7772:

Added "Training instances to cluster" as explanation in fit() methods in k_means_.py. Also made both docstring match in terms of parameter descriptions for X in fit(): "X : array-like or sparse matrix, shape=(n_samples, n_features)". This convention is according to that proposed by amueller in #3791.

@raghavrv
Copy link
Member

HI @ditenberg, the PR diff seems incorrect, could you check?

@ditenberg
Copy link
Contributor Author

Hi @raghavrv, yes I noticed that too. I think it's because I accidentally referenced the wrong issue (one number off) in the pushes to my repo before sending a pull request. I will fix it.

@raghavrv raghavrv changed the title [MRG] DOC Description of X missing in KMeans.fit (#7772 [WIP] DOC Description of X missing in KMeans.fit (#7772) Oct 28, 2016
@raghavrv raghavrv added this to the 0.18.1 milestone Oct 28, 2016
@raghavrv
Copy link
Member

Once you fix that please ping me again?

X : array-like, shape = [n_samples, n_features]
Coordinates of the data points to cluster
X : array-like or sparse matrix, shape=(n_samples, n_features)
Training instances to cluster
Copy link
Member

Choose a reason for hiding this comment

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

For now we can have it as

Training data to cluster.

A more general docstring which is standardized across the codebase will be addressed by fixing #3791 later...

@ditenberg ditenberg closed this Oct 29, 2016
@ditenberg ditenberg deleted the X_DOC_changes branch October 29, 2016 13:38
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.

4 participants