Add NeMo-Speech.cpp GGUF

#28
.gitattributes CHANGED
@@ -35,3 +35,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
  *.nemo filter=lfs diff=lfs merge=lfs -text
37
  *.png filter=lfs diff=lfs merge=lfs -text
 
 
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
  *.nemo filter=lfs diff=lfs merge=lfs -text
37
  *.png filter=lfs diff=lfs merge=lfs -text
38
+ *.gguf filter=lfs diff=lfs merge=lfs -text
README.md CHANGED
@@ -355,30 +355,48 @@ Also, check out the following NVIDIA speech models:
355
 
356
  ---
357
 
358
- ## NVIDIA NeMo
 
 
359
 
360
- To train, fine-tune or perform inference with this model, you will need to install [NVIDIA NeMo](https://github.com/NVIDIA/NeMo) [\[4\]](#ref-4). We recommend you install it after you've installed python >= 3.11, Cython and latest PyTorch version.
 
 
 
 
361
 
362
  ```bash
363
- apt-get update && apt-get install -y libsndfile1 ffmpeg
364
- pip install Cython packaging
365
- pip install git+https://github.com/NVIDIA/NeMo.git@main#egg=nemo_toolkit[asr]
 
 
 
 
366
  ```
367
 
368
- ## How to Use this Model
 
 
 
 
369
 
370
- The model is available for use in the NeMo Framework, and can be used as a pre-trained checkpoint for inference or for fine-tuning on another dataset.
371
 
372
- You can also run it with [🤗 Transformers](https://github.com/huggingface/transformers) (more below).
 
 
 
 
373
 
374
- ### Loading the Model
375
 
376
  ```python
377
  import nemo.collections.asr as nemo_asr
378
  asr_model = nemo_asr.models.ASRModel.from_pretrained(model_name="nvidia/nemotron-3.5-asr-streaming-0.6b")
379
  ```
380
 
381
- ### Streaming Inference
382
 
383
  You can use the cache-aware streaming inference script from NeMo - [NeMo/examples/asr/asr_cache_aware_streaming/speech_to_text_cache_aware_streaming_infer.py](https://github.com/NVIDIA-NeMo/NeMo/blob/main/examples/asr/asr_cache_aware_streaming/speech_to_text_cache_aware_streaming_infer.py)
384
 
@@ -400,7 +418,7 @@ python examples/asr/asr_cache_aware_streaming/speech_to_text_cache_aware_streami
400
  - `strip_lang_tags=false` (keep): the tag is left in the output, so you can read the detected language directly from each utterance — useful for mixed-language traffic and language labeling.
401
  - `strip_lang_tags=true` (remove): the tag is stripped, leaving only the clean transcript text — useful when you only need the spoken words.
402
 
403
- ### Setting up Streaming Configuration
404
 
405
  Latency is defined by the `att_context_size` param, where att_context_size = `{num_frames_left_context, num_frame_right_context}`, all measured in **80ms frames**:
406
 
 
355
 
356
  ---
357
 
358
+ ## How to Use this Model
359
+
360
+ There are several ways to use this model. Choose the one that fits your needs.
361
 
362
+ ### Run locally with NeMo-Speech.cpp
363
+
364
+ [NeMo-Speech.cpp](https://github.com/NVIDIA/NeMo-Speech.cpp) provides a
365
+ lightweight native C++ runtime for local inference with
366
+ this model. After [installing the runtime](https://github.com/NVIDIA/NeMo-Speech.cpp#installation):
367
 
368
  ```bash
369
+ hf download nvidia/nemotron-3.5-asr-streaming-0.6b \
370
+ nemotron-3.5-asr-streaming-0.6b.q8_0.gguf \
371
+ --local-dir models
372
+
373
+ nemo-speech transcribe audio.wav \
374
+ --model models/nemotron-3.5-asr-streaming-0.6b.q8_0.gguf \
375
+ --language en-US
376
  ```
377
 
378
+ Use another supported locale or `--language auto` for automatic language
379
+ detection. See the [NeMo-Speech.cpp documentation](https://github.com/NVIDIA/NeMo-Speech.cpp)
380
+ for more details.
381
+
382
+ ### NVIDIA NeMo
383
 
384
+ To train, fine-tune or perform inference with this model, install [NVIDIA NeMo](https://github.com/NVIDIA/NeMo) [\[4\]](#ref-4) after installing Python 3.11 or later, Cython, and a recent PyTorch version.
385
 
386
+ ```bash
387
+ apt-get update && apt-get install -y libsndfile1 ffmpeg
388
+ pip install Cython packaging
389
+ pip install git+https://github.com/NVIDIA/NeMo.git@main#egg=nemo_toolkit[asr]
390
+ ```
391
 
392
+ #### Loading the Model
393
 
394
  ```python
395
  import nemo.collections.asr as nemo_asr
396
  asr_model = nemo_asr.models.ASRModel.from_pretrained(model_name="nvidia/nemotron-3.5-asr-streaming-0.6b")
397
  ```
398
 
399
+ #### Streaming Inference
400
 
401
  You can use the cache-aware streaming inference script from NeMo - [NeMo/examples/asr/asr_cache_aware_streaming/speech_to_text_cache_aware_streaming_infer.py](https://github.com/NVIDIA-NeMo/NeMo/blob/main/examples/asr/asr_cache_aware_streaming/speech_to_text_cache_aware_streaming_infer.py)
402
 
 
418
  - `strip_lang_tags=false` (keep): the tag is left in the output, so you can read the detected language directly from each utterance — useful for mixed-language traffic and language labeling.
419
  - `strip_lang_tags=true` (remove): the tag is stripped, leaving only the clean transcript text — useful when you only need the spoken words.
420
 
421
+ #### Setting up Streaming Configuration
422
 
423
  Latency is defined by the `att_context_size` param, where att_context_size = `{num_frames_left_context, num_frame_right_context}`, all measured in **80ms frames**:
424
 
nemotron-3.5-asr-streaming-0.6b.q8_0.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:a5c435f294eea8f88ce68dd27b8c3bfea7f777cb2fbba04fcd30eaa555f429ae
3
+ size 741548352