Spaces:
Running on CPU Upgrade
Running on CPU Upgrade
requirements
Browse files- README copy.md +0 -80
- README.md +75 -7
- backend/requirements.txt β requirements.txt +0 -0
README copy.md
DELETED
|
@@ -1,80 +0,0 @@
|
|
| 1 |
-
---
|
| 2 |
-
title: Qimma Leaderboard
|
| 3 |
-
emoji: π
|
| 4 |
-
colorFrom: blue
|
| 5 |
-
colorTo: green
|
| 6 |
-
sdk: docker
|
| 7 |
-
pinned: false
|
| 8 |
-
short_description: Qimma leaderboard
|
| 9 |
-
---
|
| 10 |
-
|
| 11 |
-
# Qimma Leaderboard
|
| 12 |
-
|
| 13 |
-
The Qimma Leaderboard is an open evaluation platform for Arabic Large Language Models (LLMs). It tracks the performance of various models across a suite of Arabic benchmarks.
|
| 14 |
-
|
| 15 |
-
## π Features
|
| 16 |
-
|
| 17 |
-
* **Leaderboard**: Real-time ranking of models based on their performance on multiple datasets (AlGhafa, ArabicMMLU, EXAMS, etc.).
|
| 18 |
-
* **Submission System**: Allows users to submit their models for evaluation.
|
| 19 |
-
* **Queue Status**: Displays the current status of submitted models (Pending, Running, Finished, Failed).
|
| 20 |
-
* **Automated Updates**: The system automatically fetches new results and updates the leaderboard.
|
| 21 |
-
|
| 22 |
-
## π οΈ Installation & Setup
|
| 23 |
-
|
| 24 |
-
To run the leaderboard locally:
|
| 25 |
-
|
| 26 |
-
1. **Clone the repository:**
|
| 27 |
-
```bash
|
| 28 |
-
git clone https://huggingface.co/spaces/qimma/Qimma-Leaderboard
|
| 29 |
-
cd Qimma-Leaderboard
|
| 30 |
-
```
|
| 31 |
-
|
| 32 |
-
2. **Install dependencies:**
|
| 33 |
-
```bash
|
| 34 |
-
pip install -r requirements.txt
|
| 35 |
-
```
|
| 36 |
-
|
| 37 |
-
3. **Set up Environment Variables:**
|
| 38 |
-
You need a Hugging Face API token to access the datasets. Set the `HF_API_TOKEN` environment variable.
|
| 39 |
-
```bash
|
| 40 |
-
export HF_API_TOKEN="your_token_here"
|
| 41 |
-
```
|
| 42 |
-
|
| 43 |
-
4. **Run the application:**
|
| 44 |
-
```bash
|
| 45 |
-
python app.py
|
| 46 |
-
```
|
| 47 |
-
The app will be available at `http://localhost:7860`.
|
| 48 |
-
|
| 49 |
-
## π Code Structure
|
| 50 |
-
|
| 51 |
-
The repository is organized into a frontend-backend architecture using FastAPI.
|
| 52 |
-
|
| 53 |
-
### Backend (`/backend`)
|
| 54 |
-
Handles data processing, API endpoints, and interaction with the Hugging Face Hub.
|
| 55 |
-
|
| 56 |
-
* **`app.py`**: The main entry point. Initializes the FastAPI app, sets up routes, and manages background tasks for data synchronization.
|
| 57 |
-
* **`backend/config.py`**: Configuration settings, including repository IDs and the list of evaluation tasks (`TASKS`).
|
| 58 |
-
* **`backend/data_loader.py`**: Responsible for downloading dataset snapshots and loading leaderboard/queue data from the Hugging Face Hub.
|
| 59 |
-
* **`backend/submission_handler.py`**: Logic for processing model submissions and validating input.
|
| 60 |
-
* **`backend/helpers.py`**: Utility functions for data manipulation.
|
| 61 |
-
|
| 62 |
-
### Frontend (`/frontend`)
|
| 63 |
-
Contains the HTML templates served by the application.
|
| 64 |
-
|
| 65 |
-
* **`index.html`**: The landing page displaying the main leaderboard.
|
| 66 |
-
* **`leaderboard.html`**: The table component for displaying model rankings.
|
| 67 |
-
* **`submit.html`**: The form for users to submit new models.
|
| 68 |
-
* **`about.html`**: Information about the project and methodology.
|
| 69 |
-
* **`header.html`**: Common header component used across pages.
|
| 70 |
-
|
| 71 |
-
## βοΈ Configuration
|
| 72 |
-
|
| 73 |
-
The evaluation tasks and model types are defined in `backend/config.py`. You can modify the `TASKS` list to add or remove benchmarks.
|
| 74 |
-
|
| 75 |
-
```python
|
| 76 |
-
TASKS = [
|
| 77 |
-
("community|alghafa:_average|0", "acc_norm", "AlGhafa"),
|
| 78 |
-
# ...
|
| 79 |
-
]
|
| 80 |
-
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
README.md
CHANGED
|
@@ -1,12 +1,80 @@
|
|
| 1 |
---
|
| 2 |
-
title: Leaderboard
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
colorTo: green
|
| 6 |
-
sdk:
|
| 7 |
-
sdk_version: 6.4.0
|
| 8 |
-
app_file: app.py
|
| 9 |
pinned: false
|
|
|
|
| 10 |
---
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Qimma Leaderboard
|
| 3 |
+
emoji: π
|
| 4 |
+
colorFrom: blue
|
| 5 |
colorTo: green
|
| 6 |
+
sdk: docker
|
|
|
|
|
|
|
| 7 |
pinned: false
|
| 8 |
+
short_description: Qimma leaderboard
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# Qimma Leaderboard
|
| 12 |
+
|
| 13 |
+
The Qimma Leaderboard is an open evaluation platform for Arabic Large Language Models (LLMs). It tracks the performance of various models across a suite of Arabic benchmarks.
|
| 14 |
+
|
| 15 |
+
## π Features
|
| 16 |
+
|
| 17 |
+
* **Leaderboard**: Real-time ranking of models based on their performance on multiple datasets (AlGhafa, ArabicMMLU, EXAMS, etc.).
|
| 18 |
+
* **Submission System**: Allows users to submit their models for evaluation.
|
| 19 |
+
* **Queue Status**: Displays the current status of submitted models (Pending, Running, Finished, Failed).
|
| 20 |
+
* **Automated Updates**: The system automatically fetches new results and updates the leaderboard.
|
| 21 |
+
|
| 22 |
+
## π οΈ Installation & Setup
|
| 23 |
+
|
| 24 |
+
To run the leaderboard locally:
|
| 25 |
+
|
| 26 |
+
1. **Clone the repository:**
|
| 27 |
+
```bash
|
| 28 |
+
git clone https://huggingface.co/spaces/qimma/Qimma-Leaderboard
|
| 29 |
+
cd Qimma-Leaderboard
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
2. **Install dependencies:**
|
| 33 |
+
```bash
|
| 34 |
+
pip install -r requirements.txt
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
3. **Set up Environment Variables:**
|
| 38 |
+
You need a Hugging Face API token to access the datasets. Set the `HF_API_TOKEN` environment variable.
|
| 39 |
+
```bash
|
| 40 |
+
export HF_API_TOKEN="your_token_here"
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
4. **Run the application:**
|
| 44 |
+
```bash
|
| 45 |
+
python app.py
|
| 46 |
+
```
|
| 47 |
+
The app will be available at `http://localhost:7860`.
|
| 48 |
+
|
| 49 |
+
## π Code Structure
|
| 50 |
+
|
| 51 |
+
The repository is organized into a frontend-backend architecture using FastAPI.
|
| 52 |
+
|
| 53 |
+
### Backend (`/backend`)
|
| 54 |
+
Handles data processing, API endpoints, and interaction with the Hugging Face Hub.
|
| 55 |
+
|
| 56 |
+
* **`app.py`**: The main entry point. Initializes the FastAPI app, sets up routes, and manages background tasks for data synchronization.
|
| 57 |
+
* **`backend/config.py`**: Configuration settings, including repository IDs and the list of evaluation tasks (`TASKS`).
|
| 58 |
+
* **`backend/data_loader.py`**: Responsible for downloading dataset snapshots and loading leaderboard/queue data from the Hugging Face Hub.
|
| 59 |
+
* **`backend/submission_handler.py`**: Logic for processing model submissions and validating input.
|
| 60 |
+
* **`backend/helpers.py`**: Utility functions for data manipulation.
|
| 61 |
+
|
| 62 |
+
### Frontend (`/frontend`)
|
| 63 |
+
Contains the HTML templates served by the application.
|
| 64 |
+
|
| 65 |
+
* **`index.html`**: The landing page displaying the main leaderboard.
|
| 66 |
+
* **`leaderboard.html`**: The table component for displaying model rankings.
|
| 67 |
+
* **`submit.html`**: The form for users to submit new models.
|
| 68 |
+
* **`about.html`**: Information about the project and methodology.
|
| 69 |
+
* **`header.html`**: Common header component used across pages.
|
| 70 |
+
|
| 71 |
+
## βοΈ Configuration
|
| 72 |
+
|
| 73 |
+
The evaluation tasks and model types are defined in `backend/config.py`. You can modify the `TASKS` list to add or remove benchmarks.
|
| 74 |
+
|
| 75 |
+
```python
|
| 76 |
+
TASKS = [
|
| 77 |
+
("community|alghafa:_average|0", "acc_norm", "AlGhafa"),
|
| 78 |
+
# ...
|
| 79 |
+
]
|
| 80 |
+
```
|
backend/requirements.txt β requirements.txt
RENAMED
|
File without changes
|