gam30 commited on
Commit
27ff50c
·
verified ·
1 Parent(s): a22e4d4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +37 -5
README.md CHANGED
@@ -147,19 +147,51 @@ print(transcribe(AUDIO_PATH))
147
  ```
148
 
149
  ## Use Directly from Hugging Face Hub
150
-
151
  ```python
152
  from huggingface_hub import hf_hub_download
153
-
154
  repo_id = "gam30/nepali-automatic-speech-recognition"
155
  onnx_path = hf_hub_download(repo_id=repo_id, filename="model_ctc_quantized.onnx")
156
  config_path = hf_hub_download(repo_id=repo_id, filename="model_config.yaml")
157
  ```
158
-
159
  Then run inference with the same code above, replacing `ONNX_PATH` and `CONFIG_PATH`.
160
-
 
 
161
  ## Notes
162
-
163
  - The notebook `local_onnx_asr_inference.ipynb` is the reference test workflow.
164
  - For better quality, use clean 16 kHz mono audio where possible.
165
  - Quantized model is faster/smaller; full model provides better accuracy with small margin only.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
147
  ```
148
 
149
  ## Use Directly from Hugging Face Hub
150
+
151
  ```python
152
  from huggingface_hub import hf_hub_download
153
+
154
  repo_id = "gam30/nepali-automatic-speech-recognition"
155
  onnx_path = hf_hub_download(repo_id=repo_id, filename="model_ctc_quantized.onnx")
156
  config_path = hf_hub_download(repo_id=repo_id, filename="model_config.yaml")
157
  ```
158
+
159
  Then run inference with the same code above, replacing `ONNX_PATH` and `CONFIG_PATH`.
160
+
161
+ ---
162
+
163
  ## Notes
164
+
165
  - The notebook `local_onnx_asr_inference.ipynb` is the reference test workflow.
166
  - For better quality, use clean 16 kHz mono audio where possible.
167
  - Quantized model is faster/smaller; full model provides better accuracy with small margin only.
168
+
169
+ ---
170
+
171
+ ## Citation
172
+
173
+ If you use this model in your research, project, or application, please cite it as follows:
174
+
175
+ **APA:**
176
+ ```
177
+ gam30. (2025). Nepali Automatic Speech Recognition (ONNX CTC) [Model]. Hugging Face. https://huggingface.co/gam30/nepali-automatic-speech-recognition
178
+ ```
179
+
180
+ **BibTeX:**
181
+ ```bibtex
182
+ @misc{gam30_nepali_asr,
183
+ author = {gam30},
184
+ title = {Nepali Automatic Speech Recognition (ONNX CTC)},
185
+ year = {2025},
186
+ publisher = {Hugging Face},
187
+ howpublished = {\url{https://huggingface.co/gam30/nepali-automatic-speech-recognition}}
188
+ }
189
+ ```
190
+
191
+ > **Please note:** This model is based on the architecture from [ai4bharat/indicconformer_stt_ne_hybrid_ctc_rnnt_large](https://huggingface.co/ai4bharat/indicconformer_stt_ne_hybrid_ctc_rnnt_large). When citing, please also acknowledge the original base model authors.
192
+
193
+ ---
194
+
195
+ ## License
196
+
197
+ If you use or redistribute this model, you must credit **[gam30/nepali-automatic-speech-recognition](https://huggingface.co/gam30/nepali-automatic-speech-recognition)** as the source as well as AI4Bharat.