Update README.md
Browse files
README.md
CHANGED
|
@@ -12,13 +12,11 @@ license: apache-2.0
|
|
| 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:
|
|
@@ -69,4 +67,9 @@ KB-VQA
|
|
| 69 |
├── app.py: main entry point for streamlit - first page in the streamlit app)
|
| 70 |
├── README.md (readme - this file)
|
| 71 |
├── requirements.txt: Requirements file for the whole project that includes all the requirements for running the demo app on the HuggingFace space environment.
|
| 72 |
-
</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
|
| 13 |
|
| 14 |
# Demonstration Environment
|
|
|
|
| 15 |
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).
|
| 16 |
|
| 17 |
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.
|
| 18 |
|
| 19 |
## Project File Structure
|
|
|
|
| 20 |
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.
|
| 21 |
|
| 22 |
Below is the overall file structure of the project:
|
|
|
|
| 67 |
├── app.py: main entry point for streamlit - first page in the streamlit app)
|
| 68 |
├── README.md (readme - this file)
|
| 69 |
├── requirements.txt: Requirements file for the whole project that includes all the requirements for running the demo app on the HuggingFace space environment.
|
| 70 |
+
</pre>
|
| 71 |
+
|
| 72 |
+
|
| 73 |
+
|
| 74 |
+
Author: [Mohammed Bin Ali Alhaj](https://www.linkedin.com/in/m7mdal7aj)
|
| 75 |
+
E-mail: [email protected]
|