Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -9,4 +9,50 @@ app_file: app.py
|
|
| 9 |
pinned: false
|
| 10 |
---
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 9 |
pinned: false
|
| 10 |
---
|
| 11 |
|
| 12 |
+
# README
|
| 13 |
+
|
| 14 |
+
## Instructions for using d-RAGon
|
| 15 |
+
We recommend experiencing d-RAGon through the online demo hosted on huggingface at [DRAGON_innovation](https://huggingface.co/spaces/how2traindragon/DRAGON_innovation)
|
| 16 |
+
|
| 17 |
+
## Instructions for Running d-RAGon locally
|
| 18 |
+
|
| 19 |
+
Follow the instructions below to set up and run the application locally on your system.
|
| 20 |
+
|
| 21 |
+
### Prerequisites
|
| 22 |
+
|
| 23 |
+
Ensure you have Python installed on your system. You can download it from [python.org](https://www.python.org/downloads/). The version used in the online demo is 3.10.
|
| 24 |
+
|
| 25 |
+
### API keys
|
| 26 |
+
|
| 27 |
+
You would require a valid LTA DataMall API key and a valid openAI API key of your own provisioning to run the application locally.
|
| 28 |
+
LTA DataMall API key can be applied for [here](https://datamall.lta.gov.sg/content/datamall/en/request-for-api.html) and openAI API key can be generated [here](https://platform.openai.com/api-keys) (credit topup is required to utilise openAI API).
|
| 29 |
+
|
| 30 |
+
### Installation (via terminal/cmd)
|
| 31 |
+
|
| 32 |
+
1. Clone or download the repository to your local machine:
|
| 33 |
+
```
|
| 34 |
+
# Make sure you have git-lfs installed (https://git-lfs.com)
|
| 35 |
+
git lfs install
|
| 36 |
+
|
| 37 |
+
git clone https://huggingface.co/spaces/how2traindragon/DRAGON_innovation
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
2. Navigate to the project directory (~/DRAGON_innovation) and install the required dependencies:
|
| 41 |
+
```
|
| 42 |
+
pip install -r requirements.txt
|
| 43 |
+
```
|
| 44 |
+
|
| 45 |
+
3. Once the dependencies are installed, you can run the application by executing the following command:
|
| 46 |
+
```
|
| 47 |
+
python app.py
|
| 48 |
+
```
|
| 49 |
+
|
| 50 |
+
4. The application should now be up and running. You can access it by navigating to the link in your command line interface in your web browser.
|
| 51 |
+
|
| 52 |
+
### Additional Notes
|
| 53 |
+
|
| 54 |
+
- If you encounter any issues during installation or while running the application, please feel free to contact the developers for assistance.
|
| 55 |
+
|
| 56 |
+
- For more detailed information about the application and its usage, please refer to the bundled information video.
|
| 57 |
+
|
| 58 |
+
- Enjoy using the application!
|