From 89907404070e0f19f6d1c7aeb1307aa91cc2b5e7 Mon Sep 17 00:00:00 2001 From: Jason Date: Thu, 15 Oct 2020 09:16:55 +0100 Subject: [PATCH] update API reference landing page in documentation (#104) This commit * adds an image for facet workflow * revises the API reference landing page --- sphinx/source/_static/Facet_flow.svg | 1 + src/facet/__init__.py | 38 +++++++++------------------- 2 files changed, 13 insertions(+), 26 deletions(-) create mode 100644 sphinx/source/_static/Facet_flow.svg diff --git a/sphinx/source/_static/Facet_flow.svg b/sphinx/source/_static/Facet_flow.svg new file mode 100644 index 000000000..2d7a00f93 --- /dev/null +++ b/sphinx/source/_static/Facet_flow.svg @@ -0,0 +1 @@ +1. Feature selection 2. Learner selection3. Learner inspection4. Independent feature engineering5. Univariate simulationUse historical simulation for your important independent features to gain critical insights into optimal values for your desired outcomeUse redundancy to further eliminate unnecessary features from your model, that cannot be identified through correlation or typical feature selectionGain a deeper understanding of important features using SHAP values and FACET'snovel algorithm for advanced model inspection (redundancy, synergy) Combine pre-processing with a grid of learners and hyper-parameters in a robust workflow to select the best learner with cross-validationCreate a robust and reproducible pre-processing pipeline to easily pre-process your data and select your features \ No newline at end of file diff --git a/src/facet/__init__.py b/src/facet/__init__.py index 0a0190d42..76fc89e69 100644 --- a/src/facet/__init__.py +++ b/src/facet/__init__.py @@ -1,31 +1,17 @@ """ -Machine learning workflows for advanced model selection and -inspection. - - -Implements the following subpackages: - -- :mod:`facet.selection`: model selection and hyperparameter -tuning -- :mod:`facet.validation`: scikit-learn-style cross-validators -for different \ - bootstrapping approaches -- :mod:`facet.crossfit`: a `crossfit` object manages multiple -fits \ - of the same learner across all splits of a cross-validator, - enabling a range of \ - approaches for model selection, inspection, and simulation/ - optimization -- :mod:`facet.inspection`: explaining the interactions of a model's -features \ - with each other, and with the target variable, based on the SHAP - approach -- :mod:`facet.simulation`: simulating variables using a predictive -model -""" -# todo: explain the basic workflow in the docstring: -# LearnerRanker --> LearnerCrossfit --> LearnerInspector +Welcome to the class and function reference of FACET to enhance your machine learning +workflow for advanced model selection and inspection. + + +.. image:: + ../_static/Facet_flow.svg + + +Please refer to the tutorials for further information on the use of FACET classes and +functions. + +""" from ._facet import Sample