-
-
Notifications
You must be signed in to change notification settings - Fork 25.3k
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
[MRG+2] addresses #8509 improvements to f_regression documentation #8548
[MRG+2] addresses #8509 improvements to f_regression documentation #8548
Conversation
… see all line from another function, the line is over by a period, does not make sense to newline that.
Thanks ! It looks much better to me! |
that is, ((X[:, i] - mean(X[:, i])) * (y - mean_y)) / (std(X[:, i]) * | ||
std(y)). | ||
2. It is converted to an F score then to a p-value. | ||
|
||
Read more in the :ref:`User Guide <univariate_feature_selection>`. | ||
For more on usage see the :ref:`User Guide <univariate_feature_selection>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure about this change. Nearly every class/function docstring includes "Read more in the".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed it to make it more clear what the user guide provides in relation to the content in the docstring. "Read more" left me to expect more information about f regression, but it actually is a page on feature selection. I didn't notice that the specific "read more in" was used everywhere, consistency might be worth keeping.
No I think you're right
…On 7 Mar 2017 3:01 pm, "Sarah Brown" ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In sklearn/feature_selection/univariate_selection.py
<#8548 (comment)>
:
> that is, ((X[:, i] - mean(X[:, i])) * (y - mean_y)) / (std(X[:, i]) *
std(y)).
2. It is converted to an F score then to a p-value.
- Read more in the :ref:`User Guide <univariate_feature_selection>`.
+ For more on usage see the :ref:`User Guide <univariate_feature_selection>`.
I changed it to make it more clear what the user guide provides in
relation to the content in the docstring. "Read more" left me to expect
more information about f regression, but it actually is a page on feature
selection. I didn't notice that the specific "read more in" was used
everywhere, consistency might be worth keeping.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#8548 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAEz65Pu63zej54fkso0k3TDLYcTI0Xsks5rjNazgaJpZM4MU06Y>
.
|
Thanks! |
…mentation (scikit-learn#8548) * clarify role of the function and streamline introduction * added feature selection methods to see also * completed see also * fixed pep related formatting for flake8checks. * fixed extra whitespace flake8 problems, remaining failure is a copied see all line from another function, the line is over by a period, does not make sense to newline that. * one more whitespace * FIX small pep8 error.
…mentation (scikit-learn#8548) * clarify role of the function and streamline introduction * added feature selection methods to see also * completed see also * fixed pep related formatting for flake8checks. * fixed extra whitespace flake8 problems, remaining failure is a copied see all line from another function, the line is over by a period, does not make sense to newline that. * one more whitespace * FIX small pep8 error.
…mentation (scikit-learn#8548) * clarify role of the function and streamline introduction * added feature selection methods to see also * completed see also * fixed pep related formatting for flake8checks. * fixed extra whitespace flake8 problems, remaining failure is a copied see all line from another function, the line is over by a period, does not make sense to newline that. * one more whitespace * FIX small pep8 error.
…mentation (scikit-learn#8548) * clarify role of the function and streamline introduction * added feature selection methods to see also * completed see also * fixed pep related formatting for flake8checks. * fixed extra whitespace flake8 problems, remaining failure is a copied see all line from another function, the line is over by a period, does not make sense to newline that. * one more whitespace * FIX small pep8 error.
…mentation (scikit-learn#8548) * clarify role of the function and streamline introduction * added feature selection methods to see also * completed see also * fixed pep related formatting for flake8checks. * fixed extra whitespace flake8 problems, remaining failure is a copied see all line from another function, the line is over by a period, does not make sense to newline that. * one more whitespace * FIX small pep8 error.
…mentation (scikit-learn#8548) * clarify role of the function and streamline introduction * added feature selection methods to see also * completed see also * fixed pep related formatting for flake8checks. * fixed extra whitespace flake8 problems, remaining failure is a copied see all line from another function, the line is over by a period, does not make sense to newline that. * one more whitespace * FIX small pep8 error.
…mentation (scikit-learn#8548) * clarify role of the function and streamline introduction * added feature selection methods to see also * completed see also * fixed pep related formatting for flake8checks. * fixed extra whitespace flake8 problems, remaining failure is a copied see all line from another function, the line is over by a period, does not make sense to newline that. * one more whitespace * FIX small pep8 error.
Clarified the role of this function in documentation as requested and added additional see also for more complete context.