chore: import upstream snapshot with attribution
This commit is contained in:
@@ -0,0 +1,71 @@
|
||||
.. currentmodule:: shap
|
||||
|
||||
.. _api_examples:
|
||||
|
||||
API Examples
|
||||
----------------
|
||||
|
||||
These examples parallel the namespace structure of SHAP. Each object or function in SHAP has a
|
||||
corresponding example notebook here that demonstrates its API usage. The source notebooks
|
||||
are `available on GitHub <https://github.com/shap/shap/tree/master/notebooks/api_examples>`_.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
example_notebooks/api_examples/migrating-to-new-api.ipynb
|
||||
|
||||
.. _explainers_examples:
|
||||
|
||||
explainers
|
||||
==========
|
||||
*See also:* :ref:`Explainer API Reference <explainers_api>`.
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
example_notebooks/api_examples/explainers/*
|
||||
|
||||
|
||||
.. _maskers_examples:
|
||||
|
||||
maskers
|
||||
=======
|
||||
*See also:* :ref:`Masker API Reference <maskers_api>`.
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
example_notebooks/api_examples/maskers/*
|
||||
|
||||
|
||||
.. _models_examples:
|
||||
|
||||
models
|
||||
======
|
||||
.. Examples for members of :ref:`shap.models <models_api>`.
|
||||
|
||||
Work in progress.
|
||||
|
||||
.. TODO: Uncomment this toctree once we have at least one example to share
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
example_notebooks/api_examples/models/*
|
||||
|
||||
|
||||
.. _plots_examples:
|
||||
|
||||
plots
|
||||
=====
|
||||
*See also:* :ref:`Plot API Reference <plots_api>`.
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
example_notebooks/api_examples/plots/*
|
||||
Reference in New Issue
Block a user