Spaces:
Runtime error
Runtime error
Added snapshot, development, license to README
Browse files
README.md
CHANGED
@@ -11,3 +11,34 @@ app_file: app.py
|
|
11 |
---
|
12 |
|
13 |
# vit-explainer
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
11 |
---
|
12 |
|
13 |
# vit-explainer
|
14 |
+
|
15 |
+
[![license](https://img.shields.io/github/license/DAVFoundation/captain-n3m0.svg?style=flat-square)](https://github.com/raidionics/AeroPath/blob/main/LICENSE.md)
|
16 |
+
[![CI/CD](https://github.com/andreped/vit-explainer/actions/workflows/deploy.yml/badge.svg)](https://github.com/andreped/vit-explainer/actions/workflows/deploy.yml)
|
17 |
+
<a target="_blank" href="https://huggingface.co/spaces/andreped/vit-explainer"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
|
18 |
+
|
19 |
+
This web app was developed to test and demonstrate an explainable AI (XAI)-based technique with a pretrained vision transformer (ViT).
|
20 |
+
|
21 |
+
The app is deployed on Hugging Face and can be access by clicking the 🤗 badge above.
|
22 |
+
|
23 |
+
## Demo
|
24 |
+
|
25 |
+
<img width="1283" alt="Screenshot 2023-11-12 at 23 48 54" src="https://github.com/andreped/vit-explainer/assets/29090665/1fe47bb5-625d-4717-9348-53930d5129dc">
|
26 |
+
|
27 |
+
## Development
|
28 |
+
|
29 |
+
To run the app locally, you run the following in the terminal:
|
30 |
+
|
31 |
+
```
|
32 |
+
git clone "https://github.com/andreped/vit-explainer.git"
|
33 |
+
cd "vit-explainer/"
|
34 |
+
|
35 |
+
virtualenv -ppython3 venv --clear
|
36 |
+
source venv/bin/activate
|
37 |
+
pip install -r requirements.txt
|
38 |
+
|
39 |
+
python app.py
|
40 |
+
```
|
41 |
+
|
42 |
+
## License
|
43 |
+
|
44 |
+
The code in this repository is released under [MIT license](https://github.com/andreped/vit-explainer/blob/main/LICENSE.md).
|