Update README.md
Browse files
README.md
CHANGED
|
@@ -82,144 +82,6 @@ This repository provides an end-to-end evaluation pipeline for **EPIC-Bench** on
|
|
| 82 |
It includes **Dataset Conversion** utilities, **Inference Launchers**, **Response Standardization**, **Scoring**, and a Streamlit-based **Visualization** tool.
|
| 83 |
|
| 84 |
|
| 85 |
-
## 🚀 Evaluation guide
|
| 86 |
-
|
| 87 |
-
EPIC-Bench evaluation typically consists of the following stages.
|
| 88 |
-
|
| 89 |
-
### ⚙️ 0) Environment setup
|
| 90 |
-
|
| 91 |
-
Create a Python environment (example):
|
| 92 |
-
|
| 93 |
-
```bash
|
| 94 |
-
conda create -n epicbench python==3.10
|
| 95 |
-
conda activate epicbench
|
| 96 |
-
```
|
| 97 |
-
|
| 98 |
-
Suggested dependencies (reference; choose what matches your model stack):
|
| 99 |
-
|
| 100 |
-
| Model | Environment |
|
| 101 |
-
|------|-------------|
|
| 102 |
-
| General environment (compatible with Qwen2.5-VL/Qwen3-VL/InternVL/LLaVA-VL/Phi-4/gemma/RynnBrain/RoboBrain2/) | `pip install uv`<br>`uv pip install 'ms-swift' --torch-backend=auto`<br>`pip install vllm==0.15.1` |
|
| 103 |
-
| Qwen3.5 | `git clone https://github.com/vllm-project/vllm.git`<br>`cd vllm`<br>`pip install -e .`<br>`git clone https://github.com/modelscope/ms-swift.git`<br>`cd ms-swift`<br>`pip install -e .`<br>`pip install transformers==5.2.0 qwen-vl-utils` |
|
| 104 |
-
| Step models | `pip install onnxruntime-gpu tokenizers openai-whisper funasr vllm==0.15.1`<br>`git clone https://github.com/modelscope/ms-swift.git`<br>`cd ms-swift`<br>`pip install -e .` |
|
| 105 |
-
| glm4.6 | `pip install uv`<br>`uv pip install 'ms-swift' --torch-backend=auto`<br>`pip install vllm==0.15.1 transformers==5.2.0` |
|
| 106 |
-
|
| 107 |
-
For the visualization tool:
|
| 108 |
-
|
| 109 |
-
```bash
|
| 110 |
-
pip install streamlit pillow numpy pandas pycocotools
|
| 111 |
-
```
|
| 112 |
-
|
| 113 |
-
### 📦 1) Data preparation
|
| 114 |
-
|
| 115 |
-
#### 1.1 Download raw annotations
|
| 116 |
-
|
| 117 |
-
Download EPIC-Bench raw annotation data (and the referenced images) from the official release page (e.g., Hugging Face / ModelScope) and place them under:
|
| 118 |
-
|
| 119 |
-
```
|
| 120 |
-
dataset/annotation/EPIC_Bench
|
| 121 |
-
```
|
| 122 |
-
|
| 123 |
-
#### 1.2 Build ms-swift inference data (swift format)
|
| 124 |
-
|
| 125 |
-
Generate ms-swift compatible inference JSON files from raw annotations:
|
| 126 |
-
|
| 127 |
-
```bash
|
| 128 |
-
bash scripts/build_swift_data.sh \
|
| 129 |
-
ANN_ROOT=dataset/annotation/EPIC_Bench \
|
| 130 |
-
OUT_DIR=dataset/swift_data/EPIC_Bench
|
| 131 |
-
```
|
| 132 |
-
|
| 133 |
-
Outputs will be written to:
|
| 134 |
-
|
| 135 |
-
```
|
| 136 |
-
dataset/swift_data/EPIC_Bench
|
| 137 |
-
```
|
| 138 |
-
|
| 139 |
-
#### 1.3 Customize prompts (optional)
|
| 140 |
-
|
| 141 |
-
You can customize prompts and response formats in:
|
| 142 |
-
|
| 143 |
-
- `tools/data_gen/prompts/`
|
| 144 |
-
- `tools/data_gen/converters/`
|
| 145 |
-
|
| 146 |
-
For best compatibility with the scoring pipeline, we recommend starting with the default settings in this repo.
|
| 147 |
-
|
| 148 |
-
### 🤖 2) Inference
|
| 149 |
-
|
| 150 |
-
Run inference using either:
|
| 151 |
-
|
| 152 |
-
- example per-model scripts under `scripts/infer/<MODEL_FAMILY>/`, or
|
| 153 |
-
- the unified launcher `scripts/infer.sh`
|
| 154 |
-
|
| 155 |
-
Recommended (unified launcher):
|
| 156 |
-
|
| 157 |
-
```bash
|
| 158 |
-
bash scripts/infer.sh \
|
| 159 |
-
--model Qwen3_VL \
|
| 160 |
-
--data dataset/swift_data/EPIC_Bench \
|
| 161 |
-
--out outputs/model_response/swift_format
|
| 162 |
-
```
|
| 163 |
-
|
| 164 |
-
By default, raw ms-swift outputs are organized under:
|
| 165 |
-
|
| 166 |
-
```
|
| 167 |
-
outputs/model_response/swift_format/<model_series>/<model_name>.jsonl
|
| 168 |
-
```
|
| 169 |
-
|
| 170 |
-
Closed-source / API inference (optional):
|
| 171 |
-
|
| 172 |
-
- `scripts/infer/api/` contains an example script for `lmms-eval`.
|
| 173 |
-
- You must configure API keys via environment variables and **must not commit credentials** to GitHub.
|
| 174 |
-
|
| 175 |
-
### 🔄 3) Standardize responses (std_format)
|
| 176 |
-
|
| 177 |
-
Convert raw ms-swift outputs into EPIC-Bench **standard format** while preserving directory structure:
|
| 178 |
-
|
| 179 |
-
```bash
|
| 180 |
-
bash scripts/format_response.sh \
|
| 181 |
-
--in outputs/model_response/swift_format \
|
| 182 |
-
--out outputs/model_response/std_format
|
| 183 |
-
```
|
| 184 |
-
|
| 185 |
-
If you evaluate a custom model/framework outside this repo, please ensure your outputs follow the **same std-format schema produced by** `tools/formatting/format_response.py`.
|
| 186 |
-
|
| 187 |
-
### 📊 4) Scoring
|
| 188 |
-
|
| 189 |
-
After obtaining standardized responses, compute detailed scores:
|
| 190 |
-
|
| 191 |
-
```bash
|
| 192 |
-
bash scripts/evaluate.sh \
|
| 193 |
-
--in outputs/model_response/std_format \
|
| 194 |
-
--out outputs/scores
|
| 195 |
-
```
|
| 196 |
-
|
| 197 |
-
The scorer produces:
|
| 198 |
-
|
| 199 |
-
- overall / category / type breakdowns
|
| 200 |
-
- per-sample details (unless you pass `--no-details`)
|
| 201 |
-
|
| 202 |
-
Supported formats:
|
| 203 |
-
|
| 204 |
-
- **bbox** (most tasks)
|
| 205 |
-
- **point** (FeasiblePath tasks)
|
| 206 |
-
|
| 207 |
-
Mask-based evaluation is planned (releasing soon).
|
| 208 |
-
|
| 209 |
-
|
| 210 |
-
```bash
|
| 211 |
-
bash scripts/evaluate.sh
|
| 212 |
-
```
|
| 213 |
-
|
| 214 |
-
### 📈 5) Visualization
|
| 215 |
-
|
| 216 |
-
Launch the Streamlit visualization tool and default-load results from `outputs/scores`:
|
| 217 |
-
|
| 218 |
-
```bash
|
| 219 |
-
bash scripts/visualization.sh
|
| 220 |
-
```
|
| 221 |
-
|
| 222 |
-
|
| 223 |
## 🏆 Leaderboard and data examples
|
| 224 |
|
| 225 |
Please refer to the [EPIC-Bench Homepage](https://epic-bench.github.io/EPIC-Bench/) for:
|
|
|
|
| 82 |
It includes **Dataset Conversion** utilities, **Inference Launchers**, **Response Standardization**, **Scoring**, and a Streamlit-based **Visualization** tool.
|
| 83 |
|
| 84 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 85 |
## 🏆 Leaderboard and data examples
|
| 86 |
|
| 87 |
Please refer to the [EPIC-Bench Homepage](https://epic-bench.github.io/EPIC-Bench/) for:
|