File size: 50,574 Bytes
b15b87c f1dc7a1 b15b87c fef9a87 b15b87c fef9a87 f1dc7a1 b15b87c fef9a87 b15b87c fef9a87 f1dc7a1 fef9a87 b15b87c f1dc7a1 b15b87c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 |
{
"cells": [
{
"cell_type": "markdown",
"id": "75b58048-7d14-4fc6-8085-1fc08c81b4a6",
"metadata": {
"id": "75b58048-7d14-4fc6-8085-1fc08c81b4a6"
},
"source": [
"# Fine-Tune Whisper For Multilingual ASR with 🤗 Transformers"
]
},
{
"cell_type": "markdown",
"id": "fbfa8ad5-4cdc-4512-9058-836cbbf65e1a",
"metadata": {
"id": "fbfa8ad5-4cdc-4512-9058-836cbbf65e1a"
},
"source": [
"In this Colab, we present a step-by-step guide on how to fine-tune Whisper \n",
"for any multilingual ASR dataset using Hugging Face 🤗 Transformers. This is a \n",
"more \"hands-on\" version of the accompanying [blog post](https://huggingface.co/blog/fine-tune-whisper). \n",
"For a more in-depth explanation of Whisper, the Common Voice dataset and the theory behind fine-tuning, the reader is advised to refer to the blog post."
]
},
{
"cell_type": "markdown",
"id": "afe0d503-ae4e-4aa7-9af4-dbcba52db41e",
"metadata": {
"id": "afe0d503-ae4e-4aa7-9af4-dbcba52db41e"
},
"source": [
"## Introduction"
]
},
{
"cell_type": "markdown",
"id": "9ae91ed4-9c3e-4ade-938e-f4c2dcfbfdc0",
"metadata": {
"id": "9ae91ed4-9c3e-4ade-938e-f4c2dcfbfdc0"
},
"source": [
"Whisper is a pre-trained model for automatic speech recognition (ASR) \n",
"published in [September 2022](https://openai.com/blog/whisper/) by the authors \n",
"Alec Radford et al. from OpenAI. Unlike many of its predecessors, such as \n",
"[Wav2Vec 2.0](https://arxiv.org/abs/2006.11477), which are pre-trained \n",
"on un-labelled audio data, Whisper is pre-trained on a vast quantity of \n",
"**labelled** audio-transcription data, 680,000 hours to be precise. \n",
"This is an order of magnitude more data than the un-labelled audio data used \n",
"to train Wav2Vec 2.0 (60,000 hours). What is more, 117,000 hours of this \n",
"pre-training data is multilingual ASR data. This results in checkpoints \n",
"that can be applied to over 96 languages, many of which are considered \n",
"_low-resource_.\n",
"\n",
"When scaled to 680,000 hours of labelled pre-training data, Whisper models \n",
"demonstrate a strong ability to generalise to many datasets and domains.\n",
"The pre-trained checkpoints achieve competitive results to state-of-the-art \n",
"ASR systems, with near 3% word error rate (WER) on the test-clean subset of \n",
"LibriSpeech ASR and a new state-of-the-art on TED-LIUM with 4.7% WER (_c.f._ \n",
"Table 8 of the [Whisper paper](https://cdn.openai.com/papers/whisper.pdf)).\n",
"The extensive multilingual ASR knowledge acquired by Whisper during pre-training \n",
"can be leveraged for other low-resource languages; through fine-tuning, the \n",
"pre-trained checkpoints can be adapted for specific datasets and languages \n",
"to further improve upon these results. We'll show just how Whisper can be fine-tuned \n",
"for low-resource languages in this Colab."
]
},
{
"cell_type": "markdown",
"id": "e59b91d6-be24-4b5e-bb38-4977ea143a72",
"metadata": {
"id": "e59b91d6-be24-4b5e-bb38-4977ea143a72"
},
"source": [
"<figure>\n",
"<img src=\"https://raw.githubusercontent.com/sanchit-gandhi/notebooks/main/whisper_architecture.svg\" alt=\"Trulli\" style=\"width:100%\">\n",
"<figcaption align = \"center\"><b>Figure 1:</b> Whisper model. The architecture \n",
"follows the standard Transformer-based encoder-decoder model. A \n",
"log-Mel spectrogram is input to the encoder. The last encoder \n",
"hidden states are input to the decoder via cross-attention mechanisms. The \n",
"decoder autoregressively predicts text tokens, jointly conditional on the \n",
"encoder hidden states and previously predicted tokens. Figure source: \n",
"<a href=\"https://openai.com/blog/whisper/\">OpenAI Whisper Blog</a>.</figcaption>\n",
"</figure>"
]
},
{
"cell_type": "markdown",
"id": "21b6316e-8a55-4549-a154-66d3da2ab74a",
"metadata": {
"id": "21b6316e-8a55-4549-a154-66d3da2ab74a"
},
"source": [
"The Whisper checkpoints come in five configurations of varying model sizes.\n",
"The smallest four are trained on either English-only or multilingual data.\n",
"The largest checkpoint is multilingual only. All nine of the pre-trained checkpoints \n",
"are available on the [Hugging Face Hub](https://huggingface.co/models?search=openai/whisper). The \n",
"checkpoints are summarised in the following table with links to the models on the Hub:\n",
"\n",
"| Size | Layers | Width | Heads | Parameters | English-only | Multilingual |\n",
"|--------|--------|-------|-------|------------|------------------------------------------------------|---------------------------------------------------|\n",
"| tiny | 4 | 384 | 6 | 39 M | [✓](https://huggingface.co/openai/whisper-tiny.en) | [✓](https://huggingface.co/openai/whisper-tiny.) |\n",
"| base | 6 | 512 | 8 | 74 M | [✓](https://huggingface.co/openai/whisper-base.en) | [✓](https://huggingface.co/openai/whisper-base) |\n",
"| small | 12 | 768 | 12 | 244 M | [✓](https://huggingface.co/openai/whisper-small.en) | [✓](https://huggingface.co/openai/whisper-small) |\n",
"| medium | 24 | 1024 | 16 | 769 M | [✓](https://huggingface.co/openai/whisper-medium.en) | [✓](https://huggingface.co/openai/whisper-medium) |\n",
"| large | 32 | 1280 | 20 | 1550 M | x | [✓](https://huggingface.co/openai/whisper-large) |\n",
"\n",
"For demonstration purposes, we'll fine-tune the multilingual version of the \n",
"[`\"small\"`](https://huggingface.co/openai/whisper-small) checkpoint with 244M params (~= 1GB). \n",
"As for our data, we'll train and evaluate our system on a low-resource language \n",
"taken from the [Common Voice](https://huggingface.co/datasets/mozilla-foundation/fleurs_11_0)\n",
"dataset. We'll show that with as little as 8 hours of fine-tuning data, we can achieve \n",
"strong performance in this language."
]
},
{
"cell_type": "markdown",
"id": "3a680dfc-cbba-4f6c-8a1f-e1a5ff3f123a",
"metadata": {
"id": "3a680dfc-cbba-4f6c-8a1f-e1a5ff3f123a"
},
"source": [
"------------------------------------------------------------------------\n",
"\n",
"\\\\({}^1\\\\) The name Whisper follows from the acronym “WSPSR”, which stands for “Web-scale Supervised Pre-training for Speech Recognition”."
]
},
{
"cell_type": "markdown",
"id": "b219c9dd-39b6-4a95-b2a1-3f547a1e7bc0",
"metadata": {
"id": "b219c9dd-39b6-4a95-b2a1-3f547a1e7bc0"
},
"source": [
"## Load Dataset\n",
"Loading MS-MY Dataset from FLEURS.\n",
"Combine train and validation set."
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "a2787582-554f-44ce-9f38-4180a5ed6b44",
"metadata": {
"id": "a2787582-554f-44ce-9f38-4180a5ed6b44"
},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"Found cached dataset common_voice_11_0 (/home/daniel/.cache/huggingface/datasets/mozilla-foundation___common_voice_11_0/zh-TW/11.0.0/f8e47235d9b4e68fa24ed71d63266a02018ccf7194b2a8c9c598a5f3ab304d9f)\n",
"Found cached dataset common_voice_11_0 (/home/daniel/.cache/huggingface/datasets/mozilla-foundation___common_voice_11_0/zh-TW/11.0.0/f8e47235d9b4e68fa24ed71d63266a02018ccf7194b2a8c9c598a5f3ab304d9f)\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"DatasetDict({\n",
" train: Dataset({\n",
" features: ['audio', 'sentence'],\n",
" num_rows: 11277\n",
" })\n",
" test: Dataset({\n",
" features: ['audio', 'sentence'],\n",
" num_rows: 4709\n",
" })\n",
"})\n"
]
}
],
"source": [
"from datasets import load_dataset, DatasetDict\n",
"\n",
"cv = DatasetDict()\n",
"cv[\"train\"] = load_dataset(\"mozilla-foundation/common_voice_11_0\", \"zh-TW\", split=\"train+validation\", use_auth_token=True)\n",
"cv[\"test\"] = load_dataset(\"mozilla-foundation/common_voice_11_0\", \"zh-TW\", split=\"test\", use_auth_token=True)\n",
"\n",
"cv = cv.remove_columns([\"client_id\", \"path\", \"up_votes\", \"down_votes\", \"age\", \"gender\", \"accent\", \"locale\", \"segment\"])\n",
"print(cv)"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "79731fc3",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"{'audio': {'path': '/home/daniel/.cache/huggingface/datasets/downloads/extracted/8d1722ebe07713de78ba2ed06286baa9fb33c24f19cb47ef1a3d6cb0774ad391/common_voice_zh-TW_18013265.mp3',\n",
" 'array': array([0., 0., 0., ..., 0., 0., 0.], dtype=float32),\n",
" 'sampling_rate': 48000},\n",
" 'sentence': '爸爸們父親節快樂!'}"
]
},
"execution_count": 2,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"cv['train'][18]"
]
},
{
"cell_type": "markdown",
"id": "2d63b2d2-f68a-4d74-b7f1-5127f6d16605",
"metadata": {
"id": "2d63b2d2-f68a-4d74-b7f1-5127f6d16605"
},
"source": [
"## Prepare Feature Extractor, Tokenizer and Data"
]
},
{
"cell_type": "markdown",
"id": "601c3099-1026-439e-93e2-5635b3ba5a73",
"metadata": {
"id": "601c3099-1026-439e-93e2-5635b3ba5a73"
},
"source": [
"The ASR pipeline can be de-composed into three stages: \n",
"1) A feature extractor which pre-processes the raw audio-inputs\n",
"2) The model which performs the sequence-to-sequence mapping \n",
"3) A tokenizer which post-processes the model outputs to text format\n",
"\n",
"In 🤗 Transformers, the Whisper model has an associated feature extractor and tokenizer, \n",
"called [WhisperFeatureExtractor](https://huggingface.co/docs/transformers/main/model_doc/whisper#transformers.WhisperFeatureExtractor)\n",
"and [WhisperTokenizer](https://huggingface.co/docs/transformers/main/model_doc/whisper#transformers.WhisperTokenizer) \n",
"respectively.\n",
"\n",
"We'll go through details for setting-up the feature extractor and tokenizer one-by-one!"
]
},
{
"cell_type": "markdown",
"id": "560332eb-3558-41a1-b500-e83a9f695f84",
"metadata": {
"id": "560332eb-3558-41a1-b500-e83a9f695f84"
},
"source": [
"### Load WhisperFeatureExtractor"
]
},
{
"cell_type": "markdown",
"id": "32ec8068-0bd7-412d-b662-0edb9d1e7365",
"metadata": {
"id": "32ec8068-0bd7-412d-b662-0edb9d1e7365"
},
"source": [
"The Whisper feature extractor performs two operations:\n",
"1. Pads / truncates the audio inputs to 30s: any audio inputs shorter than 30s are padded to 30s with silence (zeros), and those longer that 30s are truncated to 30s\n",
"2. Converts the audio inputs to _log-Mel spectrogram_ input features, a visual representation of the audio and the form of the input expected by the Whisper model"
]
},
{
"cell_type": "markdown",
"id": "589d9ec1-d12b-4b64-93f7-04c63997da19",
"metadata": {
"id": "589d9ec1-d12b-4b64-93f7-04c63997da19"
},
"source": [
"<figure>\n",
"<img src=\"https://raw.githubusercontent.com/sanchit-gandhi/notebooks/main/spectrogram.jpg\" alt=\"Trulli\" style=\"width:100%\">\n",
"<figcaption align = \"center\"><b>Figure 2:</b> Conversion of sampled audio array to log-Mel spectrogram.\n",
"Left: sampled 1-dimensional audio signal. Right: corresponding log-Mel spectrogram. Figure source:\n",
"<a href=\"https://ai.googleblog.com/2019/04/specaugment-new-data-augmentation.html\">Google SpecAugment Blog</a>.\n",
"</figcaption>"
]
},
{
"cell_type": "markdown",
"id": "b2ef54d5-b946-4c1d-9fdc-adc5d01b46aa",
"metadata": {
"id": "b2ef54d5-b946-4c1d-9fdc-adc5d01b46aa"
},
"source": [
"We'll load the feature extractor from the pre-trained checkpoint with the default values:"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "bc77d7bb-f9e2-47f5-b663-30f7a4321ce5",
"metadata": {
"id": "bc77d7bb-f9e2-47f5-b663-30f7a4321ce5"
},
"outputs": [],
"source": [
"from transformers import WhisperFeatureExtractor\n",
"\n",
"feature_extractor = WhisperFeatureExtractor.from_pretrained(\"openai/whisper-medium\")"
]
},
{
"cell_type": "markdown",
"id": "93748af7-b917-4ecf-a0c8-7d89077ff9cb",
"metadata": {
"id": "93748af7-b917-4ecf-a0c8-7d89077ff9cb"
},
"source": [
"### Load WhisperTokenizer"
]
},
{
"cell_type": "markdown",
"id": "2bc82609-a9fb-447a-a2af-99597c864029",
"metadata": {
"id": "2bc82609-a9fb-447a-a2af-99597c864029"
},
"source": [
"The Whisper model outputs a sequence of _token ids_. The tokenizer maps each of these token ids to their corresponding text string. For Hindi, we can load the pre-trained tokenizer and use it for fine-tuning without any further modifications. We simply have to \n",
"specify the target language and the task. These arguments inform the \n",
"tokenizer to prefix the language and task tokens to the start of encoded \n",
"label sequences:"
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "c7b07f9b-ae0e-4f89-98f0-0c50d432eab6",
"metadata": {
"id": "c7b07f9b-ae0e-4f89-98f0-0c50d432eab6",
"outputId": "5c004b44-86e7-4e00-88be-39e0af5eed69"
},
"outputs": [],
"source": [
"from transformers import WhisperTokenizer\n",
"\n",
"tokenizer = WhisperTokenizer.from_pretrained(\"openai/whisper-medium\", language=\"Chinese\", task=\"transcribe\")"
]
},
{
"cell_type": "markdown",
"id": "d2ef23f3-f4a8-483a-a2dc-080a7496cb1b",
"metadata": {
"id": "d2ef23f3-f4a8-483a-a2dc-080a7496cb1b"
},
"source": [
"### Combine To Create A WhisperProcessor"
]
},
{
"cell_type": "markdown",
"id": "5ff67654-5a29-4bb8-a69d-0228946c6f8d",
"metadata": {
"id": "5ff67654-5a29-4bb8-a69d-0228946c6f8d"
},
"source": [
"To simplify using the feature extractor and tokenizer, we can _wrap_ \n",
"both into a single `WhisperProcessor` class. This processor object \n",
"inherits from the `WhisperFeatureExtractor` and `WhisperProcessor`, \n",
"and can be used on the audio inputs and model predictions as required. \n",
"In doing so, we only need to keep track of two objects during training: \n",
"the `processor` and the `model`:"
]
},
{
"cell_type": "code",
"execution_count": 4,
"id": "77d9f0c5-8607-4642-a8ac-c3ab2e223ea6",
"metadata": {
"id": "77d9f0c5-8607-4642-a8ac-c3ab2e223ea6"
},
"outputs": [],
"source": [
"from transformers import WhisperProcessor\n",
"\n",
"processor = WhisperProcessor.from_pretrained(\"openai/whisper-medium\", language=\"Chinese\", task=\"transcribe\")"
]
},
{
"cell_type": "markdown",
"id": "381acd09-0b0f-4d04-9eb3-f028ac0e5f2c",
"metadata": {
"id": "381acd09-0b0f-4d04-9eb3-f028ac0e5f2c"
},
"source": [
"### Prepare Data"
]
},
{
"cell_type": "code",
"execution_count": 5,
"id": "c69246a2",
"metadata": {},
"outputs": [],
"source": [
"from datasets import Audio\n",
"cv = cv.cast_column(\"audio\", Audio(sampling_rate=16000))"
]
},
{
"cell_type": "markdown",
"id": "3df7378a-a4c0-45d7-8d07-defbd1062ab6",
"metadata": {},
"source": [
"We'll define our pre-processing strategy. We advise that you **do not** lower-case the transcriptions or remove punctuation unless mixing different datasets. This will enable you to fine-tune Whisper models that can predict punctuation and casing. Later, you will see how we can evaluate the predictions without punctuation or casing, so that the models benefit from the WER improvement obtained by normalising the transcriptions while still predicting fully formatted transcriptions."
]
},
{
"cell_type": "markdown",
"id": "89e12c2e-2f14-479b-987b-f0c75c881095",
"metadata": {},
"source": [
"Now we can write a function to prepare our data ready for the model:\n",
"1. We load and resample the audio data by calling `batch[\"audio\"]`. As explained above, 🤗 Datasets performs any necessary resampling operations on the fly.\n",
"2. We use the feature extractor to compute the log-Mel spectrogram input features from our 1-dimensional audio array.\n",
"3. We perform any optional pre-processing (lower-case or remove punctuation).\n",
"4. We encode the transcriptions to label ids through the use of the tokenizer."
]
},
{
"cell_type": "code",
"execution_count": 6,
"id": "b27e4720",
"metadata": {},
"outputs": [],
"source": [
"from audiomentations import Compose, TimeStretch, PitchShift\n",
"\n",
"augment_waveform = Compose([\n",
" TimeStretch(min_rate=0.8, max_rate=1.25, p=0.3, leave_length_unchanged=False),\n",
" PitchShift(min_semitones=-4, max_semitones=4, p=0.3),\n",
" ])\n",
"\n",
"def augment_dataset(batch):\n",
"\n",
" audio = batch[\"audio\"][\"array\"]\n",
" # apply augmentation\n",
" augmented_audio = augment_waveform(samples=audio, sample_rate=16000)\n",
"\n",
" batch[\"audio\"][\"array\"] = augmented_audio\n",
"\n",
" return batch"
]
},
{
"cell_type": "code",
"execution_count": 7,
"id": "b459b0c5",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Augment train set:\n"
]
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "e7f849f56879427995d5de3d75585606",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
" 0%| | 0/11277 [00:00<?, ?ex/s]"
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"print('Augment train set:')\n",
"cv['train'] = cv['train'].map(augment_dataset, num_proc=1)"
]
},
{
"cell_type": "markdown",
"id": "8c960965-9fb6-466f-9dbd-c9d43e71d9d0",
"metadata": {
"id": "70b319fb-2439-4ef6-a70d-a47bf41c4a13"
},
"source": [
"We can apply the data preparation function to all of our training examples using dataset's `.map` method. The argument `num_proc` specifies how many CPU cores to use. Setting `num_proc` > 1 will enable multiprocessing. If the `.map` method hangs with multiprocessing, set `num_proc=1` and process the dataset sequentially."
]
},
{
"cell_type": "code",
"execution_count": 8,
"id": "d041650e-1c48-4439-87b3-5b6f4a514107",
"metadata": {},
"outputs": [],
"source": [
"from transformers.models.whisper.english_normalizer import BasicTextNormalizer\n",
"normalizer = BasicTextNormalizer()"
]
},
{
"cell_type": "code",
"execution_count": 9,
"id": "c085911c-a10a-41ef-8874-306e0503e9bb",
"metadata": {},
"outputs": [],
"source": [
"def prepare_dataset(batch):\n",
" # load and (possibly) resample audio data to 16kHz\n",
" audio = batch[\"audio\"]\n",
"\n",
" # compute log-Mel input features from input audio array \n",
" batch[\"input_features\"] = processor.feature_extractor(audio[\"array\"], sampling_rate=audio[\"sampling_rate\"]).input_features[0]\n",
" # compute input length of audio sample in seconds\n",
" batch[\"input_length\"] = len(audio[\"array\"]) / audio[\"sampling_rate\"]\n",
" \n",
" # split chinese characters by space, as stated in the paper\n",
" sentence = batch[\"sentence\"]\n",
" sentence = \" \".join(sentence)\n",
" # normalize\n",
" sentence = normalizer(sentence)\n",
" \n",
" # encode target text to label ids\n",
" batch[\"labels\"] = processor.tokenizer(sentence).input_ids\n",
" return batch"
]
},
{
"cell_type": "code",
"execution_count": 10,
"id": "90965caa",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Extract features and normalize data:\n"
]
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "91de26e5528241e895f883a394bdab2a",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
" 0%| | 0/11277 [00:00<?, ?ex/s]"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"Loading cached processed dataset at /home/daniel/.cache/huggingface/datasets/mozilla-foundation___common_voice_11_0/zh-TW/11.0.0/f8e47235d9b4e68fa24ed71d63266a02018ccf7194b2a8c9c598a5f3ab304d9f/cache-e493134b08029cc3.arrow\n"
]
}
],
"source": [
"print('Extract features and normalize data:')\n",
"cv = cv.map(prepare_dataset, remove_columns=cv.column_names['train'], num_proc=1).with_format('torch')"
]
},
{
"cell_type": "code",
"execution_count": 11,
"id": "bde2118b",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"{'input_features': tensor([[-0.9590, -0.9590, -0.9590, ..., -0.9590, -0.9590, -0.9590],\n",
" [-0.9590, -0.9590, -0.9590, ..., -0.9590, -0.9590, -0.9590],\n",
" [-0.9590, -0.9590, -0.9590, ..., -0.9590, -0.9590, -0.9590],\n",
" ...,\n",
" [-0.9590, -0.9590, -0.9590, ..., -0.9590, -0.9590, -0.9590],\n",
" [-0.9590, -0.9590, -0.9590, ..., -0.9590, -0.9590, -0.9590],\n",
" [-0.9590, -0.9590, -0.9590, ..., -0.9590, -0.9590, -0.9590]]),\n",
" 'input_length': tensor(2.6400),\n",
" 'labels': tensor([50258, 50260, 50359, 50363, 23855, 220, 23855, 220, 4623, 220,\n",
" 34131, 220, 42117, 220, 27694, 42598, 220, 34043, 220, 50257])}"
]
},
"execution_count": 11,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"cv['train'][18]"
]
},
{
"cell_type": "markdown",
"id": "54ce0fdb-7218-4a4d-b175-383980fec0df",
"metadata": {},
"source": [
"Finally, we filter any training data with audio samples longer than 30s. These samples would otherwise be truncated by the Whisper feature-extractor which could affect the stability of training. We define a function that returns `True` for samples that are less than 30s, and `False` for those that are longer:"
]
},
{
"cell_type": "code",
"execution_count": 12,
"id": "01cb25ef-4bb0-4325-9461-f59198acadf6",
"metadata": {},
"outputs": [],
"source": [
"max_input_length = 30.0\n",
"\n",
"def is_audio_in_length_range(length):\n",
" return length < max_input_length"
]
},
{
"cell_type": "markdown",
"id": "30e676a8-7ca8-4850-8c5d-5b2b00d13fba",
"metadata": {},
"source": [
"We apply our filter function to all samples of our training dataset through 🤗 Datasets' `.filter` method:"
]
},
{
"cell_type": "code",
"execution_count": 13,
"id": "333f7f6e-6053-4d3b-8924-c733c79b82ac",
"metadata": {},
"outputs": [
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "bcef97571c7548c081de85f242931b21",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
" 0%| | 0/12 [00:00<?, ?ba/s]"
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"cv['train'] = cv['train'].filter(\n",
" is_audio_in_length_range,\n",
" input_columns=[\"input_length\"],\n",
")"
]
},
{
"cell_type": "code",
"execution_count": 14,
"id": "53945dcb",
"metadata": {},
"outputs": [],
"source": [
"cv[\"train\"] = cv[\"train\"].shuffle(seed=42, writer_batch_size=100)"
]
},
{
"cell_type": "markdown",
"id": "263a5a58-0239-4a25-b0df-c625fc9c5810",
"metadata": {
"id": "263a5a58-0239-4a25-b0df-c625fc9c5810"
},
"source": [
"## Training and Evaluation"
]
},
{
"cell_type": "markdown",
"id": "a693e768-c5a6-453f-89a1-b601dcf7daf7",
"metadata": {
"id": "a693e768-c5a6-453f-89a1-b601dcf7daf7"
},
"source": [
"Now that we've prepared our data, we're ready to dive into the training pipeline. \n",
"The [🤗 Trainer](https://huggingface.co/transformers/master/main_classes/trainer.html?highlight=trainer)\n",
"will do much of the heavy lifting for us. All we have to do is:\n",
"\n",
"- Define a data collator: the data collator takes our pre-processed data and prepares PyTorch tensors ready for the model.\n",
"\n",
"- Evaluation metrics: during evaluation, we want to evaluate the model using the [word error rate (WER)](https://huggingface.co/metrics/wer) metric. We need to define a `compute_metrics` function that handles this computation.\n",
"\n",
"- Load a pre-trained checkpoint: we need to load a pre-trained checkpoint and configure it correctly for training.\n",
"\n",
"- Define the training configuration: this will be used by the 🤗 Trainer to define the training schedule.\n",
"\n",
"Once we've fine-tuned the model, we will evaluate it on the test data to verify that we have correctly trained it \n",
"to transcribe speech in Hindi."
]
},
{
"cell_type": "markdown",
"id": "8d230e6d-624c-400a-bbf5-fa660881df25",
"metadata": {
"id": "8d230e6d-624c-400a-bbf5-fa660881df25"
},
"source": [
"### Define a Data Collator"
]
},
{
"cell_type": "markdown",
"id": "04def221-0637-4a69-b242-d3f0c1d0ee78",
"metadata": {
"id": "04def221-0637-4a69-b242-d3f0c1d0ee78"
},
"source": [
"The data collator for a sequence-to-sequence speech model is unique in the sense that it \n",
"treats the `input_features` and `labels` independently: the `input_features` must be \n",
"handled by the feature extractor and the `labels` by the tokenizer.\n",
"\n",
"The `input_features` are already padded to 30s and converted to a log-Mel spectrogram \n",
"of fixed dimension by action of the feature extractor, so all we have to do is convert the `input_features`\n",
"to batched PyTorch tensors. We do this using the feature extractor's `.pad` method with `return_tensors=pt`.\n",
"\n",
"The `labels` on the other hand are un-padded. We first pad the sequences\n",
"to the maximum length in the batch using the tokenizer's `.pad` method. The padding tokens \n",
"are then replaced by `-100` so that these tokens are **not** taken into account when \n",
"computing the loss. We then cut the BOS token from the start of the label sequence as we \n",
"append it later during training.\n",
"\n",
"We can leverage the `WhisperProcessor` we defined earlier to perform both the \n",
"feature extractor and the tokenizer operations:"
]
},
{
"cell_type": "code",
"execution_count": 15,
"id": "8326221e-ec13-4731-bb4e-51e5fc1486c5",
"metadata": {
"id": "8326221e-ec13-4731-bb4e-51e5fc1486c5"
},
"outputs": [],
"source": [
"import torch\n",
"\n",
"from dataclasses import dataclass\n",
"from typing import Any, Dict, List, Union\n",
"\n",
"@dataclass\n",
"class DataCollatorSpeechSeq2SeqWithPadding:\n",
" processor: Any\n",
"\n",
" def __call__(self, features: List[Dict[str, Union[List[int], torch.Tensor]]]) -> Dict[str, torch.Tensor]:\n",
" # split inputs and labels since they have to be of different lengths and need different padding methods\n",
" # first treat the audio inputs by simply returning torch tensors\n",
" input_features = [{\"input_features\": feature[\"input_features\"]} for feature in features]\n",
" batch = self.processor.feature_extractor.pad(input_features, return_tensors=\"pt\")\n",
"\n",
" # get the tokenized label sequences\n",
" label_features = [{\"input_ids\": feature[\"labels\"]} for feature in features]\n",
" # pad the labels to max length\n",
" labels_batch = self.processor.tokenizer.pad(label_features, return_tensors=\"pt\")\n",
"\n",
" # replace padding with -100 to ignore loss correctly\n",
" labels = labels_batch[\"input_ids\"].masked_fill(labels_batch.attention_mask.ne(1), -100)\n",
"\n",
" # if bos token is appended in previous tokenization step,\n",
" # cut bos token here as it's append later anyways\n",
" if (labels[:, 0] == self.processor.tokenizer.bos_token_id).all().cpu().item():\n",
" labels = labels[:, 1:]\n",
"\n",
" batch[\"labels\"] = labels\n",
"\n",
" return batch"
]
},
{
"cell_type": "markdown",
"id": "3cae7dbf-8a50-456e-a3a8-7fd005390f86",
"metadata": {
"id": "3cae7dbf-8a50-456e-a3a8-7fd005390f86"
},
"source": [
"Let's initialise the data collator we've just defined:"
]
},
{
"cell_type": "code",
"execution_count": 16,
"id": "fc834702-c0d3-4a96-b101-7b87be32bf42",
"metadata": {
"id": "fc834702-c0d3-4a96-b101-7b87be32bf42"
},
"outputs": [],
"source": [
"data_collator = DataCollatorSpeechSeq2SeqWithPadding(processor=processor)"
]
},
{
"cell_type": "markdown",
"id": "d62bb2ab-750a-45e7-82e9-61d6f4805698",
"metadata": {
"id": "d62bb2ab-750a-45e7-82e9-61d6f4805698"
},
"source": [
"### Evaluation Metrics"
]
},
{
"cell_type": "markdown",
"id": "66fee1a7-a44c-461e-b047-c3917221572e",
"metadata": {
"id": "66fee1a7-a44c-461e-b047-c3917221572e"
},
"source": [
"We'll use the word error rate (WER) metric, the 'de-facto' metric for assessing \n",
"ASR systems. For more information, refer to the WER [docs](https://huggingface.co/metrics/wer). We'll load the WER metric from 🤗 Evaluate:"
]
},
{
"cell_type": "code",
"execution_count": 17,
"id": "b22b4011-f31f-4b57-b684-c52332f92890",
"metadata": {
"id": "b22b4011-f31f-4b57-b684-c52332f92890"
},
"outputs": [],
"source": [
"import evaluate\n",
"\n",
"wer_metric = evaluate.load(\"wer\")"
]
},
{
"cell_type": "markdown",
"id": "4f32cab6-31f0-4cb9-af4c-40ba0f5fc508",
"metadata": {
"id": "4f32cab6-31f0-4cb9-af4c-40ba0f5fc508"
},
"source": [
"We then simply have to define a function that takes our model \n",
"predictions and returns the WER metric. This function, called\n",
"`compute_metrics`, first replaces `-100` with the `pad_token_id`\n",
"in the `label_ids` (undoing the step we applied in the \n",
"data collator to ignore padded tokens correctly in the loss).\n",
"It then decodes the predicted and label ids to strings. Finally,\n",
"it computes the WER between the predictions and reference labels. \n",
"Here, we have the option of evaluating with the 'normalised' transcriptions \n",
"and predictions. We recommend you set this to `True` to benefit from the WER \n",
"improvement obtained by normalising the transcriptions."
]
},
{
"cell_type": "code",
"execution_count": 18,
"id": "23959a70-22d0-4ffe-9fa1-72b61e75bb52",
"metadata": {
"id": "23959a70-22d0-4ffe-9fa1-72b61e75bb52"
},
"outputs": [],
"source": [
"# evaluate with the 'normalised' WER\n",
"do_normalize_eval = True\n",
"\n",
"def compute_metrics(pred):\n",
" pred_ids = pred.predictions\n",
" label_ids = pred.label_ids\n",
"\n",
" # replace -100 with the pad_token_id\n",
" label_ids[label_ids == -100] = processor.tokenizer.pad_token_id\n",
"\n",
" # we do not want to group tokens when computing the metrics\n",
" pred_str = processor.tokenizer.batch_decode(pred_ids, skip_special_tokens=True)\n",
" label_str = processor.tokenizer.batch_decode(label_ids, skip_special_tokens=True)\n",
"\n",
" if do_normalize_eval:\n",
" pred_str = [normalizer(pred) for pred in pred_str]\n",
" label_str = [normalizer(label) for label in label_str]\n",
"\n",
" wer = 100 * wer_metric.compute(predictions=pred_str, references=label_str)\n",
" \n",
" return {\"wer\": wer}"
]
},
{
"cell_type": "markdown",
"id": "daf2a825-6d9f-4a23-b145-c37c0039075b",
"metadata": {
"id": "daf2a825-6d9f-4a23-b145-c37c0039075b"
},
"source": [
"### Load a Pre-Trained Checkpoint"
]
},
{
"cell_type": "markdown",
"id": "437a97fa-4864-476b-8abc-f28b8166cfa5",
"metadata": {
"id": "437a97fa-4864-476b-8abc-f28b8166cfa5"
},
"source": [
"Now let's load the pre-trained Whisper `small` checkpoint. Again, this \n",
"is trivial through use of 🤗 Transformers!"
]
},
{
"cell_type": "code",
"execution_count": 19,
"id": "5a10cc4b-07ec-4ebd-ac1d-7c601023594f",
"metadata": {
"id": "5a10cc4b-07ec-4ebd-ac1d-7c601023594f"
},
"outputs": [],
"source": [
"from transformers import WhisperForConditionalGeneration\n",
"\n",
"model = WhisperForConditionalGeneration.from_pretrained(\"openai/whisper-medium\")"
]
},
{
"cell_type": "markdown",
"id": "a15ead5f-2277-4a39-937b-585c2497b2df",
"metadata": {
"id": "a15ead5f-2277-4a39-937b-585c2497b2df"
},
"source": [
"Override generation arguments - no tokens are forced as decoder outputs (see [`forced_decoder_ids`](https://huggingface.co/docs/transformers/main_classes/text_generation#transformers.generation_utils.GenerationMixin.generate.forced_decoder_ids)), no tokens are suppressed during generation (see [`suppress_tokens`](https://huggingface.co/docs/transformers/main_classes/text_generation#transformers.generation_utils.GenerationMixin.generate.suppress_tokens)). Set `use_cache` to False since we're using gradient checkpointing, and the two are incompatible:"
]
},
{
"cell_type": "code",
"execution_count": 20,
"id": "62038ba3-88ed-4fce-84db-338f50dcd04f",
"metadata": {
"id": "62038ba3-88ed-4fce-84db-338f50dcd04f"
},
"outputs": [],
"source": [
"model.config.forced_decoder_ids = None\n",
"model.config.suppress_tokens = []\n",
"model.config.use_cache = False"
]
},
{
"cell_type": "markdown",
"id": "2178dea4-80ca-47b6-b6ea-ba1915c90c06",
"metadata": {
"id": "2178dea4-80ca-47b6-b6ea-ba1915c90c06"
},
"source": [
"### Define the Training Configuration"
]
},
{
"cell_type": "markdown",
"id": "c21af1e9-0188-4134-ac82-defc7bdcc436",
"metadata": {
"id": "c21af1e9-0188-4134-ac82-defc7bdcc436"
},
"source": [
"In the final step, we define all the parameters related to training. For more detail on the training arguments, refer to the Seq2SeqTrainingArguments [docs](https://huggingface.co/docs/transformers/main_classes/trainer#transformers.Seq2SeqTrainingArguments)."
]
},
{
"cell_type": "code",
"execution_count": 21,
"id": "0ae3e9af-97b7-4aa0-ae85-20b23b5bcb3a",
"metadata": {
"id": "0ae3e9af-97b7-4aa0-ae85-20b23b5bcb3a"
},
"outputs": [],
"source": [
"from transformers import Seq2SeqTrainingArguments\n",
"\n",
"training_args = Seq2SeqTrainingArguments(\n",
" output_dir=\"./\",\n",
" per_device_train_batch_size=2,\n",
" gradient_accumulation_steps=16, # increase by 2x for every 2x decrease in batch size\n",
" learning_rate=1e-5,\n",
" warmup_steps=100,\n",
" max_steps=1000,\n",
" gradient_checkpointing=True,\n",
" fp16=True,\n",
" evaluation_strategy=\"steps\",\n",
" per_device_eval_batch_size=2,\n",
" predict_with_generate=True,\n",
" generation_max_length=225,\n",
" save_steps=200,\n",
" eval_steps=200,\n",
" logging_steps=25,\n",
" report_to=[\"tensorboard\"],\n",
" load_best_model_at_end=True,\n",
" metric_for_best_model=\"wer\",\n",
" greater_is_better=False,\n",
" push_to_hub=True,\n",
" optim='adamw_bnb_8bit'\n",
")"
]
},
{
"cell_type": "markdown",
"id": "b3a944d8-3112-4552-82a0-be25988b3857",
"metadata": {
"id": "b3a944d8-3112-4552-82a0-be25988b3857"
},
"source": [
"**Note**: if one does not want to upload the model checkpoints to the Hub, \n",
"set `push_to_hub=False`."
]
},
{
"cell_type": "markdown",
"id": "bac29114-d226-4f54-97cf-8718c9f94e1e",
"metadata": {
"id": "bac29114-d226-4f54-97cf-8718c9f94e1e"
},
"source": [
"We can forward the training arguments to the 🤗 Trainer along with our model,\n",
"dataset, data collator and `compute_metrics` function:"
]
},
{
"cell_type": "code",
"execution_count": 22,
"id": "d546d7fe-0543-479a-b708-2ebabec19493",
"metadata": {
"id": "d546d7fe-0543-479a-b708-2ebabec19493",
"scrolled": false
},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"/mnt/c/projects/asr/whisper-medium-zh-TW-augmented/./ is already a clone of https://huggingface.co/Scrya/whisper-medium-zh-TW-augmented. Make sure you pull the latest changes with `repo.git_pull()`.\n",
"max_steps is given, it will override any value given in num_train_epochs\n",
"Using cuda_amp half precision backend\n"
]
}
],
"source": [
"from transformers import Seq2SeqTrainer\n",
"\n",
"trainer = Seq2SeqTrainer(\n",
" args=training_args,\n",
" model=model,\n",
" train_dataset=cv['train'],\n",
" eval_dataset=cv['test'],\n",
" data_collator=data_collator,\n",
" compute_metrics=compute_metrics,\n",
" tokenizer=processor.feature_extractor,\n",
")"
]
},
{
"cell_type": "markdown",
"id": "uOrRhDGtN5S4",
"metadata": {
"id": "uOrRhDGtN5S4"
},
"source": [
"We'll save the processor object once before starting training. Since the processor is not trainable, it won't change over the course of training:"
]
},
{
"cell_type": "code",
"execution_count": 23,
"id": "-2zQwMfEOBJq",
"metadata": {
"id": "-2zQwMfEOBJq"
},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"Feature extractor saved in ./preprocessor_config.json\n",
"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"
]
}
],
"source": [
"processor.save_pretrained(training_args.output_dir)"
]
},
{
"cell_type": "markdown",
"id": "7f404cf9-4345-468c-8196-4bd101d9bd51",
"metadata": {
"id": "7f404cf9-4345-468c-8196-4bd101d9bd51"
},
"source": [
"### Training"
]
},
{
"cell_type": "markdown",
"id": "5e8b8d56-5a70-4f68-bd2e-f0752d0bd112",
"metadata": {
"id": "5e8b8d56-5a70-4f68-bd2e-f0752d0bd112"
},
"source": [
"Training will take approximately 5-10 hours depending on your GPU. The peak GPU memory for the given training configuration is approximately 36GB. \n",
"Depending on your GPU, it is possible that you will encounter a CUDA `\"out-of-memory\"` error when you launch training. \n",
"In this case, you can reduce the `per_device_train_batch_size` incrementally by factors of 2 \n",
"and employ [`gradient_accumulation_steps`](https://huggingface.co/docs/transformers/main_classes/trainer#transformers.Seq2SeqTrainingArguments.gradient_accumulation_steps)\n",
"to compensate.\n",
"\n",
"To launch training, simply execute:"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "ee8b7b8e-1c9a-4d77-9137-1778a629e6de",
"metadata": {
"id": "ee8b7b8e-1c9a-4d77-9137-1778a629e6de",
"scrolled": false
},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"The following columns in the training set don't have a corresponding argument in `WhisperForConditionalGeneration.forward` and have been ignored: input_length. If input_length are not expected by `WhisperForConditionalGeneration.forward`, you can safely ignore this message.\n",
"***** Running training *****\n",
" Num examples = 11277\n",
" Num Epochs = 3\n",
" Instantaneous batch size per device = 2\n",
" Total train batch size (w. parallel, distributed & accumulation) = 32\n",
" Gradient Accumulation steps = 16\n",
" Total optimization steps = 1000\n",
" Number of trainable parameters = 763857920\n"
]
},
{
"data": {
"text/html": [
"\n",
" <div>\n",
" \n",
" <progress value='601' max='1000' style='width:300px; height:20px; vertical-align: middle;'></progress>\n",
" [ 601/1000 3:16:05 < 2:10:37, 0.05 it/s, Epoch 1.70/3]\n",
" </div>\n",
" <table border=\"1\" class=\"dataframe\">\n",
" <thead>\n",
" <tr style=\"text-align: left;\">\n",
" <th>Step</th>\n",
" <th>Training Loss</th>\n",
" <th>Validation Loss</th>\n",
" <th>Wer</th>\n",
" </tr>\n",
" </thead>\n",
" <tbody>\n",
" <tr>\n",
" <td>200</td>\n",
" <td>0.216900</td>\n",
" <td>0.119112</td>\n",
" <td>9.333440</td>\n",
" </tr>\n",
" <tr>\n",
" <td>400</td>\n",
" <td>0.082300</td>\n",
" <td>0.101187</td>\n",
" <td>7.590416</td>\n",
" </tr>\n",
" <tr>\n",
" <td>600</td>\n",
" <td>0.078400</td>\n",
" <td>0.095110</td>\n",
" <td>7.486474</td>\n",
" </tr>\n",
" </tbody>\n",
"</table><p>"
],
"text/plain": [
"<IPython.core.display.HTML object>"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"The following columns in the evaluation set don't have a corresponding argument in `WhisperForConditionalGeneration.forward` and have been ignored: input_length. If input_length are not expected by `WhisperForConditionalGeneration.forward`, you can safely ignore this message.\n",
"***** Running Evaluation *****\n",
" Num examples = 4709\n",
" Batch size = 2\n",
"Saving model checkpoint to ./checkpoint-200\n",
"Configuration saved in ./checkpoint-200/config.json\n",
"Model weights saved in ./checkpoint-200/pytorch_model.bin\n",
"Feature extractor saved in ./checkpoint-200/preprocessor_config.json\n",
"Feature extractor saved in ./preprocessor_config.json\n",
"The following columns in the evaluation set don't have a corresponding argument in `WhisperForConditionalGeneration.forward` and have been ignored: input_length. If input_length are not expected by `WhisperForConditionalGeneration.forward`, you can safely ignore this message.\n",
"***** Running Evaluation *****\n",
" Num examples = 4709\n",
" Batch size = 2\n",
"Saving model checkpoint to ./checkpoint-400\n",
"Configuration saved in ./checkpoint-400/config.json\n",
"Model weights saved in ./checkpoint-400/pytorch_model.bin\n",
"Feature extractor saved in ./checkpoint-400/preprocessor_config.json\n",
"Feature extractor saved in ./preprocessor_config.json\n",
"The following columns in the evaluation set don't have a corresponding argument in `WhisperForConditionalGeneration.forward` and have been ignored: input_length. If input_length are not expected by `WhisperForConditionalGeneration.forward`, you can safely ignore this message.\n",
"***** Running Evaluation *****\n",
" Num examples = 4709\n",
" Batch size = 2\n",
"Saving model checkpoint to ./checkpoint-600\n",
"Configuration saved in ./checkpoint-600/config.json\n",
"Model weights saved in ./checkpoint-600/pytorch_model.bin\n",
"Feature extractor saved in ./checkpoint-600/preprocessor_config.json\n",
"Feature extractor saved in ./preprocessor_config.json\n"
]
}
],
"source": [
"trainer.train()"
]
},
{
"cell_type": "markdown",
"id": "810ced54-7187-4a06-b2fe-ba6dcca94dc3",
"metadata": {
"id": "810ced54-7187-4a06-b2fe-ba6dcca94dc3"
},
"source": [
"We can label our checkpoint with the `whisper-event` tag on push by setting the appropriate key-word arguments (kwargs):"
]
},
{
"cell_type": "code",
"execution_count": 28,
"id": "c704f91e-241b-48c9-b8e0-f0da396a9663",
"metadata": {
"id": "c704f91e-241b-48c9-b8e0-f0da396a9663"
},
"outputs": [],
"source": [
"kwargs = {\n",
" \"dataset_tags\": \"mozilla-foundation/common_voice_11_0\",\n",
" \"dataset\": \"mozilla-foundation/common_voice_11_0\", # a 'pretty' name for the training dataset\n",
" \"language\": \"zh-TW\",\n",
" \"model_name\": \"Whisper Medium TW - Augmented\", # a 'pretty' name for your model\n",
" \"finetuned_from\": \"openai/whisper-medium\",\n",
" \"tasks\": \"automatic-speech-recognition\",\n",
" \"tags\": \"whisper-event\",\n",
"}"
]
},
{
"cell_type": "markdown",
"id": "090d676a-f944-4297-a938-a40eda0b2b68",
"metadata": {
"id": "090d676a-f944-4297-a938-a40eda0b2b68"
},
"source": [
"The training results can now be uploaded to the Hub. To do so, execute the `push_to_hub` command and save the preprocessor object we created:"
]
},
{
"cell_type": "code",
"execution_count": 29,
"id": "d7030622-caf7-4039-939b-6195cdaa2585",
"metadata": {
"id": "d7030622-caf7-4039-939b-6195cdaa2585"
},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"Saving model checkpoint to ./\n",
"Configuration saved in ./config.json\n",
"Model weights saved in ./pytorch_model.bin\n",
"Feature extractor saved in ./preprocessor_config.json\n",
"Several commits (3) will be pushed upstream.\n",
"The progress bars may be unreliable.\n",
"To https://huggingface.co/Scrya/whisper-medium-ms-augmented\n",
" 1684a4c..b46b3bd main -> main\n",
"\n"
]
}
],
"source": [
"trainer.push_to_hub(**kwargs)"
]
},
{
"cell_type": "code",
"execution_count": 35,
"id": "9659fee2",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"{'eval_loss': 0.20663268864154816,\n",
" 'eval_wer': 9.578362255965294,\n",
" 'eval_cer': 2.8109053797929726,\n",
" 'eval_runtime': 873.5198,\n",
" 'eval_samples_per_second': 0.857,\n",
" 'eval_steps_per_second': 0.429,\n",
" 'epoch': 10.75,\n",
" 'step': 1000}"
]
},
"execution_count": 35,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"trainer.state.log_history[-2]['eval_wer']"
]
},
{
"cell_type": "code",
"execution_count": 36,
"id": "25703cb1",
"metadata": {},
"outputs": [
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "4ea15f06fd6643ae94ab2a23ee1a1a71",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"Downloading: 0%| | 0.00/2.15k [00:00<?, ?B/s]"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/plain": [
"'https://huggingface.co/Scrya/whisper-medium-ms-augmented/blob/main/README.md'"
]
},
"execution_count": 36,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"evaluate.push_to_hub(\n",
" model_id='Scrya/whisper-medium-zh-TW-augmented',\n",
" metric_value=trainer.state.log_history[-2]['eval_wer'],\n",
" metric_type=\"wer\",\n",
" metric_name=\"WER\",\n",
" dataset_name='mozilla-foundation/common_voice_11_0',\n",
" dataset_type='mozilla-foundation/common_voice_11_0',\n",
" dataset_split='test',\n",
" dataset_config='zh-TW',\n",
" task_type=\"automatic-speech-recognition\",\n",
" task_name=\"Automatic Speech Recognition\"\n",
")"
]
},
{
"cell_type": "markdown",
"id": "ca743fbd-602c-48d4-ba8d-a2fe60af64ba",
"metadata": {
"id": "ca743fbd-602c-48d4-ba8d-a2fe60af64ba"
},
"source": [
"## Closing Remarks"
]
},
{
"cell_type": "markdown",
"id": "7f737783-2870-4e35-aa11-86a42d7d997a",
"metadata": {
"id": "7f737783-2870-4e35-aa11-86a42d7d997a"
},
"source": [
"In this blog, we covered a step-by-step guide on fine-tuning Whisper for multilingual ASR \n",
"using 🤗 Datasets, Transformers and the Hugging Face Hub. For more details on the Whisper model, the Common Voice dataset and the theory behind fine-tuning, refere to the accompanying [blog post](https://huggingface.co/blog/fine-tune-whisper). If you're interested in fine-tuning other \n",
"Transformers models, both for English and multilingual ASR, be sure to check out the \n",
"examples scripts at [examples/pytorch/speech-recognition](https://github.com/huggingface/transformers/tree/main/examples/pytorch/speech-recognition)."
]
}
],
"metadata": {
"colab": {
"include_colab_link": true,
"provenance": []
},
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.10"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
|