Update README.md
Browse files
README.md
CHANGED
|
@@ -11,8 +11,18 @@ license: apache-2.0
|
|
| 11 |
---
|
| 12 |
|
| 13 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 14 |
## Project File Structure
|
| 15 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
<pre>
|
| 17 |
KB-VQA
|
| 18 |
├── Files: Various files required for the demo such as samples images, dissertation report ..etc.
|
|
|
|
| 11 |
---
|
| 12 |
|
| 13 |
|
| 14 |
+
# Demonstration Environment
|
| 15 |
+
|
| 16 |
+
The project demo app can be accessed from the developed [HF Space](https://huggingface.co/spaces/m7mdal7aj/KB-VQA), and the entire code can be accessed from [here](https://huggingface.co/spaces/m7mdal7aj/KB-VQA/tree/main).
|
| 17 |
+
|
| 18 |
+
To run the demo app locally, from the root of the local code repository run `streamlit run app.py`. This will run the whole app. However, to run the `Run Inference Tool`, a GPU is required.
|
| 19 |
+
|
| 20 |
## Project File Structure
|
| 21 |
|
| 22 |
+
Each main python module of the project is extensively documented to guide the reader on how to use each module and its correcponding classes and functions.
|
| 23 |
+
|
| 24 |
+
Below is the overall file structure of the project:
|
| 25 |
+
|
| 26 |
<pre>
|
| 27 |
KB-VQA
|
| 28 |
├── Files: Various files required for the demo such as samples images, dissertation report ..etc.
|