Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashutosh1919/explainable-cnn
📦 PyTorch based visualization package for generating layer-wise explanations for CNNs.
https://github.com/ashutosh1919/explainable-cnn
cnn cnn-classification cnn-pytorch cnn-visualization cnn-visualization-technique explainable-ai explainable-ml grad-cam grad-cam-visualization guided-backpropagation guided-grad-cam pytorch pytorch-implementation saliency-detection saliency-map visualization
Last synced: about 1 month ago
JSON representation
📦 PyTorch based visualization package for generating layer-wise explanations for CNNs.
- Host: GitHub
- URL: https://github.com/ashutosh1919/explainable-cnn
- Owner: ashutosh1919
- License: mit
- Created: 2022-03-13T20:41:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-29T09:02:41.000Z (about 1 year ago)
- Last Synced: 2024-05-21T16:08:10.877Z (4 months ago)
- Topics: cnn, cnn-classification, cnn-pytorch, cnn-visualization, cnn-visualization-technique, explainable-ai, explainable-ml, grad-cam, grad-cam-visualization, guided-backpropagation, guided-grad-cam, pytorch, pytorch-implementation, saliency-detection, saliency-map, visualization
- Language: Python
- Homepage: https://pypi.org/project/explainable-cnn/
- Size: 3.99 MB
- Stars: 213
- Watchers: 5
- Forks: 30
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Explainable CNNs
[](#torch) [](#torchvision) [](#python) [](#test_workflow) [](#price) [](#maintained)
**📦 Flexible visualization package for generating layer-wise explanations for CNNs.**
It is a common notion that a Deep Learning model is considered as a black box. Working towards this problem, this project provides flexible and easy to use `pip` package `explainable-cnn` that will help you to create visualization for any `torch` based CNN model. Note that it uses one of the data centric approach. This project focusses on making the internal working of the Neural layers more transparent. In order to do so, `explainable-cnn` is a plug & play component that visualizes the layers based on on their gradients and builds different representations including Saliency Map, Guided BackPropagation, Grad CAM and Guided Grad CAM.
## Architechture
:star: Star us on GitHub — it helps!
## Usage
Install the package
```bash
pip install explainable-cnn
```
To create visualizations, create an instance of `CNNExplainer`.
```python
from explainable_cnn import CNNExplainer
x_cnn = CNNExplainer(...)
```
The following method calls returns `numpy` arrays corresponding to image for different types of visualizations.
```python
saliency_map = x_cnn.get_saliency_map(...)
grad_cam = x_cnn.get_grad_cam(...)
guided_grad_cam = x_cnn.get_guided_grad_cam(...)
```
To see full list of arguments and their usage for all methods, please refer to this file
You may want to look at example usage in the example notebook.
## Output
Below is a comparison of the visualization generated between GradCam and GuidedGradCam
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Ashutosh Hathidara
💻 🎨 🔬 🚧 ✅ ⚠️
Lalit Pandey
🔬 📖
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## References
- [Grad-CAM: Visual Explanations from Deep Networks via Gradient-based Localization](https://arxiv.org/pdf/1610.02391.pdf)
- [Grad CAM demonstrations in PyTorch](https://github.com/kazuto1011/grad-cam-pytorch)