Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

148-tutorials-readme #172

Merged
merged 7 commits into from
Feb 7, 2022
Merged

148-tutorials-readme #172

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d759294
Update README.md
elboyran Jan 28, 2022
8371077
Update README.md
elboyran Jan 28, 2022
7f3962c
Update tutorials/README.md
elboyran Jan 31, 2022
ad6d843
Merge branch 'main' into 148-tutorials-readme
elboyran Feb 3, 2022
b65d85e
Update README.md
elboyran Feb 3, 2022
7c4613f
Update README.md
elboyran Feb 3, 2022
8396334
Update README.md
elboyran Feb 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions tutorials/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
## Tutorials
This folder contains tutorial notebooks for DIANNA.
A tutorial is avaiable for several combinations of data modality and explanability method.
Click one of the links in the table to directly go to a notebook:
This folder contains DIANNA tutorial notebooks.

Tutorials are avaiable for several combinations of data modality, dataset and explanability method.

Use the links in the tables below to directly go to a tutorial notebook:

<!--- to do: check if LIME is for LeafSNap (Simple Sicnetific) or more. DO we need Images row or each notebook is for 1 dataset only!? -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original idea was one image dataset for each method, but there are some extra notebooks. I would only do one row for images, but multiple is also fine. LIME was only done for leafsnap

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will probably redo it. Have to see how to make this PR draft again.


### Images
|Data \ XAI|RISE|LIME|KernelSHAP|
|:-----|:---|:---|:---|
|_Images_|[]()|[link](lime_images.ipynb)|[]()|
|Binary MNIST |[link](rise_mnist.ipynb)| []()| [link](kernelshap_mnist.ipynb)|
|Simple geometric (circles and triangles) <img width="20" alt="SimpleGeometric Logo" src="https://user-images.githubusercontent.com/3244249/151539027-f2fc3fc0-282a-4993-9680-74ee28bcd360.png">|[]()| []()| [link](kernelshap_geometric_shapes.ipynb)|
|Simple scientific (Leafsnap30) <img width="20" alt="LeafSnap30 Logo" src="https://user-images.githubusercontent.com/3244249/151539100-dbdfe0f8-485f-45d4-a249-a1f79e970066.png"> []()| []()| []()|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|Simple scientific (Leafsnap30) <img width="20" alt="LeafSnap30 Logo" src="https://user-images.githubusercontent.com/3244249/151539100-dbdfe0f8-485f-45d4-a249-a1f79e970066.png"> []()| []()| []()|
<!--|Simple scientific (Leafsnap30) <img width="20" alt="LeafSnap30 Logo" src="https://user-images.githubusercontent.com/3244249/151539100-dbdfe0f8-485f-45d4-a249-a1f79e970066.png"> []()| []()| []()|-->

Let's comment it out as long as we don't have any notebooks yet, it's a bit weird to have an empty row in the table.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we have 1 notebook in progress by Yang?

|Imagenet |[link](rise_imagenet.ipynb)| []()| []()|

### Text
|Data \ XAI|RISE|LIME|KernelSHAP|
|:-----|:---|:---|:---|
|Images|[]()|[link](lime_images.ipynb)|[]()|
|Text|[]()|[link](lime_text.ipynb)|[]()|
|Stanford sentiment treebank|[]()|[link](lime_text.ipynb)|[]()|