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.

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

merged 7 commits into from
Feb 7, 2022

Conversation

elboyran
Copy link
Contributor

@elboyran elboyran commented Jan 28, 2022

Added all current existing links.

Fixes #148

Added all existing links.
@elboyran elboyran self-assigned this Jan 28, 2022
@elboyran elboyran requested review from loostrum and egpbos January 28, 2022 11:29
fixed typo in link
@elboyran elboyran marked this pull request as ready for review January 31, 2022 16:02
@elboyran elboyran requested review from geek-yang and removed request for egpbos January 31, 2022 16:03
Copy link
Member

@egpbos egpbos left a comment

Choose a reason for hiding this comment

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

Looks good! Apart from the suggestions below, I'm wondering if we should add links to the original datasets. Maybe not necessary though, I guess people can Google them.

|_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?

Co-authored-by: Patrick Bos <egpbos@users.noreply.github.com>
@elboyran
Copy link
Contributor Author

Looks good! Apart from the suggestions below, I'm wondering if we should add links to the original datasets. Maybe not necessary though, I guess people can Google them.

The notebooks for generating them have links to the originals.


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.

@egpbos egpbos marked this pull request as draft February 1, 2022 13:48
Added Graphs data modality (for the future)
Added logos to datasets which didn't have (to refer to also int he tutorial's readme).
Added links to all current notebooks available in the branch
@elboyran elboyran marked this pull request as ready for review February 4, 2022 14:49
@elboyran elboyran merged commit bcebf36 into main Feb 7, 2022
Click one of the links in the table to directly go to a notebook:
This folder contains DIANNA tutorial notebooks.

Use the clicable logos below for direct access to a tutorial notebook for an explainability method and data modality/dataset:
Copy link
Member

Choose a reason for hiding this comment

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

Clickable

@loostrum loostrum deleted the 148-tutorials-readme branch February 11, 2022 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add readme in notebooks folder
3 participants