Merge pull request #868 from dianna-ai/link2explainable-embeddings

Links to Explainable embeddings
dianna-ai · Nov 13, 2024 · 6cf8609 · 6cf8609
2 parents a532cc5 + 1b51dd3
commit 6cf8609
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ The key points of DIANNA:
  *   Implements well-known XAI methods LIME, RISE and KernelSHAP, chosen by systematic and objective evaluation criteria
  *   Comes with a dashboard where  results of different explainers can be compared for all data types
  *   Supports the de-facto standard of neural network models - ONNX
- *   Supports images, text, time series, and tabular data modalities, embeddings are currently being developed
+ *   Supports images, text, time series, tabular data modalities and embeddings (in a related [package](https://github.com/dianna-ai/explainable_embedding))
  *   Comes with simple intuitive image, text, time series, and tabular benchmarks, so can help you with your XAI research
  *   Includes scientific use-cases tutorials
  *   Easily extendable to other XAI methods
@@ -322,7 +322,7 @@ DIANNA supports different data modalities and XAI methods (explainers). We have
 | Text       | ✅                                                | ✅                                                                 |                                                                                                     |
 | Timeseries | ✅                                                | ✅                                                                 |                                                                                                     |
 | Tabular    | planned                                           | ✅                                                                 | ✅                                                                                                  |
-| Embedding  | work in progress                                  |                                                                     |                                                                                                     |
+| Embedding  | *inspired by RISE in [distance_explainer](https://github.com/dianna-ai/distance_explainer)  |                                                                     |                                                                                                     |
 | Graphs*    | next steps                                        |    ...                                                              |     ...                                                                                             |
 
 [LRP](https://journals.plos.org/plosone/article/file?id=10.1371/journal.pone.0130140&type=printable) and [PatternAttribution](https://arxiv.org/pdf/1705.05598.pdf) also feature in the top 5 of our thoroughly evaluated explainers.

diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md
@@ -1,12 +1,10 @@
-# Current and planned DIANNA developments
+# Planned DIANNA developments
 
-- Scientific use-cases: the use of XAI in scientific applicaitons: tutorials and videos
-
-- Other data modalities: we plan support for graphs.
-
-- Embeddings: We plan to add support for embeddings as a data modality in the near future. This will allow users to create the same or similar explanations and visualizations for their models that is projecting data towards embedded spaces. 
+- Other data modalities: we plan to develop support for graphs.
 
 - Add support for text for KernelSHAP XAI method.
 
+- Extend the dashboard with more examples and make it work with custom data and models
+
 - Support for more XAI methods: Grad-CAM, LRP, PatternAttribution