Skip to content

Commit c196342

Browse files
craymichaelfacebook-github-bot
authored andcommitted
Add Captum Insights deprecation message to README (#1498)
Summary: Pull Request resolved: #1498 Add a message about deprecating Captum Insights in an upcoming release. We intend to deprecate it fully but still provide the code for those interested in it. Reviewed By: cyrjano Differential Revision: D69695277 fbshipit-source-id: d66ffa9db91dfd0025f286b72fe8aeff62ad5a0b
1 parent 8a61aaf commit c196342

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ pip install -e .
9090
To customize the installation, you can also run the following variants of the
9191
above:
9292
* `pip install -e .[insights]`: Also installs all packages necessary for running Captum Insights.
93+
**NOTE**: Captum Insights is being deprecated. See further details [below](#captum-insights).
9394
* `pip install -e .[dev]`: Also installs all tools necessary for development
9495
(testing, linting, docs building; see [Contributing](#contributing) below).
9596
* `pip install -e .[tutorials]`: Also installs all packages necessary for running the tutorial notebooks.
@@ -386,6 +387,10 @@ Captum on different types of models can be found in our tutorials.
386387

387388
## Captum Insights
388389

390+
**NOTE**: *Support for Captum Insights is being deprecated in an upcoming release.
391+
While the code will still be available, there will no longer be active
392+
development or support for it.*
393+
389394
Captum provides a web interface called Insights for easy visualization and
390395
access to a number of our interpretability algorithms.
391396

0 commit comments

Comments
 (0)