update model card README.md

README.md

@@ -1,15 +1,30 @@
 ---
 language:
-- zh
+- zh-TW
 license: apache-2.0
 tags:
 - whisper-event
 - generated_from_trainer
 datasets:
 - mozilla-foundation/common_voice_11_0
+metrics:
+- wer
 model-index:
 - name: Whisper Small Chinese - Kimbo Chen
-  results: []
+  results:
+  - task:
+      name: Automatic Speech Recognition
+      type: automatic-speech-recognition
+    dataset:
+      name: Common Voice 11.0
+      type: mozilla-foundation/common_voice_11_0
+      config: zh-TW
+      split: test
+      args: zh-TW
+    metrics:
+    - name: Wer
+      type: wer
+      value: 45.8546571136131
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -18,6 +33,9 @@ should probably proofread and complete it, then remove this comment. -->
 # Whisper Small Chinese - Kimbo Chen
 
 This model is a fine-tuned version of [openai/whisper-small](https://huggingface.co/openai/whisper-small) on the Common Voice 11.0 dataset.
+It achieves the following results on the evaluation set:
+- Loss: 0.2846
+- Wer: 45.8547
 
 ## Model description
 
@@ -46,6 +64,17 @@ The following hyperparameters were used during training:
 - training_steps: 5000
 - mixed_precision_training: Native AMP
 
+### Training results
+
+| Training Loss | Epoch | Step | Validation Loss | Wer     |
+|:-------------:|:-----:|:----:|:---------------:|:-------:|
+| 0.0016        | 9.01  | 1000 | 0.2376          | 44.4422 |
+| 0.0004        | 19.01 | 2000 | 0.2559          | 44.6673 |
+| 0.0002        | 29.0  | 3000 | 0.2710          | 45.2815 |
+| 0.0002        | 38.02 | 4000 | 0.2804          | 45.7523 |
+| 0.0001        | 48.01 | 5000 | 0.2846          | 45.8547 |
+
+
 ### Framework versions
 
 - Transformers 4.26.0.dev0

fine-tune-whisper-streaming.ipynb

@@ -1141,7 +1141,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 36,
+   "execution_count": null,
    "id": "95737cda-c5dd-4887-a4d0-dfcb0d61d977",
    "metadata": {},
    "outputs": [
@@ -1156,40 +1156,14 @@
       "tokenizer config file saved in ./tokenizer_config.json\n",
       "Special tokens file saved in ./special_tokens_map.json\n",
       "added tokens file saved in ./added_tokens.json\n",
-      "Several commits (12) will be pushed upstream.\n",
+      "Several commits (13) will be pushed upstream.\n",
       "The progress bars may be unreliable.\n",
       "remote: Scanning LFS files for validity, may be slow...        \n",
       "remote: LFS file scan complete.        \n",
-      "remote: ----------------------------------------------------------\u001b[0;31m        \n",
-      "remote: Sorry, your push was rejected during YAML metadata verification:        \n",
-      "remote: - Error: \"language[0]\" with value \"zh-tw\" is not valid. It must be an ISO 639-1, 639-2 or 639-3 code (two/three letters), or a special value like \"code\", \"multilingual\". If you want to use BCP-47 identifiers, you can specify them in language_bcp47.\u001b[0;32m        \n",
-      "remote: ----------------------------------------------------------        \n",
-      "remote: Please find the documentation at:        \n",
-      "remote: https://huggingface.co/docs/hub/model-cards#model-card-metadata\u001b[0;0m        \n",
-      "remote: ----------------------------------------------------------        \n",
       "To https://huggingface.co/kimbochen/whisper-small-zh-tw\n",
-      " ! [remote rejected] main -> main (pre-receive hook declined)\n",
-      "error: failed to push some refs to 'https://huggingface.co/kimbochen/whisper-small-zh-tw'\n",
+      "   214645d..6f314a7  main -> main\n",
       "\n"
      ]
-    },
-    {
-     "ename": "OSError",
-     "evalue": "remote: Scanning LFS files for validity, may be slow...        \nremote: LFS file scan complete.        \nremote: ----------------------------------------------------------\u001b[0;31m        \nremote: Sorry, your push was rejected during YAML metadata verification:        \nremote: - Error: \"language[0]\" with value \"zh-tw\" is not valid. It must be an ISO 639-1, 639-2 or 639-3 code (two/three letters), or a special value like \"code\", \"multilingual\". If you want to use BCP-47 identifiers, you can specify them in language_bcp47.\u001b[0;32m        \nremote: ----------------------------------------------------------        \nremote: Please find the documentation at:        \nremote: https://huggingface.co/docs/hub/model-cards#model-card-metadata\u001b[0;0m        \nremote: ----------------------------------------------------------        \nTo https://huggingface.co/kimbochen/whisper-small-zh-tw\n ! [remote rejected] main -> main (pre-receive hook declined)\nerror: failed to push some refs to 'https://huggingface.co/kimbochen/whisper-small-zh-tw'\n",
-     "output_type": "error",
-     "traceback": [
-      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
-      "\u001b[0;31mCalledProcessError\u001b[0m                        Traceback (most recent call last)",
-      "File \u001b[0;32m~/.venv/lib/python3.8/site-packages/huggingface_hub/repository.py:1207\u001b[0m, in \u001b[0;36mRepository.git_push\u001b[0;34m(self, upstream, blocking, auto_lfs_prune)\u001b[0m\n\u001b[1;32m   1206\u001b[0m             \u001b[38;5;28;01mif\u001b[39;00m return_code:\n\u001b[0;32m-> 1207\u001b[0m                 \u001b[38;5;28;01mraise\u001b[39;00m subprocess\u001b[38;5;241m.\u001b[39mCalledProcessError(\n\u001b[1;32m   1208\u001b[0m                     return_code, process\u001b[38;5;241m.\u001b[39margs, output\u001b[38;5;241m=\u001b[39mstdout, stderr\u001b[38;5;241m=\u001b[39mstderr\n\u001b[1;32m   1209\u001b[0m                 )\n\u001b[1;32m   1211\u001b[0m \u001b[38;5;28;01mexcept\u001b[39;00m subprocess\u001b[38;5;241m.\u001b[39mCalledProcessError \u001b[38;5;28;01mas\u001b[39;00m exc:\n",
-      "\u001b[0;31mCalledProcessError\u001b[0m: Command '['git', 'push', '--set-upstream', 'origin', 'main']' returned non-zero exit status 1.",
-      "\nDuring handling of the above exception, another exception occurred:\n",
-      "\u001b[0;31mOSError\u001b[0m                                   Traceback (most recent call last)",
-      "Cell \u001b[0;32mIn[36], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[43mtrainer\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mpush_to_hub\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43mkwargs\u001b[49m\u001b[43m)\u001b[49m\n",
-      "File \u001b[0;32m~/.venv/lib/python3.8/site-packages/transformers/trainer.py:3492\u001b[0m, in \u001b[0;36mTrainer.push_to_hub\u001b[0;34m(self, commit_message, blocking, **kwargs)\u001b[0m\n\u001b[1;32m   3489\u001b[0m     \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mpush_in_progress\u001b[38;5;241m.\u001b[39m_process\u001b[38;5;241m.\u001b[39mkill()\n\u001b[1;32m   3490\u001b[0m     \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mpush_in_progress \u001b[38;5;241m=\u001b[39m \u001b[38;5;28;01mNone\u001b[39;00m\n\u001b[0;32m-> 3492\u001b[0m git_head_commit_url \u001b[38;5;241m=\u001b[39m \u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mrepo\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mpush_to_hub\u001b[49m\u001b[43m(\u001b[49m\n\u001b[1;32m   3493\u001b[0m \u001b[43m    \u001b[49m\u001b[43mcommit_message\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mcommit_message\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mblocking\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mblocking\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mauto_lfs_prune\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[38;5;28;43;01mTrue\u001b[39;49;00m\n\u001b[1;32m   3494\u001b[0m \u001b[43m\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m   3495\u001b[0m \u001b[38;5;66;03m# push separately the model card to be independant from the rest of the model\u001b[39;00m\n\u001b[1;32m   3496\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39margs\u001b[38;5;241m.\u001b[39mshould_save:\n",
-      "File \u001b[0;32m~/.venv/lib/python3.8/site-packages/huggingface_hub/repository.py:1432\u001b[0m, in \u001b[0;36mRepository.push_to_hub\u001b[0;34m(self, commit_message, blocking, clean_ok, auto_lfs_prune)\u001b[0m\n\u001b[1;32m   1430\u001b[0m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mgit_add(auto_lfs_track\u001b[38;5;241m=\u001b[39m\u001b[38;5;28;01mTrue\u001b[39;00m)\n\u001b[1;32m   1431\u001b[0m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mgit_commit(commit_message)\n\u001b[0;32m-> 1432\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mgit_push\u001b[49m\u001b[43m(\u001b[49m\n\u001b[1;32m   1433\u001b[0m \u001b[43m    \u001b[49m\u001b[43mupstream\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[38;5;124;43mf\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43morigin \u001b[39;49m\u001b[38;5;132;43;01m{\u001b[39;49;00m\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mcurrent_branch\u001b[49m\u001b[38;5;132;43;01m}\u001b[39;49;00m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m,\u001b[49m\n\u001b[1;32m   1434\u001b[0m \u001b[43m    \u001b[49m\u001b[43mblocking\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mblocking\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m   1435\u001b[0m \u001b[43m    \u001b[49m\u001b[43mauto_lfs_prune\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mauto_lfs_prune\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m   1436\u001b[0m \u001b[43m\u001b[49m\u001b[43m)\u001b[49m\n",
-      "File \u001b[0;32m~/.venv/lib/python3.8/site-packages/huggingface_hub/repository.py:1212\u001b[0m, in \u001b[0;36mRepository.git_push\u001b[0;34m(self, upstream, blocking, auto_lfs_prune)\u001b[0m\n\u001b[1;32m   1207\u001b[0m                 \u001b[38;5;28;01mraise\u001b[39;00m subprocess\u001b[38;5;241m.\u001b[39mCalledProcessError(\n\u001b[1;32m   1208\u001b[0m                     return_code, process\u001b[38;5;241m.\u001b[39margs, output\u001b[38;5;241m=\u001b[39mstdout, stderr\u001b[38;5;241m=\u001b[39mstderr\n\u001b[1;32m   1209\u001b[0m                 )\n\u001b[1;32m   1211\u001b[0m \u001b[38;5;28;01mexcept\u001b[39;00m subprocess\u001b[38;5;241m.\u001b[39mCalledProcessError \u001b[38;5;28;01mas\u001b[39;00m exc:\n\u001b[0;32m-> 1212\u001b[0m     \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;167;01mEnvironmentError\u001b[39;00m(exc\u001b[38;5;241m.\u001b[39mstderr)\n\u001b[1;32m   1214\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m blocking:\n\u001b[1;32m   1216\u001b[0m     \u001b[38;5;28;01mdef\u001b[39;00m \u001b[38;5;21mstatus_method\u001b[39m():\n",
-      "\u001b[0;31mOSError\u001b[0m: remote: Scanning LFS files for validity, may be slow...        \nremote: LFS file scan complete.        \nremote: ----------------------------------------------------------\u001b[0;31m        \nremote: Sorry, your push was rejected during YAML metadata verification:        \nremote: - Error: \"language[0]\" with value \"zh-tw\" is not valid. It must be an ISO 639-1, 639-2 or 639-3 code (two/three letters), or a special value like \"code\", \"multilingual\". If you want to use BCP-47 identifiers, you can specify them in language_bcp47.\u001b[0;32m        \nremote: ----------------------------------------------------------        \nremote: Please find the documentation at:        \nremote: https://huggingface.co/docs/hub/model-cards#model-card-metadata\u001b[0;0m        \nremote: ----------------------------------------------------------        \nTo https://huggingface.co/kimbochen/whisper-small-zh-tw\n ! [remote rejected] main -> main (pre-receive hook declined)\nerror: failed to push some refs to 'https://huggingface.co/kimbochen/whisper-small-zh-tw'\n"
-     ]
     }
    ],
    "source": [