modulate commited on
Commit
30fbb60
·
verified ·
1 Parent(s): 23ba64f

quick start: use the runnable harness; drop duplicated tier prose

Browse files
Files changed (1) hide show
  1. README.md +18 -7
README.md CHANGED
@@ -45,13 +45,25 @@ ds = load_dataset("modulate/entity-transcription-benchmark", split="test")
45
  print(ds[0])
46
  ```
47
 
48
- Score with the shipped matcher:
 
49
 
50
  ```bash
51
- python scripts/matcher_v5.py --selftest # expect 49/49
52
- python scripts/score_named_entities.py --hypotheses my_transcripts.csv
 
 
 
 
 
 
 
 
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. Tier A spans are discriminative — multi-token names,
320
- rare surnames, uncommon organizations and places. Tier B spans are trivial for
321
- any English recognizer and inflate a score without separating one system from
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,