Update README.md
Browse files
README.md
CHANGED
|
@@ -1,4 +1,3 @@
|
|
| 1 |
-
---
|
| 2 |
license: cc-by-nc-sa-4.0
|
| 3 |
language:
|
| 4 |
- en
|
|
@@ -15,136 +14,29 @@ tags:
|
|
| 15 |
- audio-comprehension
|
| 16 |
- benchmark
|
| 17 |
- audio-question-answering
|
| 18 |
-
|
| 19 |
-
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
-
|
| 43 |
-
|
| 44 |
-
audio.
|
| 45 |
-
|
| 46 |
-
Each path is scored in its own mode:
|
| 47 |
-
|
| 48 |
-
- **Accuracy**: multiple choice questions on native audio, scored by exact
|
| 49 |
-
match.
|
| 50 |
-
- **Rubric**: open-ended questions on native audio, graded by rubric-based
|
| 51 |
-
LLM judges against criteria.
|
| 52 |
-
- **Chain**: multiple-choice question chains on anchor audio; an answer is
|
| 53 |
-
credited only up to the first error in the chain.
|
| 54 |
-
|
| 55 |
-
## Quick Start
|
| 56 |
-
|
| 57 |
-
Download the release (~18 GB) and work from its root:
|
| 58 |
-
|
| 59 |
-
```bash
|
| 60 |
-
pip install -U huggingface_hub
|
| 61 |
-
hf download holvan/AudioSpan --repo-type dataset --local-dir AudioSpan
|
| 62 |
-
cd AudioSpan
|
| 63 |
-
```
|
| 64 |
-
|
| 65 |
-
### 1. Prepare Audio Data
|
| 66 |
-
|
| 67 |
-
Native recordings and sound events ship as tar archives
|
| 68 |
-
(`audio/audio_native.part*.tar`, `audio/audio_events.tar`; the native parts
|
| 69 |
-
are concatenated automatically). From the release root (the directory with
|
| 70 |
-
`prepare/` and `audio/`), verify them against `audio/CHECKSUMS.sha256` and
|
| 71 |
-
unpack into `audio/`:
|
| 72 |
-
|
| 73 |
-
```bash
|
| 74 |
-
# accuracy / rubric: native recordings only
|
| 75 |
-
python prepare/unpack_audio.py --buckets native
|
| 76 |
-
# -> audio/native/*.flac
|
| 77 |
-
|
| 78 |
-
# chain: also rebuild the anchor audio from the native recordings and the
|
| 79 |
-
# exact edit recipes in metadata/media/anchor/anchor_manifest.jsonl
|
| 80 |
-
# (needs only ffmpeg)
|
| 81 |
-
python prepare/unpack_audio.py --buckets native,events
|
| 82 |
-
python prepare/prepare_anchor.py
|
| 83 |
-
# -> audio/anchor/*.flac
|
| 84 |
-
```
|
| 85 |
-
|
| 86 |
-
(`unpack_audio.py` resolves the release root from its own location; pass
|
| 87 |
-
`--root` if you run it from elsewhere.)
|
| 88 |
-
|
| 89 |
-
### 2. Prepare Inference Results
|
| 90 |
-
|
| 91 |
-
The questions live in `metadata/{accuracy,rubric,chain}/{S,M,L}.jsonl`; each
|
| 92 |
-
record carries the question, its `audio_path`, and (for multiple choice) the
|
| 93 |
-
four options. Run your model over each record and write one answer per
|
| 94 |
-
question — only `qa_id` and the model's output; ground truth stays in the
|
| 95 |
-
metadata and is joined in by the scorer:
|
| 96 |
-
|
| 97 |
-
**accuracy / chain** (multiple choice):
|
| 98 |
-
|
| 99 |
-
```json
|
| 100 |
-
{"qa_id": "S_EN_001_P", "answer": "D"}
|
| 101 |
-
```
|
| 102 |
-
|
| 103 |
-
**rubric** (open-ended):
|
| 104 |
-
|
| 105 |
-
```json
|
| 106 |
-
{"qa_id": "S_EN_001_P", "answer": "The narrator first says HDR at about 06:04 ..."}
|
| 107 |
-
```
|
| 108 |
-
|
| 109 |
-
- `answer` — the model's raw output; for multiple choice the scorer
|
| 110 |
-
extracts the option letter (A/B/C/D) from it.
|
| 111 |
-
- Questions missing from your file count as wrong (or score zero).
|
| 112 |
-
|
| 113 |
-
### 3. Run Evaluation
|
| 114 |
-
|
| 115 |
-
```bash
|
| 116 |
-
# accuracy + chain: stdlib-only, no dependencies
|
| 117 |
-
python evaluate/score.py --mode accuracy --input your_accuracy.jsonl
|
| 118 |
-
python evaluate/score.py --mode chain --input your_chain.jsonl
|
| 119 |
-
|
| 120 |
-
# rubric: needs an LLM judge (default: gpt-5.4-2026-03-05; API key from the
|
| 121 |
-
# matching provider env var, e.g. OPENAI_API_KEY; or pass --api-base/--api-key)
|
| 122 |
-
pip install openai tenacity
|
| 123 |
-
export OPENAI_API_KEY="your-api-key-here"
|
| 124 |
-
python evaluate/score_rubric.py --input your_rubric.jsonl
|
| 125 |
-
```
|
| 126 |
-
|
| 127 |
-
Both scorers join your answers against the ground truth in `metadata/` by
|
| 128 |
-
`qa_id` — no reference answers needed in your submission.
|
| 129 |
-
|
| 130 |
-
## License and Data Use
|
| 131 |
-
|
| 132 |
-
AudioSpan is released for **non-commercial research and evaluation**. Our
|
| 133 |
-
artifacts (QA items, rubric criteria, anchor manifests, sound events, and
|
| 134 |
-
evaluation scripts) are under CC BY-NC-SA 4.0; copyright of the source
|
| 135 |
-
recordings remains with their original creators. The recordings are
|
| 136 |
-
included only for evaluation, and downloading the dataset constitutes
|
| 137 |
-
agreement not to redistribute the audio or use it in commercial products.
|
| 138 |
-
|
| 139 |
-
## Citation
|
| 140 |
-
|
| 141 |
-
If you find AudioSpan useful for your research, please consider citing:
|
| 142 |
-
|
| 143 |
-
```bibtex
|
| 144 |
-
@article{huang2026audiospan,
|
| 145 |
-
title = {AudioSpan: Spanning the Duration and Depth of Audio Comprehension},
|
| 146 |
-
author = {Huang, Wen and Chu, Yunfei and Gao, Meng and He, Haolin and Xu, Jin},
|
| 147 |
-
journal = {arXiv preprint arXiv:ARXIV_ID},
|
| 148 |
-
year = {2026}
|
| 149 |
-
}
|
| 150 |
-
```
|
|
|
|
|
|
|
| 1 |
license: cc-by-nc-sa-4.0
|
| 2 |
language:
|
| 3 |
- en
|
|
|
|
| 14 |
- audio-comprehension
|
| 15 |
- benchmark
|
| 16 |
- audio-question-answering
|
| 17 |
+
configs:
|
| 18 |
+
- config_name: accuracy
|
| 19 |
+
default: true
|
| 20 |
+
data_files:
|
| 21 |
+
- split: S
|
| 22 |
+
path: metadata/accuracy/S.jsonl
|
| 23 |
+
- split: M
|
| 24 |
+
path: metadata/accuracy/M.jsonl
|
| 25 |
+
- split: L
|
| 26 |
+
path: metadata/accuracy/L.jsonl
|
| 27 |
+
- config_name: rubric
|
| 28 |
+
data_files:
|
| 29 |
+
- split: S
|
| 30 |
+
path: metadata/rubric/S.jsonl
|
| 31 |
+
- split: M
|
| 32 |
+
path: metadata/rubric/M.jsonl
|
| 33 |
+
- split: L
|
| 34 |
+
path: metadata/rubric/L.jsonl
|
| 35 |
+
- config_name: chain
|
| 36 |
+
data_files:
|
| 37 |
+
- split: S
|
| 38 |
+
path: metadata/chain/S.jsonl
|
| 39 |
+
- split: M
|
| 40 |
+
path: metadata/chain/M.jsonl
|
| 41 |
+
- split: L
|
| 42 |
+
path: metadata/chain/L.jsonl
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|