Update README.md

README.md

@@ -1,199 +1,164 @@
 ---
-library_name: transformers
-tags: []
+license: apache-2.0
+tags:
+- generated_from_trainer
+metrics:
+- wer
+- cer
+model-index:
+- name: uniTKU-hubert-japanese-asr
+  results:
+  - task:
+      name: Speech Recognition
+      type: automatic-speech-recognition
+    dataset:
+      name: common_voice_11_0
+      type: common_voice
+      args: ja
+    metrics:
+    - name: Test WER
+      type: wer
+      value: 27.447168
+    - name: Test CER
+      type: cer
+      value: 11.607944
+datasets:
+- mozilla-foundation/common_voice_11_0
+language:
+- ja
 ---
 
-# Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
-
-
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+# uniTKU-hubert-japanese-asr
+
+This model was fine-tuned on a dataset provided by uniTKU, and it has maintained the original performance metrics on the [common_voice_11_0 dataset](https://huggingface.co/datasets/mozilla-foundation/common_voice_11_0/viewer/ja).
+
+This model can only predict Hiragana.
+
+## Training Procedure
+
+Fine-tuning on the uniTKU dataset led to the following results:
+
+| Step  | Training Loss | Validation Loss | WER    |
+|-------|---------------|-----------------|--------|
+| 100  | 0.910100      | 1.051628        | 0.669118|
+| 200  | 0.747700      | 0.691642        | 0.551471|
+| 300  | 0.718000      | 0.705763        | 0.544118|
+| 400  | 0.663700      | 0.532831        | 0.397059|
+| 500  | 0.667700      | 0.491024        | 0.352941|
+| 600  | 0.546800      | 0.365637        | 0.330882|
+| 700  | 0.569000      | 0.274410        | 0.279412|
+| 800  | 0.591800      | 0.274801        | 0.235294|
+| 900  | 0.575400      | 0.257891        | 0.220588|
+| 1000 | 0.579100      | 0.280559        | 0.205882|
+
+### Training hyperparameters
+
+The training hyperparameters remained consistent throughout the fine-tuning process:
+
+- learning_rate: 1e-4
+- train_batch_size: 16
+- eval_batch_size: 16
+- gradient_accumulation_steps: 2
+- num_train_epochs: 15
+- lr_scheduler_type: linear
+
+### How to evaluate the model
+
+```python
+from transformers import HubertForCTC, Wav2Vec2Processor
+from datasets import load_dataset
+import torch
+import torchaudio
+import librosa
+import numpy as np
+import re
+import MeCab
+import pykakasi
+from evaluate import load
+
+model = HubertForCTC.from_pretrained('TKU410410103/uniTKU-hubert-japanese-asr')
+processor = Wav2Vec2Processor.from_pretrained("TKU410410103/uniTKU-hubert-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))
+```
+
+### Test results
+The final model was evaluated as follows:
+
+On uniTKU Dataset:
+- WER: 20.5%
+
+On common_voice_11_0:
+- WER: 27.447168%
+- CER: 11.607944%
+  
+### Framework versions
+
+- Transformers 4.39.1
+- Pytorch 2.2.1+cu118
+- Datasets 2.17.1