Skip to content

DOC Ensures that GammaRegressor passes numpydoc validation #20973

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Sep 8, 2021
Merged

DOC Ensures that GammaRegressor passes numpydoc validation #20973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4a642b
`GammaRegressor` removed from `DOCSTRING_IGNORE_LIST` in test_docstri…
baam25simo Sep 8, 2021
4338e46
In `GammRegressor` : "See Also" section added.
baam25simo Sep 8, 2021
dc54254
In `GammaRegressor`: docstring added to `family` attribute.
baam25simo Sep 8, 2021
97c06c3
Merge branch 'main' into GammaRegressr-numpydoc-validation
ogrisel Sep 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion maint_tools/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@

# List of modules ignored when checking for numpydoc validation.
DOCSTRING_IGNORE_LIST = [
"GammaRegressor",
"GaussianProcessRegressor",
"GaussianRandomProjection",
"GridSearchCV",
Expand Down
6 changes: 6 additions & 0 deletions sklearn/linear_model/_glm/glm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,6 +606,11 @@ class GammaRegressor(GeneralizedLinearRegressor):

.. versionadded:: 1.0

See Also
--------
PoissonRegressor : Generalized Linear Model with a Poisson distribution.
TweedieRegressor : Generalized Linear Model with a Tweedie distribution.

Examples
--------
>>> from sklearn import linear_model
Expand Down Expand Up @@ -648,6 +653,7 @@ def __init__(

@property
def family(self):
"""Return the family of the regressor."""
# Make this attribute read-only to avoid mis-uses e.g. in GridSearch.
return "gamma"

Expand Down