[MRG] Modify description of 'X' in k_means_.py fit methods. #7776
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kdexd
commented
Oct 28, 2016
| @@ -874,6 +874,9 @@ def fit(self, X, y=None): | |||
| Parameters | |||
| ---------- | |||
| X : array-like or sparse matrix, shape=(n_samples, n_features) | |||
| Numerical matrix of training samples to cluster. Each row | |||
| will represent a single training sample, a point in space of | |||
| 'n_features' dimensions. | |||
There was a problem hiding this comment.
This is the first draft of description. Commenting here so that this can be seen directly in PR conversation even after this diff gets outdated by any modifications.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issue
Fixes #7772
What does this implement/fix? Explain your changes.
It modifies the description of existing description of 'X' in
MiniBatchKMeans.fitmethod, and for the sake of consistence add a similar description inKMeans.fitmethod.Any other comments?
There were discussions on the issue about using the term "coordinates" in reference to treat the training sample as a data point. I referred to documentation of similar use cases in R and Julia packages and did somewhat "best of both worlds" thing here. I'm available for amendments in the description right away !
References: