jonatasgrosman commited on
Commit
eb3daff
1 Parent(s): 8860967

first commit

Browse files
README.md ADDED
@@ -0,0 +1,161 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: fa
3
+ datasets:
4
+ - common_voice
5
+ metrics:
6
+ - wer
7
+ - cer
8
+ tags:
9
+ - audio
10
+ - automatic-speech-recognition
11
+ - speech
12
+ - xlsr-fine-tuning-week
13
+ license: apache-2.0
14
+ model-index:
15
+ - name: XLSR Wav2Vec2 Persian by Jonatas Grosman
16
+ results:
17
+ - task:
18
+ name: Speech Recognition
19
+ type: automatic-speech-recognition
20
+ dataset:
21
+ name: Common Voice fa
22
+ type: common_voice
23
+ args: fa
24
+ metrics:
25
+ - name: Test WER
26
+ type: wer
27
+ value: 11.90
28
+ - name: Test CER
29
+ type: cer
30
+ value: 2.94
31
+ ---
32
+
33
+ # Wav2Vec2-Large-XLSR-53-Persian
34
+
35
+ Fine-tuned [facebook/wav2vec2-large-xlsr-53](https://huggingface.co/facebook/wav2vec2-large-xlsr-53) on Persian using the [Common Voice](https://huggingface.co/datasets/common_voice).
36
+ When using this model, make sure that your speech input is sampled at 16kHz.
37
+
38
+ The script used for training can be found here: https://github.com/jonatasgrosman/wav2vec2-sprint
39
+
40
+ ## Usage
41
+
42
+ The model can be used directly (without a language model) as follows:
43
+
44
+ ```python
45
+ import torch
46
+ import librosa
47
+ from datasets import load_dataset
48
+ from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor
49
+
50
+ LANG_ID = "fa"
51
+ MODEL_ID = "jonatasgrosman/wav2vec2-large-xlsr-53-persian"
52
+ SAMPLES = 5
53
+
54
+ test_dataset = load_dataset("common_voice", LANG_ID, split=f"test[:{SAMPLES}]")
55
+
56
+ processor = Wav2Vec2Processor.from_pretrained(MODEL_ID)
57
+ model = Wav2Vec2ForCTC.from_pretrained(MODEL_ID)
58
+
59
+ # Preprocessing the datasets.
60
+ # We need to read the audio files as arrays
61
+ def speech_file_to_array_fn(batch):
62
+ speech_array, sampling_rate = librosa.load(batch["path"], sr=16_000)
63
+ batch["speech"] = speech_array
64
+ batch["sentence"] = batch["sentence"].upper()
65
+ return batch
66
+
67
+ test_dataset = test_dataset.map(speech_file_to_array_fn)
68
+ inputs = processor(test_dataset["speech"], sampling_rate=16_000, return_tensors="pt", padding=True)
69
+
70
+ with torch.no_grad():
71
+ logits = model(inputs.input_values, attention_mask=inputs.attention_mask).logits
72
+
73
+ predicted_ids = torch.argmax(logits, dim=-1)
74
+ predicted_sentences = processor.batch_decode(predicted_ids)
75
+
76
+ for i, predicted_sentence in enumerate(predicted_sentences):
77
+ print("-" * 100)
78
+ print("Reference:", test_dataset[i]["sentence"])
79
+ print("Prediction:", predicted_sentence)
80
+ ```
81
+
82
+ | Reference | Prediction |
83
+ | ------------- | ------------- |
84
+ | _ | _ |
85
+ | _ | _ |
86
+ | _ | _ |
87
+ | _ | _ |
88
+ | _ | _ |
89
+
90
+ ## Evaluation
91
+
92
+ The model can be evaluated as follows on the Persian test data of Common Voice.
93
+
94
+ ```python
95
+ import torch
96
+ import re
97
+ import librosa
98
+ from datasets import load_dataset, load_metric
99
+ from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor
100
+
101
+ LANG_ID = "fa"
102
+ MODEL_ID = "jonatasgrosman/wav2vec2-large-xlsr-53-persian"
103
+ DEVICE = "cuda"
104
+
105
+ CHARS_TO_IGNORE = [",", "?", "¿", ".", "!", "¡", ";", ":", '""', "%", '"', "�", "ʿ", "·", "჻", "~", "՞",
106
+ "؟", "،", "।", "॥", "«", "»", "„", "“", "”", "「", "」", "‘", "’", "《", "》", "(", ")", "[", "]",
107
+ "=", "`", "_", "+", "<", ">", "…", "–", "°", "´", "ʾ", "‹", "›", "©", "®", "—", "→", "。"]
108
+
109
+ test_dataset = load_dataset("common_voice", LANG_ID, split="test")
110
+
111
+ wer = load_metric("wer.py") # https://github.com/jonatasgrosman/wav2vec2-sprint/blob/main/wer.py
112
+ cer = load_metric("cer.py") # https://github.com/jonatasgrosman/wav2vec2-sprint/blob/main/cer.py
113
+
114
+ chars_to_ignore_regex = f"[{re.escape(''.join(CHARS_TO_IGNORE))}]"
115
+
116
+ processor = Wav2Vec2Processor.from_pretrained(MODEL_ID)
117
+ model = Wav2Vec2ForCTC.from_pretrained(MODEL_ID)
118
+ model.to(DEVICE)
119
+
120
+ # Preprocessing the datasets.
121
+ # We need to read the audio files as arrays
122
+ def speech_file_to_array_fn(batch):
123
+ with warnings.catch_warnings():
124
+ warnings.simplefilter("ignore")
125
+ speech_array, sampling_rate = librosa.load(batch["path"], sr=16_000)
126
+ batch["speech"] = speech_array
127
+ batch["sentence"] = re.sub(chars_to_ignore_regex, "", batch["sentence"]).upper()
128
+ return batch
129
+
130
+ test_dataset = test_dataset.map(speech_file_to_array_fn)
131
+
132
+ # Preprocessing the datasets.
133
+ # We need to read the audio files as arrays
134
+ def evaluate(batch):
135
+ inputs = processor(batch["speech"], sampling_rate=16_000, return_tensors="pt", padding=True)
136
+
137
+ with torch.no_grad():
138
+ logits = model(inputs.input_values.to(DEVICE), attention_mask=inputs.attention_mask.to(DEVICE)).logits
139
+
140
+ pred_ids = torch.argmax(logits, dim=-1)
141
+ batch["pred_strings"] = processor.batch_decode(pred_ids)
142
+ return batch
143
+
144
+ result = test_dataset.map(evaluate, batched=True, batch_size=8)
145
+
146
+ predictions = [x.upper() for x in result["pred_strings"]]
147
+ references = [x.upper() for x in result["sentence"]]
148
+
149
+ print(f"WER: {wer.compute(predictions=predictions, references=references, chunk_size=1000) * 100}")
150
+ print(f"CER: {cer.compute(predictions=predictions, references=references, chunk_size=1000) * 100}")
151
+ ```
152
+
153
+ **Test Result**:
154
+
155
+ My model may report better scores than others because of some specificity of my evaluation script, so I ran the same evaluation script on other models (on 2021-04-22) to make a fairer comparison.
156
+
157
+ | Model | WER | CER |
158
+ | ------------- | ------------- | ------------- |
159
+ | jonatasgrosman/wav2vec2-large-xlsr-53-persian | **30.12%** | **7.37%** |
160
+ | m3hrdadfi/wav2vec2-large-xlsr-persian-v2 | 33.85% | 8.79% |
161
+ | m3hrdadfi/wav2vec2-large-xlsr-persian | 34.37% | 8.98% |
config.json ADDED
@@ -0,0 +1,76 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "facebook/wav2vec2-large-xlsr-53",
3
+ "activation_dropout": 0.05,
4
+ "apply_spec_augment": true,
5
+ "architectures": [
6
+ "Wav2Vec2ForCTC"
7
+ ],
8
+ "attention_dropout": 0.1,
9
+ "bos_token_id": 1,
10
+ "conv_bias": true,
11
+ "conv_dim": [
12
+ 512,
13
+ 512,
14
+ 512,
15
+ 512,
16
+ 512,
17
+ 512,
18
+ 512
19
+ ],
20
+ "conv_kernel": [
21
+ 10,
22
+ 3,
23
+ 3,
24
+ 3,
25
+ 3,
26
+ 2,
27
+ 2
28
+ ],
29
+ "conv_stride": [
30
+ 5,
31
+ 2,
32
+ 2,
33
+ 2,
34
+ 2,
35
+ 2,
36
+ 2
37
+ ],
38
+ "ctc_loss_reduction": "mean",
39
+ "ctc_zero_infinity": true,
40
+ "do_stable_layer_norm": true,
41
+ "eos_token_id": 2,
42
+ "feat_extract_activation": "gelu",
43
+ "feat_extract_dropout": 0.0,
44
+ "feat_extract_norm": "layer",
45
+ "feat_proj_dropout": 0.05,
46
+ "final_dropout": 0.0,
47
+ "gradient_checkpointing": true,
48
+ "hidden_act": "gelu",
49
+ "hidden_dropout": 0.05,
50
+ "hidden_size": 1024,
51
+ "initializer_range": 0.02,
52
+ "intermediate_size": 4096,
53
+ "layer_norm_eps": 1e-05,
54
+ "layerdrop": 0.05,
55
+ "mask_channel_length": 10,
56
+ "mask_channel_min_space": 1,
57
+ "mask_channel_other": 0.0,
58
+ "mask_channel_prob": 0.0,
59
+ "mask_channel_selection": "static",
60
+ "mask_feature_length": 10,
61
+ "mask_feature_prob": 0.0,
62
+ "mask_time_length": 10,
63
+ "mask_time_min_space": 1,
64
+ "mask_time_other": 0.0,
65
+ "mask_time_prob": 0.05,
66
+ "mask_time_selection": "static",
67
+ "model_type": "wav2vec2",
68
+ "num_attention_heads": 16,
69
+ "num_conv_pos_embedding_groups": 16,
70
+ "num_conv_pos_embeddings": 128,
71
+ "num_feat_extract_layers": 7,
72
+ "num_hidden_layers": 24,
73
+ "pad_token_id": 0,
74
+ "transformers_version": "4.5.0.dev0",
75
+ "vocab_size": 67
76
+ }
preprocessor_config.json ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "do_normalize": true,
3
+ "feature_size": 1,
4
+ "padding_side": "right",
5
+ "padding_value": 0.0,
6
+ "return_attention_mask": true,
7
+ "sampling_rate": 16000
8
+ }
pytorch_model.bin ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:3b859c7f562a2cc3c6002c2eb5178b66777406c4fccf53f196ead46a4f6c4796
3
+ size 1262208535
special_tokens_map.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"bos_token": "<s>", "eos_token": "</s>", "unk_token": "<unk>", "pad_token": "<pad>"}
vocab.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"<pad>": 0, "<s>": 1, "</s>": 2, "<unk>": 3, "|": 4, "٬": 5, "و": 6, "ـ": 7, "ئ": 8, "ل": 9, "ج": 10, "ک": 11, "R": 12, "ِ": 13, "ع": 14, "َ": 15, "م": 16, "ض": 17, "-": 18, "I": 19, "F": 20, "ذ": 21, "ن": 22, "ژ": 23, "A": 24, "ش": 25, "ث": 26, "Y": 27, "د": 28, "ر": 29, "ّ": 30, "أ": 31, "ق": 32, "ب": 33, "ح": 34, "ظ": 35, "پ": 36, "ت": 37, "خ": 38, "غ": 39, "ط": 40, "ك": 41, "ي": 42, "E": 43, "Ā": 44, "؛": 45, "ی": 46, "چ": 47, "ه": 48, "M": 49, "ف": 50, "آ": 51, "ز": 52, "ص": 53, "س": 54, "گ": 55, "N": 56, "ُ": 57, "T": 58, "S": 59, "Š": 60, "ٔ": 61, "B": 62, "ء": 63, "ً": 64, "ا": 65, "ى": 66}