Fix attribute mismatches in documentation strings. #14320
Merged
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
Describe the n_components_ attribute in addition to n_components parameter. The will differ it no n_components value given to the constructor.
There is an attribute named n_components_, not n_component_
The n_components_ attribute was referred to as n_component_
Document the FastICA.mean_ attribute.
Describe `whitening_` attribute.
10000
Just fix a typo.
Document PCA.n_features_ and PCA.n_samples_
Remove trailing whitespace
Break a line too long for Flake8
amueller
reviewed
Jul 13, 2019
Improve documentation string. Co-Authored-By: Andreas Mueller <t3kcit@gmail.com>
Update documentation string Co-Authored-By: Andreas Mueller <t3kcit@gmail.com>
Improved documentation for PCA attributes.
|
FYI for suggestions you can also just make the changes by clicking on accepting the suggestion, not sure that's what you did. |
amueller
approved these changes
Jul 13, 2019
|
Thanks ! |
4 tasks
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.
Partially fixes #14312
Fixes the following items:
FastICA, [whitening_]
The matrix projecting data onto the first principal components.
FastICA, [mean_]
The mean over features
NMF, [n_components_]
This attribute is same to the
n_componentsparameter if it was set. Otherwise,it is same with
n_featuresGaussianRandomProjection, [n_components_]
Just a typo fixed:
n_component_->n_components_SparseRandomProjection, [n_components_]
Just a typo fixed:
n_component_->n_components_PCA, [n_features_]
The number of features in the data matrix the PCA transformer was fitted on.
PCA, [n_samples_]
The number of samples in the data matrix the PCA transformer was fitted on.