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

783 simplify overview tutorial #792

Merged
merged 4 commits into from
Jun 10, 2024
Merged

Conversation

elboyran
Copy link
Contributor

@elboyran elboyran commented Jun 7, 2024

Make the overview tutorial better.

elboyran and others added 4 commits June 7, 2024 14:29
…ble from zenodo. Fixed colormaps where there is not default in our code
Fixed the link to the overview tutorial!
…l sections, referral to all tutorials, adding some links and logos, some formatting.
@elboyran elboyran self-assigned this Jun 7, 2024
@elboyran elboyran linked an issue Jun 7, 2024 that may be closed by this pull request
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@elboyran elboyran marked this pull request as ready for review June 7, 2024 13:52
@elboyran elboyran removed a link to an issue Jun 7, 2024
@elboyran elboyran requested review from SarahAlidoost and removed request for loostrum June 7, 2024 14:00
@elboyran
Copy link
Contributor Author

elboyran commented Jun 7, 2024

The ONNX model for the binary MNIST used in the tutorial is not the one from Zenodo! Some TF variant that is not on Zenodo is used, Using the one in Zenodo gives an error. So, the notebook still depends on local models and some other locally stored data.

Copy link
Contributor

@SarahAlidoost SarahAlidoost left a comment

Choose a reason for hiding this comment

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

@elboyran thanks, looks very good 👍 I was able to run the notebook. One minor comment: is there a reason why we don't plot the results of kernelshap, the last method in the notebook?

@elboyran
Copy link
Contributor Author

elboyran commented Jun 10, 2024

@elboyran thanks, looks very good 👍 I was able to run the notebook. One minor comment: is there a reason why we don't plot the results of kernelshap, the last method in the notebook?

@SarahAlidoost thanks for reviewing! If you recall during the last stand-up (or maybe you were not there?) there was the opinion that I should skip the whole Explainers section as it was redundant. Still, I opted for keeping it and gradually "simplifying" it, which includes firstly elaborating on LIME (corresponding to a missing LIME for Binary MNIST tutorial), then less for the second explainer, and finally not showing the last visualization. The point of the section for me is:

  • Stress again we support a few explainers
  • Show it's as easy as specifying the method's name (and some hyperparameters). How to visualize should have been clear from all examples above.
  • Finish the overview by triggering the interest and "advertising" all tutorials for many combinations of modalities-methods and pointing to the dashboard (where the methods' comparison) is the most obvious advantage.

I hope this PR achieves that.

@elboyran elboyran merged commit 47bc7af into main Jun 10, 2024
27 checks passed
@elboyran elboyran deleted the 783-simplify-overview-tutorial branch June 14, 2024 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants