Skip to content

Commit

Permalink
update API reference landing page in documentation (#104)
Browse files Browse the repository at this point in the history
This commit
* adds an image for facet workflow
* revises the API reference landing page
  • Loading branch information
jason-bentley authored Oct 15, 2020
1 parent af1b7ff commit 8990740
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 26 deletions.
1 change: 1 addition & 0 deletions sphinx/source/_static/Facet_flow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 12 additions & 26 deletions src/facet/__init__.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 8990740

Please sign in to comment.