From 7efe8aa053918b585218664bd15c6334588be87c Mon Sep 17 00:00:00 2001 From: frellwan Date: Wed, 15 Sep 2021 20:55:49 -0400 Subject: [PATCH 1/9] (#20308) HuberRegressor changed order of sections --- sklearn/linear_model/_huber.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/sklearn/linear_model/_huber.py b/sklearn/linear_model/_huber.py index caba01242fb5d..858696b31e6fd 100644 --- a/sklearn/linear_model/_huber.py +++ b/sklearn/linear_model/_huber.py @@ -205,6 +205,13 @@ class HuberRegressor(LinearModel, RegressorMixin, BaseEstimator): A boolean mask which is set to True where the samples are identified as outliers. + References + ---------- + .. [1] Peter J. Huber, Elvezio M. Ronchetti, Robust Statistics + Concomitant scale estimates, pg 172 + .. [2] Art B. Owen (2006), A robust hybrid of lasso and ridge regression. + https://statweb.stanford.edu/~owen/reports/hhu.pdf + Examples -------- >>> import numpy as np @@ -227,13 +234,6 @@ class HuberRegressor(LinearModel, RegressorMixin, BaseEstimator): Huber coefficients: [17.7906... 31.0106...] >>> print("Linear Regression coefficients:", linear.coef_) Linear Regression coefficients: [-1.9221... 7.0226...] - - References - ---------- - .. [1] Peter J. Huber, Elvezio M. Ronchetti, Robust Statistics - Concomitant scale estimates, pg 172 - .. [2] Art B. Owen (2006), A robust hybrid of lasso and ridge regression. - https://statweb.stanford.edu/~owen/reports/hhu.pdf """ def __init__( From 77fe78a5de1035e7572b4cbb7d434a75738cec50 Mon Sep 17 00:00:00 2001 From: frellwan Date: Wed, 15 Sep 2021 21:06:44 -0400 Subject: [PATCH 2/9] (#20308) HuberRegressor added 'See Also' section --- sklearn/linear_model/_huber.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/sklearn/linear_model/_huber.py b/sklearn/linear_model/_huber.py index 858696b31e6fd..6c70441660bdb 100644 --- a/sklearn/linear_model/_huber.py +++ b/sklearn/linear_model/_huber.py @@ -205,6 +205,11 @@ class HuberRegressor(LinearModel, RegressorMixin, BaseEstimator): A boolean mask which is set to True where the samples are identified as outliers. + See Also + -------- + RANSACRegressor : RANSAC (RANdom SAmple Consensus) algorithm. + TheilSenRegressor : Theil-Sen Estimator robust multivariate regression model. + References ---------- .. [1] Peter J. Huber, Elvezio M. Ronchetti, Robust Statistics From c03f3077a8e382bd7d99f974e57ae8f59c3fcb46 Mon Sep 17 00:00:00 2001 From: frellwan Date: Wed, 15 Sep 2021 21:11:34 -0400 Subject: [PATCH 3/9] (#20308) HuberRegressor.fit added 'Returns' description --- sklearn/linear_model/_huber.py | 1 + 1 file changed, 1 insertion(+) diff --git a/sklearn/linear_model/_huber.py b/sklearn/linear_model/_huber.py index 6c70441660bdb..57e628611ec0d 100644 --- a/sklearn/linear_model/_huber.py +++ b/sklearn/linear_model/_huber.py @@ -276,6 +276,7 @@ def fit(self, X, y, sample_weight=None): Returns ------- self : object + Fitted HuberRegressor estimator. """ X, y = self._validate_data( X, From 8ba5c838d73a16a488cc56d5aae0c0b3a5eadc28 Mon Sep 17 00:00:00 2001 From: frellwan Date: Wed, 15 Sep 2021 21:12:08 -0400 Subject: [PATCH 4/9] (#20308) Removed HuberRegressor from DOCSTRING_IGNORE_LIST --- maint_tools/test_docstrings.py | 1 - 1 file changed, 1 deletion(-) diff --git a/maint_tools/test_docstrings.py b/maint_tools/test_docstrings.py index a94f91b7f2b20..9d2da3630686f 100644 --- a/maint_tools/test_docstrings.py +++ b/maint_tools/test_docstrings.py @@ -9,7 +9,6 @@ # List of modules ignored when checking for numpydoc validation. DOCSTRING_IGNORE_LIST = [ - "HuberRegressor", "IterativeImputer", "KNNImputer", "LabelPropagation", From 96ab3590ed1b2db80fe68e922c99a1eeeaa81cee Mon Sep 17 00:00:00 2001 From: EricEllwanger <52634304+EricEllwanger@users.noreply.github.com> Date: Thu, 16 Sep 2021 06:05:04 -0400 Subject: [PATCH 5/9] Update sklearn/linear_model/_huber.py Co-authored-by: Guillaume Lemaitre --- sklearn/linear_model/_huber.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sklearn/linear_model/_huber.py b/sklearn/linear_model/_huber.py index 57e628611ec0d..87e8ae1415c0c 100644 --- a/sklearn/linear_model/_huber.py +++ b/sklearn/linear_model/_huber.py @@ -276,7 +276,7 @@ def fit(self, X, y, sample_weight=None): Returns ------- self : object - Fitted HuberRegressor estimator. + Fitted `HuberRegressor` estimator. """ X, y = self._validate_data( X, From 8795429a37074e18d47c53b1adc8165351ab7f1b Mon Sep 17 00:00:00 2001 From: frellwan Date: Thu, 16 Sep 2021 06:07:59 -0400 Subject: [PATCH 6/9] (#20308) Updated with suggestions --- sklearn/linear_model/_huber.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sklearn/linear_model/_huber.py b/sklearn/linear_model/_huber.py index 57e628611ec0d..70bb0b8fa37ea 100644 --- a/sklearn/linear_model/_huber.py +++ b/sklearn/linear_model/_huber.py @@ -209,6 +209,7 @@ class HuberRegressor(LinearModel, RegressorMixin, BaseEstimator): -------- RANSACRegressor : RANSAC (RANdom SAmple Consensus) algorithm. TheilSenRegressor : Theil-Sen Estimator robust multivariate regression model. + SGDRegressor : Fitted by minimizing a regularized empirical loss with SGD References ---------- @@ -276,7 +277,7 @@ def fit(self, X, y, sample_weight=None): Returns ------- self : object - Fitted HuberRegressor estimator. + Fitted 'HuberRegressor' estimator. """ X, y = self._validate_data( X, From d6b16cf8bbc6e7073275a7180af0bcdc87740d03 Mon Sep 17 00:00:00 2001 From: EricEllwanger <52634304+EricEllwanger@users.noreply.github.com> Date: Thu, 16 Sep 2021 17:49:09 -0400 Subject: [PATCH 7/9] Update _huber.py Added suggestions --- sklearn/linear_model/_huber.py | 1 + 1 file changed, 1 insertion(+) diff --git a/sklearn/linear_model/_huber.py b/sklearn/linear_model/_huber.py index 87e8ae1415c0c..d1c5d525b8ffd 100644 --- a/sklearn/linear_model/_huber.py +++ b/sklearn/linear_model/_huber.py @@ -209,6 +209,7 @@ class HuberRegressor(LinearModel, RegressorMixin, BaseEstimator): -------- RANSACRegressor : RANSAC (RANdom SAmple Consensus) algorithm. TheilSenRegressor : Theil-Sen Estimator robust multivariate regression model. + SGDRegressor : Fitted by minimizing a regularized empirical loss with SGD References ---------- From eb8599f98e15949e67b618985ba7083700d43a8d Mon Sep 17 00:00:00 2001 From: EricEllwanger <52634304+EricEllwanger@users.noreply.github.com> Date: Thu, 16 Sep 2021 19:00:28 -0400 Subject: [PATCH 8/9] Update _huber.py Added period --- sklearn/linear_model/_huber.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sklearn/linear_model/_huber.py b/sklearn/linear_model/_huber.py index d1c5d525b8ffd..055fcca2becf6 100644 --- a/sklearn/linear_model/_huber.py +++ b/sklearn/linear_model/_huber.py @@ -209,7 +209,7 @@ class HuberRegressor(LinearModel, RegressorMixin, BaseEstimator): -------- RANSACRegressor : RANSAC (RANdom SAmple Consensus) algorithm. TheilSenRegressor : Theil-Sen Estimator robust multivariate regression model. - SGDRegressor : Fitted by minimizing a regularized empirical loss with SGD + SGDRegressor : Fitted by minimizing a regularized empirical loss with SGD. References ---------- From a583d5303ef812469931bc1fdb9b7d07bfcab5dd Mon Sep 17 00:00:00 2001 From: Guillaume Lemaitre Date: Fri, 17 Sep 2021 11:48:02 +0200 Subject: [PATCH 9/9] Update sklearn/linear_model/_huber.py --- sklearn/linear_model/_huber.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sklearn/linear_model/_huber.py b/sklearn/linear_model/_huber.py index 6107ddcd42f1f..055fcca2becf6 100644 --- a/sklearn/linear_model/_huber.py +++ b/sklearn/linear_model/_huber.py @@ -277,7 +277,7 @@ def fit(self, X, y, sample_weight=None): Returns ------- self : object - Fitted 'HuberRegressor' estimator. + Fitted `HuberRegressor` estimator. """ X, y = self._validate_data( X,