From 4ab4e47f9c5d7e0da3d004ad20414147bea9922b Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Thu, 16 Apr 2020 11:17:39 -0400 Subject: [PATCH 01/19] testing --- docs/source/api_reference.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index c89072ae12..44c0085647 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -76,9 +76,13 @@ Transformers SimpleImputer StandardScaler + Estimators ~~~~~~~~~~ +Classifiers +----------- + .. autosummary:: :toctree: generated :template: estimator_class.rst @@ -87,6 +91,14 @@ Estimators LogisticRegressionClassifier RandomForestClassifier XGBoostClassifier + +Regressors +---------- + +.. autosummary:: + :toctree: generated + :template: estimator_class.rst + :nosignatures: LinearRegressor RandomForestRegressor From 24a824128275cd660b3535e134924bed1ea9830b Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Thu, 16 Apr 2020 15:14:25 -0400 Subject: [PATCH 02/19] more test --- docs/source/api_reference.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 44c0085647..04ab33fd0e 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -92,13 +92,15 @@ Classifiers RandomForestClassifier XGBoostClassifier + Regressors ----------- +----------- .. autosummary:: :toctree: generated :template: estimator_class.rst :nosignatures: + LinearRegressor RandomForestRegressor From 9902d04ac2fb2b816fe7743979b0db32553968d7 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Thu, 16 Apr 2020 16:53:08 -0400 Subject: [PATCH 03/19] update other components --- docs/source/api_reference.rst | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 04ab33fd0e..65034d199a 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -65,17 +65,48 @@ Components Transformers ~~~~~~~~~~~~ +Encoders +-------- + .. autosummary:: :toctree: generated :template: transformer_class.rst :nosignatures: OneHotEncoder - RFRegressorSelectFromModel - RFClassifierSelectFromModel + +Imputers +-------- + +.. autosummary:: + :toctree: generated + :template: transformer_class.rst + :nosignatures: + SimpleImputer StandardScaler +Scalers +------- + +.. autosummary:: + :toctree: generated + :template: transformer_class.rst + :nosignatures: + + StandardScaler + +Feature Selectors +----------------- + +.. autosummary:: + :toctree: generated + :template: transformer_class.rst + :nosignatures: + + RFRegressorSelectFromModel + RFClassifierSelectFromModel + Estimators ~~~~~~~~~~ From a9da162f7c5721958e40b90ca94cfc3e00c67439 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Thu, 16 Apr 2020 16:53:35 -0400 Subject: [PATCH 04/19] more testing --- docs/source/api_reference.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 597aa8be4a..74493147d9 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -62,9 +62,10 @@ Model Family Components ========== +Test Transformers ~~~~~~~~~~~~ - +testing Encoders -------- From 23dd1a4f87470549f251ecb74b17e723d85201d2 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Fri, 17 Apr 2020 01:00:25 -0400 Subject: [PATCH 05/19] testing --- docs/source/api_reference.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 74493147d9..da7c18bea6 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -63,9 +63,15 @@ Components ========== Test + + Transformers ~~~~~~~~~~~~ + + testing + + Encoders -------- From 60c05bf8830b0dd7744284fb4b034e9f248b35df Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Fri, 17 Apr 2020 01:28:28 -0400 Subject: [PATCH 06/19] cleanup --- docs/source/api_reference.rst | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index da7c18bea6..597aa8be4a 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -62,16 +62,9 @@ Model Family Components ========== -Test - - Transformers ~~~~~~~~~~~~ - -testing - - Encoders -------- From 77992a8944f0571472e3eaa971160392fad8e19c Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Fri, 17 Apr 2020 01:31:59 -0400 Subject: [PATCH 07/19] more testing' gp --- docs/source/api_reference.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 597aa8be4a..18567d6f67 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -65,6 +65,9 @@ Components Transformers ~~~~~~~~~~~~ +Testing testing +^^^^^^^^^^^^^^^ + Encoders -------- From 3d495d1161a598fe5bf728c11328b5de42a5f6a3 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Fri, 17 Apr 2020 02:00:48 -0400 Subject: [PATCH 08/19] test --- docs/source/api_reference.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 18567d6f67..1510b3e500 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -62,11 +62,13 @@ Model Family Components ========== +this is a test + Transformers ~~~~~~~~~~~~ Testing testing -^^^^^^^^^^^^^^^ + Encoders -------- From 237bc775366160504a14833b27f97113871b247b Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Fri, 17 Apr 2020 02:21:33 -0400 Subject: [PATCH 09/19] test --- docs/source/api_reference.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 1510b3e500..d5affdf264 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -73,6 +73,9 @@ Testing testing Encoders -------- +this is a test + + .. autosummary:: :toctree: generated :template: transformer_class.rst From 98783a326a80be833951540e0d1f11234e825077 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Mon, 20 Apr 2020 18:20:03 -0400 Subject: [PATCH 10/19] updating api ref with descriptions and changelog --- docs/source/api_reference.rst | 21 +++++++++++++-------- docs/source/changelog.rst | 1 + 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 9077527126..6072451c91 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -62,19 +62,13 @@ Model Family Components ========== -this is a test - Transformers ~~~~~~~~~~~~ -Testing testing - - Encoders -------- -this is a test - +Encoders are transformers that transform categorical or non-numerical data into numerical data. .. autosummary:: :toctree: generated @@ -86,17 +80,21 @@ this is a test Imputers -------- +Imputers are transformers that fill in missing data. + .. autosummary:: :toctree: generated :template: transformer_class.rst :nosignatures: SimpleImputer - StandardScaler + Scalers ------- +Scalers are transformers that transform and standardize the range of data. + .. autosummary:: :toctree: generated :template: transformer_class.rst @@ -104,9 +102,12 @@ Scalers StandardScaler + Feature Selectors ----------------- +Feature selectors are transformers that select a subset of relevant features for the model. + .. autosummary:: :toctree: generated :template: transformer_class.rst @@ -122,6 +123,8 @@ Estimators Classifiers ----------- +Classifiers are estimators that learn from input data to predict a class label. + .. autosummary:: :toctree: generated :template: estimator_class.rst @@ -135,6 +138,8 @@ Classifiers Regressors ----------- +Regressors are estimators that learn from input data to a real output value. + .. autosummary:: :toctree: generated :template: estimator_class.rst diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 792a179e79..27bc3ba1e0 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -41,6 +41,7 @@ Changelog * Fixed improperly formatted code in breaking changes for changelog :pr:`655` * Removed separate plotting section for pipelines in API reference :pr:`657`, :pr:`665` * Have leads example notebook load S3 files using https, so we can delete s3fs dev dependency :pr:`664` + * Categorized components in API reference and added descriptions for each category :pr:`663` * Testing Changes * Matched install commands of `check_latest_dependencies` test and it's GitHub action :pr:`578` * Added Github app to auto assign PR author as assignee :pr:`477` From 9fa652ae63f0cb76c1ad160c638ce2731cd7040d Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Tue, 21 Apr 2020 14:53:42 -0400 Subject: [PATCH 11/19] update --- docs/source/api_reference.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 7f7f3836e0..1145be9d4b 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -68,7 +68,7 @@ Transformers Encoders -------- -Encoders are transformers that transform categorical or non-numerical data into numerical data. +Encoders encode categorical or non-numerical data into numerical data. .. autosummary:: :toctree: generated @@ -80,7 +80,7 @@ Encoders are transformers that transform categorical or non-numerical data into Imputers -------- -Imputers are transformers that fill in missing data. +Imputers fill in missing data. .. autosummary:: :toctree: generated @@ -93,7 +93,7 @@ Imputers are transformers that fill in missing data. Scalers ------- -Scalers are transformers that transform and standardize the range of data. +Scalers transform and standardize the range of data. .. autosummary:: :toctree: generated @@ -106,7 +106,7 @@ Scalers are transformers that transform and standardize the range of data. Feature Selectors ----------------- -Feature selectors are transformers that select a subset of relevant features for the model. +Feature selectors select a subset of relevant features for the model. .. autosummary:: :toctree: generated @@ -123,7 +123,7 @@ Estimators Classifiers ----------- -Classifiers are estimators that learn from input data to predict a class label. +Classifiers learn from input data to predict a class label. .. autosummary:: :toctree: generated @@ -138,7 +138,7 @@ Classifiers are estimators that learn from input data to predict a class label. Regressors ----------- -Regressors are estimators that learn from input data to a real output value. +Regressors learn from input data to predict a real output value. .. autosummary:: :toctree: generated @@ -154,8 +154,8 @@ Regressors are estimators that learn from input data to a real output value. Pipelines ========= -Pipelines -~~~~~~~~~ +Pipeline Base Classes +~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated :template: class.rst From 4a27709d25dced2db738c2d4d6fbb9cbad7d2d3a Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Tue, 21 Apr 2020 14:54:31 -0400 Subject: [PATCH 12/19] update from dylans comment --- docs/source/api_reference.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 1145be9d4b..2fe109f81c 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -68,7 +68,7 @@ Transformers Encoders -------- -Encoders encode categorical or non-numerical data into numerical data. +Encoders convert categorical or non-numerical features into numerical features. .. autosummary:: :toctree: generated From cfbf2ae49ea6242000bbdb593eb7accbd5c0f580 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Tue, 21 Apr 2020 15:13:26 -0400 Subject: [PATCH 13/19] addressing comments --- docs/source/api_reference.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 2fe109f81c..1fdd836ec7 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -123,7 +123,7 @@ Estimators Classifiers ----------- -Classifiers learn from input data to predict a class label. +Classifiers are models which can be trained to predict a class label from input data. .. autosummary:: :toctree: generated @@ -138,7 +138,7 @@ Classifiers learn from input data to predict a class label. Regressors ----------- -Regressors learn from input data to predict a real output value. +Regressors are models which can be trained to predict a target value from input data. .. autosummary:: :toctree: generated @@ -164,6 +164,7 @@ Pipeline Base Classes PipelineBase BinaryClassificationPipeline MulticlassClassificationPipeline + RegressionPipeline Classification ~~~~~~~~~~~~~~ @@ -181,7 +182,6 @@ Classification XGBoostBinaryPipeline XGBoostMulticlassPipeline - Regression ~~~~~~~~~~ From 878bc8a4957b646ca826e3683d8d9f5299680108 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Tue, 21 Apr 2020 18:09:37 -0400 Subject: [PATCH 14/19] rtd From 601609dca311169a937ddd278ca5d0a6e82dd2e9 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Wed, 22 Apr 2020 10:25:52 -0400 Subject: [PATCH 15/19] api update --- docs/source/api_reference.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 1fdd836ec7..960085ebab 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -130,11 +130,11 @@ Classifiers are models which can be trained to predict a class label from input :template: estimator_class.rst :nosignatures: - LogisticRegressionClassifier + CatBoostClassifier RandomForestClassifier + LogisticRegressionClassifier XGBoostClassifier - Regressors ----------- @@ -145,9 +145,10 @@ Regressors are models which can be trained to predict a target value from input :template: estimator_class.rst :nosignatures: + CatBoostRegressor LinearRegressor RandomForestRegressor - + XGBoostRegressor .. currentmodule:: evalml.pipelines @@ -223,8 +224,8 @@ Domain Specific LeadScoring -Classification -~~~~~~~~~~~~~~ +Classification Objectives +~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated @@ -257,8 +258,8 @@ Classification RecallWeighted -Regression -~~~~~~~~~~ +Regression Objectives +~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated From caf437521c085fa731895fab331bf35662ffc47b Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Wed, 22 Apr 2020 10:40:22 -0400 Subject: [PATCH 16/19] update more docstrings --- evalml/pipelines/binary_classification_pipeline.py | 2 +- evalml/pipelines/classification/xgboost_binary.py | 2 +- evalml/pipelines/classification_pipeline.py | 1 + evalml/pipelines/multiclass_classification_pipeline.py | 1 + evalml/pipelines/regression_pipeline.py | 1 + 5 files changed, 5 insertions(+), 2 deletions(-) diff --git a/evalml/pipelines/binary_classification_pipeline.py b/evalml/pipelines/binary_classification_pipeline.py index 227491d399..bfbced73cf 100644 --- a/evalml/pipelines/binary_classification_pipeline.py +++ b/evalml/pipelines/binary_classification_pipeline.py @@ -8,7 +8,7 @@ class BinaryClassificationPipeline(ClassificationPipeline): - + """Pipeline subclass for all binary classification pipelines.""" threshold = None problem_type = ProblemTypes.BINARY diff --git a/evalml/pipelines/classification/xgboost_binary.py b/evalml/pipelines/classification/xgboost_binary.py index da68be8885..d39c26f813 100644 --- a/evalml/pipelines/classification/xgboost_binary.py +++ b/evalml/pipelines/classification/xgboost_binary.py @@ -2,6 +2,6 @@ class XGBoostBinaryPipeline(BinaryClassificationPipeline): - """XGBoost Pipeline for both binary and multiclass classification""" + """XGBoost Pipeline for binary classification""" custom_name = "XGBoost Binary Classification Pipeline" component_graph = ['One Hot Encoder', 'Simple Imputer', 'RF Classifier Select From Model', 'XGBoost Classifier'] diff --git a/evalml/pipelines/classification_pipeline.py b/evalml/pipelines/classification_pipeline.py index 573bcfa263..e5a03d3690 100644 --- a/evalml/pipelines/classification_pipeline.py +++ b/evalml/pipelines/classification_pipeline.py @@ -6,6 +6,7 @@ class ClassificationPipeline(PipelineBase): + """Pipeline subclass for all classification pipelines.""" def predict_proba(self, X): """Make probability estimates for labels. diff --git a/evalml/pipelines/multiclass_classification_pipeline.py b/evalml/pipelines/multiclass_classification_pipeline.py index 8bac3ab7c9..74f26d4ab1 100644 --- a/evalml/pipelines/multiclass_classification_pipeline.py +++ b/evalml/pipelines/multiclass_classification_pipeline.py @@ -8,6 +8,7 @@ class MulticlassClassificationPipeline(ClassificationPipeline): + """Pipeline subclass for all multiclass classification pipelines.""" problem_type = ProblemTypes.MULTICLASS def score(self, X, y, objectives): diff --git a/evalml/pipelines/regression_pipeline.py b/evalml/pipelines/regression_pipeline.py index 575867cacc..0169895570 100644 --- a/evalml/pipelines/regression_pipeline.py +++ b/evalml/pipelines/regression_pipeline.py @@ -3,4 +3,5 @@ class RegressionPipeline(PipelineBase): + """Pipeline subclass for all regression pipelines.""" problem_type = ProblemTypes.REGRESSION From 21b2c94c9bd6253f143d8649b41cbe772dfc6917 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Wed, 22 Apr 2020 10:42:58 -0400 Subject: [PATCH 17/19] changelog --- docs/source/changelog.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 92f16749a1..88f473d313 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -52,6 +52,7 @@ Changelog * Have leads example notebook load S3 files using https, so we can delete s3fs dev dependency :pr:`664` * Categorized components in API reference and added descriptions for each category :pr:`663` * Fixed Sphinx warnings about BalancedAccuracy objective :pr:`669` + * Updated API reference to include missing components and clean up pipeline docstrings :pr:`689` * Testing Changes * Matched install commands of `check_latest_dependencies` test and it's GitHub action :pr:`578` * Added Github app to auto assign PR author as assignee :pr:`477` From a2e31afa2aa8614a9553c1981afe25b45460a731 Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Wed, 22 Apr 2020 13:40:33 -0400 Subject: [PATCH 18/19] add classificationpipeline to api ref --- docs/source/api_reference.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 0d0b4ba5c6..df76ee1500 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -57,6 +57,7 @@ Pipeline Base Classes :nosignatures: PipelineBase + ClassificationPipeline BinaryClassificationPipeline MulticlassClassificationPipeline RegressionPipeline From 12f01d08754f715573f4d150cd589410a8c0ac6e Mon Sep 17 00:00:00 2001 From: Angela Lin Date: Wed, 22 Apr 2020 14:22:30 -0400 Subject: [PATCH 19/19] add to init --- evalml/pipelines/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/evalml/pipelines/__init__.py b/evalml/pipelines/__init__.py index 824b381e51..bbe62550e3 100644 --- a/evalml/pipelines/__init__.py +++ b/evalml/pipelines/__init__.py @@ -20,6 +20,7 @@ ) from .pipeline_base import PipelineBase +from .classification_pipeline import ClassificationPipeline from .binary_classification_pipeline import BinaryClassificationPipeline from .multiclass_classification_pipeline import MulticlassClassificationPipeline from .regression_pipeline import RegressionPipeline