NathanRoll commited on
Commit
de5d8c3
路
verified 路
1 Parent(s): b59c13a

Add crediting block, oruk.ai links, questions pointer and FLEURS model-index

Browse files

README: a 'Crediting Orukeet' copy-paste block (Orukeet by Oruk, built on Parakeet-TDT v3; weights on Hugging Face; CC BY-SA 4.0; https://oruk.ai/models/orukeet), oruk.ai links tagged utm_source=huggingface&utm_medium=model-card&utm_campaign=orukeet, a 'Questions and bugs' pointer (GitHub issues for bugs, Discussions for model questions; no language-forcing control; hosted Orukeet is English-only), and the license sentence 'Code is MIT; weights and fitted kernels are CC BY-SA 4.0' linking LICENSE and LICENSE-WEIGHTS. Front matter: a model-index with FLEURS only (pooled 25-language 9.85% and English 3.82% WER from the card's own table); LibriSpeech test-other is excluded because it was used for adaptation. No hosted-API section: the origin probe timed out and /readyz does not list Orukeet. From the 2026-11-10 STT audit, section 8 (F047, F157, F147, G2604, G2702, G1301, G1308). Mirrors Oruk-AI/orukeet PR #12.

Files changed (1) hide show
  1. README.md +44 -2
README.md CHANGED
@@ -11,6 +11,32 @@ transcribe_cpp:
11
  lang_detect: true
12
  timestamps: token
13
  tags: [parakeet, tdt, onnx, sherpa-onnx, gguf, multilingual, speech-recognition, gabor, fastconformer]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  ---
15
 
16
  <!-- orukeet-brand:start -->
@@ -43,7 +69,7 @@ Orukeet outperforms Parakeet on **61 of 74 tested splits**, including LibriSpeec
43
 
44
  Use Orukeet for recordings, media, batch transcription, server workers and interactive applications. NeMo, ONNX INT8, native Q8 and native F16 all derive from the same **r3 release checkpoint** (`031c8ddab484`).
45
 
46
- [Code](https://github.com/Oruk-AI/orukeet) 路 [OpenWhispr PR](https://github.com/OpenWhispr/openwhispr/pull/2085) 路 [Technical report](orukeet-technical-report.pdf) 路 [Artifact hashes](ARTIFACTS.json)
47
 
48
  ## Run Orukeet with Transformers
49
 
@@ -195,9 +221,25 @@ Q8 and F16 pass real transcription and protocol checks on Apple silicon with Met
195
 
196
  [Artifact catalog](https://github.com/Oruk-AI/orukeet/blob/main/src/orukeet/artifacts.json) 路 [Native conversion and validation](https://github.com/Oruk-AI/orukeet/tree/main/evidence/r3-promotion-20260908/)
197
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
198
  ## License and attribution
199
 
200
- Code: MIT. Weights and fitted kernels: CC BY-SA 4.0, retaining NVIDIA's foundation attribution. Transcript-free metric records: CC BY 4.0. Dataset audio is obtained from its original providers under their terms.
201
 
202
  [Data provenance](https://github.com/Oruk-AI/orukeet/blob/main/docs/data-and-licenses.md) 路 [Attribution](NOTICE.md)
203
 
 
11
  lang_detect: true
12
  timestamps: token
13
  tags: [parakeet, tdt, onnx, sherpa-onnx, gguf, multilingual, speech-recognition, gabor, fastconformer]
14
+ model-index:
15
+ - name: oruk/orukeet
16
+ results:
17
+ - task:
18
+ type: automatic-speech-recognition
19
+ name: Automatic Speech Recognition
20
+ dataset:
21
+ name: FLEURS (25 languages, pooled)
22
+ type: google/fleurs
23
+ split: test
24
+ metrics:
25
+ - type: wer
26
+ value: 9.85
27
+ name: Pooled test WER, 20,146 recordings
28
+ - task:
29
+ type: automatic-speech-recognition
30
+ name: Automatic Speech Recognition
31
+ dataset:
32
+ name: FLEURS English
33
+ type: google/fleurs
34
+ config: en_us
35
+ split: test
36
+ metrics:
37
+ - type: wer
38
+ value: 3.82
39
+ name: Test WER, 647 recordings
40
  ---
41
 
42
  <!-- orukeet-brand:start -->
 
69
 
70
  Use Orukeet for recordings, media, batch transcription, server workers and interactive applications. NeMo, ONNX INT8, native Q8 and native F16 all derive from the same **r3 release checkpoint** (`031c8ddab484`).
71
 
72
+ [Code](https://github.com/Oruk-AI/orukeet) 路 [OpenWhispr PR](https://github.com/OpenWhispr/openwhispr/pull/2085) 路 [Technical report](orukeet-technical-report.pdf) 路 [Artifact hashes](ARTIFACTS.json) 路 [Orukeet at oruk.ai](https://oruk.ai/models/orukeet?utm_source=huggingface&utm_medium=model-card&utm_campaign=orukeet) 路 [Oruk speech-to-text API](https://oruk.ai/speech-to-text-api?utm_source=huggingface&utm_medium=model-card&utm_campaign=orukeet)
73
 
74
  ## Run Orukeet with Transformers
75
 
 
221
 
222
  [Artifact catalog](https://github.com/Oruk-AI/orukeet/blob/main/src/orukeet/artifacts.json) 路 [Native conversion and validation](https://github.com/Oruk-AI/orukeet/tree/main/evidence/r3-promotion-20260908/)
223
 
224
+ ## Questions and bugs
225
+
226
+ Reproducible transcription or runtime bugs go to [GitHub issues](https://github.com/Oruk-AI/orukeet/issues/new/choose); include the model SHA-256, OS/architecture, runtime/device and input format. Model-level questions (languages, accuracy, fine-tuning, licensing, packaging Orukeet in an app) go to [GitHub Discussions](https://github.com/Oruk-AI/orukeet/discussions). Orukeet detects the language itself: the weights and the native API have no language-forcing or vocabulary-biasing input, and the native response returns `language: null`. Hosted Orukeet on oruk.ai transcribes English only. Security reports: [SECURITY.md](https://github.com/Oruk-AI/orukeet/blob/main/SECURITY.md).
227
+
228
+ ## Crediting Orukeet
229
+
230
+ If you ship, repackage, benchmark or write about Orukeet, credit it by name and origin. Copy and paste:
231
+
232
+ > Orukeet by Oruk, built on Parakeet-TDT v3; weights on Hugging Face; CC BY-SA 4.0. https://oruk.ai/models/orukeet
233
+
234
+ ```markdown
235
+ [Orukeet](https://oruk.ai/models/orukeet) by [Oruk](https://oruk.ai), built on NVIDIA Parakeet-TDT v3; weights on [Hugging Face](https://huggingface.co/oruk/orukeet) under CC BY-SA 4.0.
236
+ ```
237
+
238
+ Redistributed weights keep NVIDIA's Parakeet attribution and the CC BY-SA 4.0 notice ([NOTICE.md](NOTICE.md)). For papers, use the citation below.
239
+
240
  ## License and attribution
241
 
242
+ Code is MIT ([LICENSE](LICENSE)); weights and fitted kernels are CC BY-SA 4.0 ([LICENSE-WEIGHTS](LICENSE-WEIGHTS)), retaining NVIDIA's foundation attribution. Transcript-free metric records: CC BY 4.0. Dataset audio is obtained from its original providers under their terms.
243
 
244
  [Data provenance](https://github.com/Oruk-AI/orukeet/blob/main/docs/data-and-licenses.md) 路 [Attribution](NOTICE.md)
245