DariusTheGeek commited on
Commit
17c14bd
·
verified ·
1 Parent(s): afce767

Update model card: remove per-run selection counts and evaluation-set accuracy claims

Browse files
Files changed (1) hide show
  1. README.md +28 -7
README.md CHANGED
@@ -29,29 +29,50 @@ Released artifact: **top-3 FP64 parameter average**. Decoded with **beam 5, leng
29
  | `model.pt` | 17,522,653,578 |
30
  | `omniASR_tokenizer_written_v2.model` | 91,481 |
31
  | `card.yaml` | — |
 
32
 
33
  Total weights: 17,522,653,578 bytes (17.52 GB).
34
 
35
  ## Role in the pipeline
36
 
37
- Member of the 4-way conservative word ROVER on the Lingala lane.
38
 
39
- This model is **one member of an ensemble** and is not intended to be used alone. The full
40
- routing, decoding, fusion and post-processing pipeline — and the scores it produces — are in
41
- the [solution repository](https://github.com/DariusTheGeek/waxal-asr-solution).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
42
 
43
  ## Provenance
44
 
45
  | | |
46
  |---|---|
47
  | Parent | `facebook/omniASR-LLM-3B-v2` |
48
- | Internal run ID | `X0038` |
49
  | Language | Lingala |
50
  | Fine-tuning data | Waxal Lingala/Shona supervised split ([`google/WaxalNLP`](https://huggingface.co/datasets/google/WaxalNLP)) |
51
  | Seed | 42 |
52
 
53
- No evaluation-set label was used at any point in training or model selection.
54
-
55
  ## Usage
56
 
57
  See [`https://github.com/DariusTheGeek/waxal-asr-solution`](https://github.com/DariusTheGeek/waxal-asr-solution) for the environment locks, decode configuration and the exact
 
29
  | `model.pt` | 17,522,653,578 |
30
  | `omniASR_tokenizer_written_v2.model` | 91,481 |
31
  | `card.yaml` | — |
32
+ | `requirements.txt` | — |
33
 
34
  Total weights: 17,522,653,578 bytes (17.52 GB).
35
 
36
  ## Role in the pipeline
37
 
38
+ Member of the Lingala TTIA fusion.
39
 
40
+ This model is **one component of an ensemble solution** and is not intended to be used
41
+ alone. The routing, decoding, fusion and post-processing pipeline are in the
42
+ [solution repository](https://github.com/DariusTheGeek/waxal-asr-solution).
43
+
44
+ ## How to use
45
+
46
+ This is a fairseq2 / `omnilingual-asr` checkpoint, loaded through the asset
47
+ card shipped alongside it (`card.yaml`). The solution repository wraps the whole
48
+ contract -- pinned environment, batch-size-1 decode, tokenizer wiring -- in one
49
+ CLI:
50
+
51
+ ```bash
52
+ git clone https://github.com/DariusTheGeek/waxal-asr-solution
53
+ cd waxal-asr-solution && bash install.sh # pinned environments, ~15 min
54
+ python models/download_models.py --repo waxal-lin-omniasr-llm-3b
55
+
56
+ .venvs/omni/bin/python inference/decode/omniasr.py \
57
+ --config configs/lin/llm3b.yaml \
58
+ --audio path/to/wav_dir --output transcripts.csv
59
+ ```
60
+
61
+ `--weights` accepts any directory holding this repo's files, e.g. the path
62
+ returned by `huggingface_hub.snapshot_download("DariusTheGeek/waxal-lin-omniasr-llm-3b")`.
63
+ `requirements.txt` in this repo pins the runtime alone; the environment lock
64
+ the release was verified under is `env/requirements-omni.txt` in the solution
65
+ repository.
66
 
67
  ## Provenance
68
 
69
  | | |
70
  |---|---|
71
  | Parent | `facebook/omniASR-LLM-3B-v2` |
 
72
  | Language | Lingala |
73
  | Fine-tuning data | Waxal Lingala/Shona supervised split ([`google/WaxalNLP`](https://huggingface.co/datasets/google/WaxalNLP)) |
74
  | Seed | 42 |
75
 
 
 
76
  ## Usage
77
 
78
  See [`https://github.com/DariusTheGeek/waxal-asr-solution`](https://github.com/DariusTheGeek/waxal-asr-solution) for the environment locks, decode configuration and the exact