Update README.md

README.md

@@ -49,7 +49,7 @@ should probably proofread and complete it, then remove this comment. -->
 
 # hubert-large-asr
 
-This model is a fine-tuned version of [rinna/japanese-hubert-large](https://huggingface.co/rinna/japanese-hubert-large) ASR. Initially fine-tuned on the [Reazonspeech(small) dataset](https://huggingface.co/datasets/reazon-research/reazonspeech), it was subsequently further fine-tuned on the [common_voice_11_0 dataset](https://huggingface.co/datasets/mozilla-foundation/common_voice_11_0/viewer/ja) for ASR tasks.
+This model is a fine-tuned version of [rinna/japanese-hubert-large](https://huggingface.co/rinna/japanese-hubert-large) ASR. Initially fine-tuned on the [reazonspeech(small) dataset](https://huggingface.co/datasets/reazon-research/reazonspeech), it was subsequently further fine-tuned on the [common_voice_11_0 dataset](https://huggingface.co/datasets/mozilla-foundation/common_voice_11_0/viewer/ja) for ASR tasks.
 
 ## Acknowledgments
 
@@ -110,7 +110,7 @@ The following hyperparameters were used during training:
 ### Test results
 The final model was evaluated as follows:
 
-On Reazonspeech:
+On reazonspeech(tiny):
 - WER: 40.519700%
 - CER: 23.220979%
 
@@ -118,6 +118,89 @@ On common_voice_11_0:
 - WER: 22.705487%
 - CER: 9.399390%
 
+### How to use the model
+
+```python
+from transformers import HubertForCTC, Wav2Vec2Processor
+from datasets import load_dataset
+import torchaudio
+import librosa
+import numpy as np
+import re
+import MeCab
+import pykakasi
+from evaluate import load
+
+model = HubertForCTC.from_pretrained('TKU410410103/hubert-large-japanese-asr')
+processor = Wav2Vec2Processor.from_pretrained("TKU410410103/hubert-large-japanese-asr")
+
+# load dataset
+test_dataset = load_dataset('mozilla-foundation/common_voice_11_0', 'ja', split='test')
+remove_columns = [col for col in test_dataset.column_names if col not in ['audio', 'sentence']]
+test_dataset = test_dataset.remove_columns(remove_columns)
+
+# resample
+def process_waveforms(batch):
+    speech_arrays = []
+    sampling_rates = []
+
+    for audio_path in batch['audio']:
+        speech_array, _ = torchaudio.load(audio_path['path'])
+        speech_array_resampled = librosa.resample(np.asarray(speech_array[0].numpy()), orig_sr=48000, target_sr=16000)
+        speech_arrays.append(speech_array_resampled)
+        sampling_rates.append(16000)
+
+    batch["array"] = speech_arrays
+    batch["sampling_rate"] = sampling_rates
+
+    return batch
+
+# hiragana
+CHARS_TO_IGNORE = [",", "?", "¿", ".", "!", "¡", ";", "；", ":", '""', "%", '"', "�", "ʿ", "·", "჻", "~", "՞",
+          "؟", "،", "।", "॥", "«", "»", "„", "“", "”", "「", "」", "‘", "’", "《", "》", "(", ")", "[", "]",
+          "{", "}", "=", "`", "_", "+", "<", ">", "…", "–", "°", "´", "ʾ", "‹", "›", "©", "®", "—", "→", "。",
+          "、", "﹂", "﹁", "‧", "～", "﹏", "，", "｛", "｝", "（", "）", "［", "］", "【", "】", "‥", "〽",
+          "『", "』", "〝", "〟", "⟨", "⟩", "〜", "：", "！", "？", "♪", "؛", "/", "\\", "º", "−", "^", "'", "ʻ", "ˆ"]
+chars_to_ignore_regex = f"[{re.escape(''.join(CHARS_TO_IGNORE))}]"
+
+wakati = MeCab.Tagger("-Owakati")
+kakasi = pykakasi.kakasi()
+kakasi.setMode("J","H")
+kakasi.setMode("K","H")
+kakasi.setMode("r","Hepburn")
+conv = kakasi.getConverter()
+
+def prepare_char(batch):
+    batch["sentence"] = conv.do(wakati.parse(batch["sentence"]).strip())
+    batch["sentence"] = re.sub(chars_to_ignore_regex,'', batch["sentence"]).strip()
+    return batch
+
+
+resampled_eval_dataset = test_dataset.map(process_waveforms, batched=True, batch_size=50, num_proc=4)
+eval_dataset = resampled_eval_dataset.map(prepare_char, num_proc=4)
+
+# begin the evaluation process
+wer = load("wer")
+cer = load("cer")
+
+def evaluate(batch):
+    inputs = processor(batch["array"], sampling_rate=16_000, return_tensors="pt", padding=True)
+    with torch.no_grad():
+        logits = model(inputs.input_values.to(device), attention_mask=inputs.attention_mask.to(device)).logits
+    pred_ids = torch.argmax(logits, dim=-1)
+    batch["pred_strings"] = processor.batch_decode(pred_ids)
+    return batch
+
+columns_to_remove = [column for column in eval_dataset.column_names if column != "sentence"]
+batch_size = 16
+result = eval_dataset.map(evaluate, remove_columns=columns_to_remove, batched=True, batch_size=batch_size)
+
+wer_result = wer.compute(predictions=result["pred_strings"], references=result["sentence"])
+cer_result = cer.compute(predictions=result["pred_strings"], references=result["sentence"])
+
+print("WER: {:2f}%".format(100 * wer_result))
+print("CER: {:2f}%".format(100 * cer_result))
+```
 ### Framework versions
 
 - Transformers 4.39.1