Update README.md

README.md

@@ -1,21 +1,41 @@
 ---
 library_name: peft
+license: apache-2.0
+datasets:
+- mozilla-foundation/common_voice_11_0
+language:
+- yue
+metrics:
+- cer
+pipeline_tag: automatic-speech-recognition
 ---
-## Training procedure
 
+<p align="left">
+🤗 <a href="https://huggingface.co/Oblivion208" target="_blank">HF Repo</a>  •🐱 <a href="https://github.com/fengredrum/finetune-whisper-lora" target="_blank">Github Repo</a> 
+</p>
 
-The following `bitsandbytes` quantization config was used during training:
-- quant_method: bitsandbytes
-- load_in_8bit: True
-- load_in_4bit: False
-- llm_int8_threshold: 6.0
-- llm_int8_skip_modules: None
-- llm_int8_enable_fp32_cpu_offload: False
-- llm_int8_has_fp16_weight: False
-- bnb_4bit_quant_type: fp4
-- bnb_4bit_use_double_quant: False
-- bnb_4bit_compute_dtype: float32
-### Framework versions
+## Approximate Performance Evaluation
 
+The following models are all trained and evaluated on a single RTX 3090 GPU.
 
-- PEFT 0.6.0.dev0
+### Cantonese Test Results Comparison
+
+#### MDCC
+
+| Model name                      | Parameters | Finetune Steps | Time Spend | Training Loss | Validation Loss | CER % | Finetuned Model                                                                                                          |
+| ------------------------------- | ---------- | -------------- | ---------- | ------------- | --------------- | ----- | ------------------------------------------------------------------------------------------------------------------------ |
+| whisper-tiny-cantonese          | 39 M       | 3200           | 4h 34m     | 0.0485        | 0.771           | 11.10 | [Link](https://huggingface.co/Oblivion208/whisper-tiny-cantonese "Oblivion208/whisper-tiny-cantonese")                   |
+| whisper-base-cantonese          | 74 M       | 7200           | 13h 32m    | 0.0186        | 0.477           | 7.66  | [Link](https://huggingface.co/Oblivion208/whisper-base-cantonese "Oblivion208/whisper-base-cantonese")                   |
+| whisper-small-cantonese         | 244 M      | 3600           | 6h 38m     | 0.0266        | 0.137           | 6.16  | [Link](https://huggingface.co/Oblivion208/whisper-small-cantonese "Oblivion208/whisper-small-cantonese")                 |
+| whisper-small-lora-cantonese    | 3.5 M      | 8000           | 21h 27m    | 0.0687        | 0.382           | 7.40  | [Link](https://huggingface.co/Oblivion208/whisper-small-lora-cantonese "Oblivion208/whisper-small-lora-cantonese")       |
+| whisper-large-v2-lora-cantonese | 15 M       | 10000          | 33h 40m    | 0.0046        | 0.277           | 3.77  | [Link](https://huggingface.co/Oblivion208/whisper-large-v2-lora-cantonese "Oblivion208/whisper-large-v2-lora-cantonese") |
+
+#### Common Voice Corpus 11.0
+
+| Model name                      | Original CER % | w/o Finetune CER % | Jointly Finetune CER % |
+| ------------------------------- | -------------- | ------------------ | ---------------------- |
+| whisper-tiny-cantonese          | 124.03         | 66.85              | 35.87                  |
+| whisper-base-cantonese          | 78.24          | 61.42              | 16.73                  |
+| whisper-small-cantonese         | 52.83          | 31.23              | /                      |
+| whisper-small-lora-cantonese    | 37.53          | 19.38              | 14.73                  |
+| whisper-large-v2-lora-cantonese | 37.53          | 19.38              | 9.63                   |