From 89827e608e8075d4b64cc761d3f5b93e0645be45 Mon Sep 17 00:00:00 2001 From: genvalen Date: Fri, 16 Jul 2021 22:48:48 -0400 Subject: [PATCH 1/4] Remove EllipticEnvelope 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 587190401c61e..9f34105e8aa7a 100644 --- a/maint_tools/test_docstrings.py +++ b/maint_tools/test_docstrings.py @@ -23,7 +23,6 @@ "DictionaryLearning", "DummyClassifier", "ElasticNetCV", - "EllipticEnvelope", "EmpiricalCovariance", "ExtraTreeClassifier", "ExtraTreeRegressor", From 9932fc65c65fd19333ae12fd0d88e0692321e342 Mon Sep 17 00:00:00 2001 From: genvalen Date: Fri, 16 Jul 2021 23:32:15 -0400 Subject: [PATCH 2/4] Ensure EllipticEnvelope passes numpydoc validation --- sklearn/covariance/_elliptic_envelope.py | 46 ++++++++++++++---------- 1 file changed, 27 insertions(+), 19 deletions(-) diff --git a/sklearn/covariance/_elliptic_envelope.py b/sklearn/covariance/_elliptic_envelope.py index d9d0e7e1b3f04..366477b61a028 100644 --- a/sklearn/covariance/_elliptic_envelope.py +++ b/sklearn/covariance/_elliptic_envelope.py @@ -88,6 +88,26 @@ class EllipticEnvelope(OutlierMixin, MinCovDet): .. versionadded:: 0.24 + See Also + -------- + EmpiricalCovariance : Maximum likelihood covariance estimator + MinCovDet : Minimum Covariance Determinant + (robust estimator of covariance). + GraphicalLasso : Sparse inverse covariance estimation + with an l1-penalized estimator. + + Notes + ----- + Outlier detection from covariance estimation may break or not + perform well in high-dimensional settings. In particular, one will + always take care to work with ``n_samples > n_features ** 2``. + + References + ---------- + .. [1] Rousseeuw, P.J., Van Driessen, K. "A fast algorithm for the + minimum covariance determinant estimator" Technometrics 41(3), 212 + (1999) + Examples -------- >>> import numpy as np @@ -107,22 +127,6 @@ class EllipticEnvelope(OutlierMixin, MinCovDet): [0.2535..., 0.3053...]]) >>> cov.location_ array([0.0813... , 0.0427...]) - - See Also - -------- - EmpiricalCovariance, MinCovDet - - Notes - ----- - Outlier detection from covariance estimation may break or not - perform well in high-dimensional settings. In particular, one will - always take care to work with ``n_samples > n_features ** 2``. - - References - ---------- - .. [1] Rousseeuw, P.J., Van Driessen, K. "A fast algorithm for the - minimum covariance determinant estimator" Technometrics 41(3), 212 - (1999) """ def __init__( @@ -152,6 +156,11 @@ def fit(self, X, y=None): y : Ignored Not used, present for API consistency by convention. + + Returns + ------- + self : object + Returns the instance itself. """ if self.contamination != "auto": if not (0.0 < self.contamination <= 0.5): @@ -202,8 +211,7 @@ def score_samples(self, X): def predict(self, X): """ - Predict the labels (1 inlier, -1 outlier) of X according to the - fitted model. + Predict labels (1 inlier, -1 outlier) of X according to fitted model. Parameters ---------- @@ -222,7 +230,7 @@ def predict(self, X): return is_inlier def score(self, X, y, sample_weight=None): - """Returns the mean accuracy on the given test data and labels. + """Return the mean accuracy on the given test data and labels. In multi-label classification, this is the subset accuracy which is a harsh metric since you require for each sample that From 531f2cad732bb7dc78b02437f2958f6e02630cd5 Mon Sep 17 00:00:00 2001 From: genvalen Date: Fri, 16 Jul 2021 23:35:57 -0400 Subject: [PATCH 3/4] Add period --- sklearn/covariance/_elliptic_envelope.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sklearn/covariance/_elliptic_envelope.py b/sklearn/covariance/_elliptic_envelope.py index 366477b61a028..d6e3e382c0646 100644 --- a/sklearn/covariance/_elliptic_envelope.py +++ b/sklearn/covariance/_elliptic_envelope.py @@ -90,7 +90,7 @@ class EllipticEnvelope(OutlierMixin, MinCovDet): See Also -------- - EmpiricalCovariance : Maximum likelihood covariance estimator + EmpiricalCovariance : Maximum likelihood covariance estimator. MinCovDet : Minimum Covariance Determinant (robust estimator of covariance). GraphicalLasso : Sparse inverse covariance estimation From ae7980e4cba2f4cbf380ae9a628b4421d1749f61 Mon Sep 17 00:00:00 2001 From: genvalen Date: Sat, 17 Jul 2021 09:58:11 -0400 Subject: [PATCH 4/4] Add more options to See Also section. --- sklearn/covariance/_elliptic_envelope.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/sklearn/covariance/_elliptic_envelope.py b/sklearn/covariance/_elliptic_envelope.py index d6e3e382c0646..a484caca6998b 100644 --- a/sklearn/covariance/_elliptic_envelope.py +++ b/sklearn/covariance/_elliptic_envelope.py @@ -91,10 +91,13 @@ class EllipticEnvelope(OutlierMixin, MinCovDet): See Also -------- EmpiricalCovariance : Maximum likelihood covariance estimator. - MinCovDet : Minimum Covariance Determinant - (robust estimator of covariance). GraphicalLasso : Sparse inverse covariance estimation with an l1-penalized estimator. + LedoitWolf : LedoitWolf Estimator. + MinCovDet : Minimum Covariance Determinant + (robust estimator of covariance). + OAS : Oracle Approximating Shrinkage Estimator. + ShrunkCovariance : Covariance estimator with shrinkage. Notes -----