Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -9,24 +9,23 @@ To run this CLI tool locally, follow these steps to set up your environment:
|
|
| 9 |
|
| 10 |
1. Activate the Virtual Environment.
|
| 11 |
|
| 12 |
-
|
| 13 |
-
|
| 14 |
|
| 15 |
2. Install Requirements
|
| 16 |
-
|
| 17 |
|
| 18 |
-
>
|
| 19 |
|
| 20 |
3. Configure Environment Variable (.env)
|
| 21 |
|
| 22 |
-
|
| 23 |
|
| 24 |
-
|
| 25 |
|
| 26 |
-
|
| 27 |
|
| 28 |
-
|
| 29 |
-
HF_TOKEN=your_hugging_face_read_token_here
|
| 30 |
|
| 31 |
## Usage Guide
|
| 32 |
|
|
@@ -34,11 +33,11 @@ Once your environment is set up and your token is configured, you can run the CL
|
|
| 34 |
|
| 35 |
1. Navigate to the Backend Directory
|
| 36 |
|
| 37 |
-
>
|
| 38 |
|
| 39 |
2. Launch the Application
|
| 40 |
|
| 41 |
-
>
|
| 42 |
|
| 43 |
3. Interacting with the CLI Menu Upon running the command, you will be presented with a main menu. Choose the number corresponding to your desired action:
|
| 44 |
|
|
@@ -50,11 +49,11 @@ Once your environment is set up and your token is configured, you can run the CL
|
|
| 50 |
|
| 51 |
4. Model Selection & Batch Testing
|
| 52 |
|
| 53 |
-
After selecting either option 1 or 2, the CLI will display a list of available NL2SQL models.
|
| 54 |
|
| 55 |
-
Enter the number/name of the model you wish to test.
|
| 56 |
|
| 57 |
-
Automatic Execution: Once a model is selected, the system will automatically begin running the batch test against the scenarios defined in scripts/test_cases.json. Sit back and wait for the reports to generate in your root folder!
|
| 58 |
|
| 59 |
## 🚧 Roadmap
|
| 60 |
- Development and integration of a graphical User Interface (Frontend).
|
|
|
|
| 9 |
|
| 10 |
1. Activate the Virtual Environment.
|
| 11 |
|
| 12 |
+
- **Windows**: venv\Scripts\Activate
|
| 13 |
+
- **macOS/Linux**: source venv/bin/activate
|
| 14 |
|
| 15 |
2. Install Requirements
|
| 16 |
+
- Ensure a *requirements.txt* file exists in your project backend folder.
|
| 17 |
|
| 18 |
+
> pip install -r requirements.txt
|
| 19 |
|
| 20 |
3. Configure Environment Variable (.env)
|
| 21 |
|
| 22 |
+
**Note:** Users must generate your own free access token from your https://huggingface.co/settings/tokens to avoid rate limits.
|
| 23 |
|
| 24 |
+
- Create a *.env* file in the *backend/* directory
|
| 25 |
|
| 26 |
+
- Add your Hugging Face *Read* Token to the file.
|
| 27 |
|
| 28 |
+
> HF_TOKEN=your_hugging_face_read_token_here
|
|
|
|
| 29 |
|
| 30 |
## Usage Guide
|
| 31 |
|
|
|
|
| 33 |
|
| 34 |
1. Navigate to the Backend Directory
|
| 35 |
|
| 36 |
+
> cd backend
|
| 37 |
|
| 38 |
2. Launch the Application
|
| 39 |
|
| 40 |
+
> python -m app.main
|
| 41 |
|
| 42 |
3. Interacting with the CLI Menu Upon running the command, you will be presented with a main menu. Choose the number corresponding to your desired action:
|
| 43 |
|
|
|
|
| 49 |
|
| 50 |
4. Model Selection & Batch Testing
|
| 51 |
|
| 52 |
+
1. After selecting either option 1 or 2, the CLI will display a list of available NL2SQL models.
|
| 53 |
|
| 54 |
+
2. Enter the number/name of the model you wish to test.
|
| 55 |
|
| 56 |
+
3. Automatic Execution: Once a model is selected, the system will automatically begin running the batch test against the scenarios defined in scripts/test_cases.json. Sit back and wait for the reports to generate in your root folder!
|
| 57 |
|
| 58 |
## 🚧 Roadmap
|
| 59 |
- Development and integration of a graphical User Interface (Frontend).
|