Skip to content

Commit bb5854a

Browse files
committed
updating readme
1 parent 426d90a commit bb5854a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,13 @@ To execute tests and evaluate models, run the following command:
7474
python sources/execute_tests.py
7575
```
7676

77+
78+
To visualize the results, run the dashboard using the following command:
79+
```bash
80+
python sources/dashboard/app.py
81+
```
82+
Note: Run the command from the root repository folder.
83+
7784
Refer to the documentation in the sources/ directory for more detailed usage instructions.
7885

7986

@@ -94,6 +101,10 @@ BreakYourLLM/
94101
│ ├── metrics/ # Metrics calculation modules
95102
│ ├── models/ # Model-related modules
96103
│ └── views/ # Result visualization modules
104+
│ └── dashboard/ # Dashboard for visualizing results
105+
│ ├── app.py # Main application file
106+
│ ├── components/ # Components for the dashboard
107+
│ └── callbacks/ # Callbacks for the dashboard
97108
98109
└── requirements.txt # Project dependencies
99110
```
@@ -107,3 +118,5 @@ We welcome contributions! Please follow these steps:
107118
3. Make your changes and commit them (git commit -m 'Add some feature').
108119
4. Push to the branch (git push origin feature/YourFeature).
109120
5. Open a pull request.
121+
122+

0 commit comments

Comments
 (0)