Datasets:
quick start: use the runnable harness; drop duplicated tier prose
Browse files
README.md
CHANGED
|
@@ -45,13 +45,25 @@ ds = load_dataset("modulate/entity-transcription-benchmark", split="test")
|
|
| 45 |
print(ds[0])
|
| 46 |
```
|
| 47 |
|
| 48 |
-
|
|
|
|
| 49 |
|
| 50 |
```bash
|
| 51 |
-
|
| 52 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 53 |
```
|
| 54 |
|
|
|
|
|
|
|
|
|
|
| 55 |
**Use the shipped scorer.** Entity accuracy is highly sensitive to
|
| 56 |
normalization — casing, punctuation, spoken numbers — and independently written
|
| 57 |
scorers do not produce comparable numbers. `matcher_v5` is the definition of
|
|
@@ -316,10 +328,9 @@ comparable to ours:
|
|
| 316 |
| WER | computed over every transcribed clip |
|
| 317 |
|
| 318 |
`entity_tiers` is an array parallel to `entities`, so a single clip can hold both
|
| 319 |
-
tier A and tier B spans
|
| 320 |
-
|
| 321 |
-
|
| 322 |
-
another.
|
| 323 |
|
| 324 |
`matcher_v5` does considerably more than substring matching: Unicode
|
| 325 |
canonicalization, abbreviation aliases, spoken-form reconstruction for numbers,
|
|
|
|
| 45 |
print(ds[0])
|
| 46 |
```
|
| 47 |
|
| 48 |
+
Or benchmark a system end to end. The harness transcribes every clip through
|
| 49 |
+
your endpoint and scores the result — no transcript file needed up front:
|
| 50 |
|
| 51 |
```bash
|
| 52 |
+
huggingface-cli download modulate/entity-transcription-benchmark \
|
| 53 |
+
--repo-type dataset --include "scripts/*" --local-dir .
|
| 54 |
+
cd scripts && pip install -r requirements.txt
|
| 55 |
+
|
| 56 |
+
export MY_STT_KEY=...
|
| 57 |
+
python run_benchmark.py --endpoint https://api.example.com/v1/transcribe \
|
| 58 |
+
--api-key-env MY_STT_KEY --response-path result.transcript \
|
| 59 |
+
--system-name my-system --out runs/mine.jsonl
|
| 60 |
+
|
| 61 |
+
python score_benchmark.py --hyps runs/mine.jsonl
|
| 62 |
```
|
| 63 |
|
| 64 |
+
Full instructions, vendor shortcuts and the scoring protocol are in
|
| 65 |
+
[Reproducing our numbers](#reproducing-our-numbers) below.
|
| 66 |
+
|
| 67 |
**Use the shipped scorer.** Entity accuracy is highly sensitive to
|
| 68 |
normalization — casing, punctuation, spoken numbers — and independently written
|
| 69 |
scorers do not produce comparable numbers. `matcher_v5` is the definition of
|
|
|
|
| 328 |
| WER | computed over every transcribed clip |
|
| 329 |
|
| 330 |
`entity_tiers` is an array parallel to `entities`, so a single clip can hold both
|
| 331 |
+
tier A and tier B spans; the scorer filters spans, not clips. See
|
| 332 |
+
[Metric and difficulty tiers](#metric-and-difficulty-tiers) for what each tier
|
| 333 |
+
contains and why the headline uses tier A.
|
|
|
|
| 334 |
|
| 335 |
`matcher_v5` does considerably more than substring matching: Unicode
|
| 336 |
canonicalization, abbreviation aliases, spoken-form reconstruction for numbers,
|