From db46c68aeb39132de93850119b0a109c8a19b998 Mon Sep 17 00:00:00 2001 From: frellwan Date: Sun, 19 Sep 2021 07:59:28 -0400 Subject: [PATCH 1/5] (#20308) Reordered TheilSenRegressor Docstring sections --- sklearn/linear_model/_theil_sen.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/sklearn/linear_model/_theil_sen.py b/sklearn/linear_model/_theil_sen.py index a5a695f2bc3ae..3f94ba5190745 100644 --- a/sklearn/linear_model/_theil_sen.py +++ b/sklearn/linear_model/_theil_sen.py @@ -295,6 +295,12 @@ class TheilSenRegressor(RegressorMixin, LinearModel): .. versionadded:: 1.0 + References + ---------- + - Theil-Sen Estimators in a Multiple Linear Regression Model, 2009 + Xin Dang, Hanxiang Peng, Xueqin Wang and Heping Zhang + http://home.olemiss.edu/~xdang/papers/MTSE.pdf + Examples -------- >>> from sklearn.linear_model import TheilSenRegressor @@ -306,12 +312,6 @@ class TheilSenRegressor(RegressorMixin, LinearModel): 0.9884... >>> reg.predict(X[:1,]) array([-31.5871...]) - - References - ---------- - - Theil-Sen Estimators in a Multiple Linear Regression Model, 2009 - Xin Dang, Hanxiang Peng, Xueqin Wang and Heping Zhang - http://home.olemiss.edu/~xdang/papers/MTSE.pdf """ def __init__( From 4864802074f5d1b1a54b18644a8dc886c905d38f Mon Sep 17 00:00:00 2001 From: frellwan Date: Sun, 19 Sep 2021 08:01:08 -0400 Subject: [PATCH 2/5] (#20308) Added 'See Also' section to TheilSenRegressor Docstring --- sklearn/linear_model/_theil_sen.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/sklearn/linear_model/_theil_sen.py b/sklearn/linear_model/_theil_sen.py index 3f94ba5190745..1772758c77988 100644 --- a/sklearn/linear_model/_theil_sen.py +++ b/sklearn/linear_model/_theil_sen.py @@ -295,6 +295,12 @@ class TheilSenRegressor(RegressorMixin, LinearModel): .. versionadded:: 1.0 + See Also + -------- + HuberRegressor : Linear regression model that is robust to outliers. + RANSACRegressor : RANSAC (RANdom SAmple Consensus) algorithm. + SGDRegressor : Fitted by minimizing a regularized empirical loss with SGD. + References ---------- - Theil-Sen Estimators in a Multiple Linear Regression Model, 2009 From d5e2991c822869e38056190fb3571b0e3aaea8b8 Mon Sep 17 00:00:00 2001 From: frellwan Date: Sun, 19 Sep 2021 08:02:43 -0400 Subject: [PATCH 3/5] (#20308) Added period to parameter random_state description in TheilSenRegressor Docstring --- sklearn/linear_model/_theil_sen.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sklearn/linear_model/_theil_sen.py b/sklearn/linear_model/_theil_sen.py index 1772758c77988..33ac29bc3cc83 100644 --- a/sklearn/linear_model/_theil_sen.py +++ b/sklearn/linear_model/_theil_sen.py @@ -255,7 +255,7 @@ class TheilSenRegressor(RegressorMixin, LinearModel): A random number generator instance to define the state of the random permutations generator. Pass an int for reproducible output across multiple function calls. - See :term:`Glossary ` + See :term:`Glossary `. n_jobs : int, default=None Number of CPUs to use during the cross validation. From 534ef213acb8d8ab45bc594cfd1a6f1abe6ccd32 Mon Sep 17 00:00:00 2001 From: frellwan Date: Sun, 19 Sep 2021 08:07:02 -0400 Subject: [PATCH 4/5] (#20308) Added description to Returns section TheilSenRegressor.fit Docstring --- sklearn/linear_model/_theil_sen.py | 1 + 1 file changed, 1 insertion(+) diff --git a/sklearn/linear_model/_theil_sen.py b/sklearn/linear_model/_theil_sen.py index 33ac29bc3cc83..579f0afa3997c 100644 --- a/sklearn/linear_model/_theil_sen.py +++ b/sklearn/linear_model/_theil_sen.py @@ -400,6 +400,7 @@ def fit(self, X, y): Returns ------- self : returns an instance of self. + Fitted `TheilSenRegressor` estimator. """ random_state = check_random_state(self.random_state) X, y = self._validate_data(X, y, y_numeric=True) From c78d1f259a278fb2fcb9a796caa5c581b36dda6c Mon Sep 17 00:00:00 2001 From: frellwan Date: Sun, 19 Sep 2021 08:10:26 -0400 Subject: [PATCH 5/5] (#20308) Removed TheilSenRegressor for 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 d094a661ea654..bc24431e6abb1 100644 --- a/maint_tools/test_docstrings.py +++ b/maint_tools/test_docstrings.py @@ -47,7 +47,6 @@ "SplineTransformer", "StackingClassifier", "StackingRegressor", - "TheilSenRegressor", "TransformedTargetRegressor", "TweedieRegressor", ]