Datasets:
feat: migrate submission format to v4 pointer style
Browse files- Remove submissions/scores/ (scores now live in submitter model repos
under .eval_results/<dataset-org>/<dataset-name>/scores.txt)
- Rewrite submissions/README.md with HF CLI submitter flow
- Rewrite submissions/results_template.yaml with v4 schema:
schema_version=4, artifact.scores_url + scores_sha256, system.paper
as a structured block
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- submissions/README.md +57 -53
- submissions/results_template.yaml +12 -5
- submissions/scores/.gitkeep +0 -0
submissions/README.md
CHANGED
|
@@ -1,77 +1,81 @@
|
|
| 1 |
# Benchmark Submissions
|
| 2 |
|
| 3 |
-
To submit a result,
|
| 4 |
|
| 5 |
-
|
|
|
|
| 6 |
|
| 7 |
-
|
| 8 |
|
| 9 |
-
##
|
| 10 |
|
| 11 |
-
``
|
| 12 |
-
schema_version: 1
|
| 13 |
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
checkpoint: https://huggingface.co/...
|
| 20 |
-
description: Reference AASIST, default config.
|
| 21 |
|
| 22 |
-
|
| 23 |
-
id: SpeechAntiSpoofingBenchmarks/ASVspoof2019_LA
|
| 24 |
-
revision: <git-revision-sha>
|
| 25 |
-
split: test
|
| 26 |
|
| 27 |
-
scores
|
| 28 |
-
eer_percent: 0.83
|
| 29 |
-
n_trials: 71237
|
| 30 |
-
n_skipped: 0
|
| 31 |
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
|
|
|
|
|
|
|
|
|
| 36 |
|
| 37 |
-
|
| 38 |
-
reproduced_by: SpeechAntiSpoofingBenchmarks
|
| 39 |
-
reproduced_at: 2026-05-20
|
| 40 |
-
reproduced_bench_version: speech-spoof-bench==0.3.1
|
| 41 |
-
match: scoring
|
| 42 |
|
| 43 |
-
|
| 44 |
-
hf_username: <your-hf-username>
|
| 45 |
-
contact: <your-email>
|
| 46 |
|
| 47 |
-
|
| 48 |
-
notes: "Description of your system configuration."
|
| 49 |
-
```
|
| 50 |
|
| 51 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 52 |
|
| 53 |
-
|
| 54 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 55 |
```
|
| 56 |
-
LA_E_2834763 -1.234
|
| 57 |
-
LA_E_1665632 2.871
|
| 58 |
-
```
|
| 59 |
|
| 60 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
|
| 62 |
-
|
| 63 |
|
| 64 |
-
|
| 65 |
|
| 66 |
-
|
| 67 |
-
|
|
|
|
|
|
|
| 68 |
|
| 69 |
-
Submissions without a `reproduction:` block
|
| 70 |
|
| 71 |
-
##
|
| 72 |
|
| 73 |
-
|
| 74 |
-
2. Generate `scores/<system-slug>.txt` (one score per utterance, higher = more bonafide).
|
| 75 |
-
3. Copy `results_template.yaml` to `<system-slug>.yaml` and fill in all fields.
|
| 76 |
-
4. Compute the SHA-256 of your scores file: `sha256sum scores/<system-slug>.txt`.
|
| 77 |
-
5. Open a pull request with both files.
|
|
|
|
| 1 |
# Benchmark Submissions
|
| 2 |
|
| 3 |
+
To submit a result, you'll upload two files (no git clone required):
|
| 4 |
|
| 5 |
+
1. **`scores.txt`** to **your own HF model repo** under `.eval_results/SpeechAntiSpoofingBenchmarks/ASVspoof2019_LA/scores.txt`.
|
| 6 |
+
2. **`<your-slug>.yaml`** as a pull request to **this dataset repo** under `submissions/<your-slug>.yaml`.
|
| 7 |
|
| 8 |
+
The YAML in this repo carries a pinned URL pointing at your `scores.txt`, plus its sha256. Scores files do not live in this repo.
|
| 9 |
|
| 10 |
+
## Submitter workflow
|
| 11 |
|
| 12 |
+
### 1. Generate `scores.txt` locally
|
|
|
|
| 13 |
|
| 14 |
+
```bash
|
| 15 |
+
speech-spoof-bench run \
|
| 16 |
+
--model-module <your_package>:<YourModelClass> \
|
| 17 |
+
--datasets SpeechAntiSpoofingBenchmarks/ASVspoof2019_LA
|
| 18 |
+
```
|
|
|
|
|
|
|
| 19 |
|
| 20 |
+
Output: `results/ASVspoof2019_LA/scores.txt` (one line per utterance, `<utterance_id> <score>`, higher = more bonafide).
|
|
|
|
|
|
|
|
|
|
| 21 |
|
| 22 |
+
### 2. Upload `scores.txt` to your model repo
|
|
|
|
|
|
|
|
|
|
| 23 |
|
| 24 |
+
```bash
|
| 25 |
+
huggingface-cli upload <your-owner>/<your-model-repo> \
|
| 26 |
+
results/ASVspoof2019_LA/scores.txt \
|
| 27 |
+
.eval_results/SpeechAntiSpoofingBenchmarks/ASVspoof2019_LA/scores.txt \
|
| 28 |
+
--repo-type=model \
|
| 29 |
+
--commit-message="Add ASVspoof2019_LA scores"
|
| 30 |
+
```
|
| 31 |
|
| 32 |
+
**Note the commit sha** the CLI prints — you'll need it in the next step.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
|
| 34 |
+
### 3. Fill in the submission YAML
|
|
|
|
|
|
|
| 35 |
|
| 36 |
+
Copy `results_template.yaml` to `<your-slug>.yaml` and fill in every field. The two most important fields:
|
|
|
|
|
|
|
| 37 |
|
| 38 |
+
- `artifact.scores_url`: the **pinned** URL to your uploaded scores file. Use the commit sha from step 2, not `main`:
|
| 39 |
+
```
|
| 40 |
+
https://huggingface.co/<your-owner>/<your-model-repo>/resolve/<commit-sha-from-step-2>/.eval_results/SpeechAntiSpoofingBenchmarks/ASVspoof2019_LA/scores.txt
|
| 41 |
+
```
|
| 42 |
+
URLs with `/resolve/main/` are rejected because they're mutable.
|
| 43 |
+
- `artifact.scores_sha256`: `sha256sum results/ASVspoof2019_LA/scores.txt | awk '{print $1}'`.
|
| 44 |
|
| 45 |
+
Leave the `reproduction:` block empty — the maintainer fills it in at merge time.
|
| 46 |
|
| 47 |
+
### 4. Open the PR via HF CLI
|
| 48 |
+
|
| 49 |
+
```bash
|
| 50 |
+
huggingface-cli upload \
|
| 51 |
+
SpeechAntiSpoofingBenchmarks/ASVspoof2019_LA \
|
| 52 |
+
<your-slug>.yaml submissions/<your-slug>.yaml \
|
| 53 |
+
--repo-type=dataset \
|
| 54 |
+
--create-pr \
|
| 55 |
+
--commit-message="Add <your-slug> submission"
|
| 56 |
```
|
|
|
|
|
|
|
|
|
|
| 57 |
|
| 58 |
+
The CLI prints a PR URL. That's it.
|
| 59 |
+
|
| 60 |
+
### 5. Wait for maintainer reproduction
|
| 61 |
+
|
| 62 |
+
A maintainer runs `speech-spoof-bench reproduce --scoring <PR-branch>`, which:
|
| 63 |
+
- Fetches `scores_url`.
|
| 64 |
+
- Verifies the sha256 against `artifact.scores_sha256`.
|
| 65 |
+
- Recomputes EER from the file.
|
| 66 |
+
- Compares to your claimed `scores.eer_percent` (must match within 1e-6).
|
| 67 |
|
| 68 |
+
If it passes, the maintainer fills in `reproduction:` and merges. If it fails, you get a comment on the PR explaining why.
|
| 69 |
|
| 70 |
+
## Verification levels
|
| 71 |
|
| 72 |
+
| Level | What the maintainer checks | Cost |
|
| 73 |
+
|---|---|---|
|
| 74 |
+
| `scoring` (default) | sha + recomputed EER from your `scores.txt`. | Seconds. |
|
| 75 |
+
| `inference` (optional, follow-up) | Re-runs your checkpoint end-to-end and regenerates `scores.txt`. Must match within 0.05% EER. | Expensive. |
|
| 76 |
|
| 77 |
+
Submissions without a `reproduction:` block never appear in the arena.
|
| 78 |
|
| 79 |
+
## What about git clone + push?
|
| 80 |
|
| 81 |
+
You can do it that way too, but for a single 2 KB YAML it's massively heavier. The HF CLI path is the documented one.
|
|
|
|
|
|
|
|
|
|
|
|
submissions/results_template.yaml
CHANGED
|
@@ -1,12 +1,16 @@
|
|
| 1 |
-
schema_version:
|
| 2 |
|
| 3 |
system:
|
| 4 |
name: ""
|
| 5 |
slug: ""
|
| 6 |
-
|
| 7 |
code: ""
|
| 8 |
checkpoint: ""
|
| 9 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
|
| 11 |
dataset:
|
| 12 |
id: SpeechAntiSpoofingBenchmarks/ASVspoof2019_LA
|
|
@@ -19,15 +23,18 @@ scores:
|
|
| 19 |
n_skipped: 0
|
| 20 |
|
| 21 |
artifact:
|
| 22 |
-
|
|
|
|
|
|
|
| 23 |
scores_sha256: ""
|
| 24 |
bench_version: ""
|
| 25 |
|
|
|
|
| 26 |
reproduction:
|
| 27 |
reproduced_by: ""
|
| 28 |
reproduced_at: ""
|
| 29 |
reproduced_bench_version: ""
|
| 30 |
-
match:
|
| 31 |
|
| 32 |
submitter:
|
| 33 |
hf_username: ""
|
|
|
|
| 1 |
+
schema_version: 4
|
| 2 |
|
| 3 |
system:
|
| 4 |
name: ""
|
| 5 |
slug: ""
|
| 6 |
+
description: ""
|
| 7 |
code: ""
|
| 8 |
checkpoint: ""
|
| 9 |
+
paper:
|
| 10 |
+
arxiv_id: ""
|
| 11 |
+
url: ""
|
| 12 |
+
bibtex: |
|
| 13 |
+
@article{...}
|
| 14 |
|
| 15 |
dataset:
|
| 16 |
id: SpeechAntiSpoofingBenchmarks/ASVspoof2019_LA
|
|
|
|
| 23 |
n_skipped: 0
|
| 24 |
|
| 25 |
artifact:
|
| 26 |
+
# Must be pinned by commit sha. Pattern:
|
| 27 |
+
# https://huggingface.co/<owner>/<repo>/resolve/<commit-sha>/.eval_results/SpeechAntiSpoofingBenchmarks/ASVspoof2019_LA/scores.txt
|
| 28 |
+
scores_url: ""
|
| 29 |
scores_sha256: ""
|
| 30 |
bench_version: ""
|
| 31 |
|
| 32 |
+
# Leave this block empty — the maintainer fills it in at merge.
|
| 33 |
reproduction:
|
| 34 |
reproduced_by: ""
|
| 35 |
reproduced_at: ""
|
| 36 |
reproduced_bench_version: ""
|
| 37 |
+
match: ""
|
| 38 |
|
| 39 |
submitter:
|
| 40 |
hf_username: ""
|
submissions/scores/.gitkeep
DELETED
|
File without changes
|