Create README.md
Browse files
README.md
ADDED
@@ -0,0 +1,138 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
language: cv
|
3 |
+
datasets:
|
4 |
+
- common_voice
|
5 |
+
metrics:
|
6 |
+
- wer
|
7 |
+
tags:
|
8 |
+
- audio
|
9 |
+
- automatic-speech-recognition
|
10 |
+
- speech
|
11 |
+
- xlsr-fine-tuning-week
|
12 |
+
license: apache-2.0
|
13 |
+
model-index:
|
14 |
+
- name: wav2vec2-xlsr-chuvash
|
15 |
+
results:
|
16 |
+
- task:
|
17 |
+
name: Speech Recognition
|
18 |
+
type: automatic-speech-recognition
|
19 |
+
dataset:
|
20 |
+
name: Common Voice cv
|
21 |
+
type: common_voice
|
22 |
+
args: cv
|
23 |
+
metrics:
|
24 |
+
- name: Test WER
|
25 |
+
type: wer
|
26 |
+
value: 48.40
|
27 |
+
---
|
28 |
+
|
29 |
+
# Wav2Vec2-Large-XLSR-53-Punjabi
|
30 |
+
|
31 |
+
Fine-tuned [facebook/wav2vec2-large-xlsr-53](https://huggingface.co/facebook/wav2vec2-large-xlsr-53) on Chuvash using the [Common Voice](https://huggingface.co/datasets/common_voice)
|
32 |
+
|
33 |
+
When using this model, make sure that your speech input is sampled at 16kHz.
|
34 |
+
|
35 |
+
## Usage
|
36 |
+
|
37 |
+
The model can be used directly (without a language model) as follows:
|
38 |
+
|
39 |
+
```python
|
40 |
+
import torch
|
41 |
+
import torchaudio
|
42 |
+
from datasets import load_dataset
|
43 |
+
from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor
|
44 |
+
|
45 |
+
test_dataset = load_dataset("common_voice", "cv", split="test")
|
46 |
+
|
47 |
+
processor = Wav2Vec2Processor.from_pretrained("gagan3012/wav2vec2-xlsr-chuvash")
|
48 |
+
model = Wav2Vec2ForCTC.from_pretrained("gagan3012/wav2vec2-xlsr-chuvash")
|
49 |
+
|
50 |
+
resampler = torchaudio.transforms.Resample(48_000, 16_000)
|
51 |
+
|
52 |
+
# Preprocessing the datasets.
|
53 |
+
# We need to read the aduio files as arrays
|
54 |
+
def speech_file_to_array_fn(batch):
|
55 |
+
speech_array, sampling_rate = torchaudio.load(batch["path"])
|
56 |
+
batch["speech"] = resampler(speech_array).squeeze().numpy()
|
57 |
+
return batch
|
58 |
+
|
59 |
+
test_dataset = test_dataset.map(speech_file_to_array_fn)
|
60 |
+
inputs = processor(test_dataset["speech"][:2], sampling_rate=16_000, return_tensors="pt", padding=True)
|
61 |
+
|
62 |
+
with torch.no_grad():
|
63 |
+
logits = model(inputs.input_values, attention_mask=inputs.attention_mask).logits
|
64 |
+
|
65 |
+
predicted_ids = torch.argmax(logits, dim=-1)
|
66 |
+
|
67 |
+
print("Prediction:", processor.batch_decode(predicted_ids))
|
68 |
+
print("Reference:", test_dataset["sentence"][:2])
|
69 |
+
|
70 |
+
```
|
71 |
+
|
72 |
+
#### Results:
|
73 |
+
|
74 |
+
Prediction: ['ਹਵਾ ਲਾਤ ਵਿੱਚ ਪੰਦ ਛੇ ਇਖਲਾਟਕੀ ਮੁਜਰਮ ਸਨ', 'ਮੈ ਇ ਹਾ ਪੈਸੇ ਲੇਹੜ ਨਹੀਂ ਸੀ ਚੌਨਾ']
|
75 |
+
|
76 |
+
Reference: ['ਹਵਾਲਾਤ ਵਿੱਚ ਪੰਜ ਛੇ ਇਖ਼ਲਾਕੀ ਮੁਜਰਮ ਸਨ', 'ਮੈਂ ਇਹ ਪੈਸੇ ਲੈਣੇ ਨਹੀਂ ਸੀ ਚਾਹੁੰਦਾ']
|
77 |
+
|
78 |
+
## Evaluation
|
79 |
+
|
80 |
+
The model can be evaluated as follows on the Chuvash test data of Common Voice.
|
81 |
+
|
82 |
+
```python
|
83 |
+
import torch
|
84 |
+
import torchaudio
|
85 |
+
from datasets import load_dataset, load_metric
|
86 |
+
from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor
|
87 |
+
import re
|
88 |
+
|
89 |
+
!mkdir cer
|
90 |
+
!wget -O cer/cer.py https://huggingface.co/ctl/wav2vec2-large-xlsr-cantonese/raw/main/cer.py
|
91 |
+
|
92 |
+
test_dataset = load_dataset("common_voice", "cv", split="test") #TODO: replace {lang_id} in your language code here. Make sure the code is one of the *ISO codes* of [this](https://huggingface.co/languages) site.
|
93 |
+
wer = load_metric("wer")
|
94 |
+
cer = load_metric("cer")
|
95 |
+
|
96 |
+
processor = Wav2Vec2Processor.from_pretrained("gagan3012/wav2vec2-xlsr-chuvash")
|
97 |
+
model = Wav2Vec2ForCTC.from_pretrained("gagan3012/wav2vec2-xlsr-chuvash")
|
98 |
+
model.to("cuda")
|
99 |
+
|
100 |
+
|
101 |
+
|
102 |
+
chars_to_ignore_regex = '[\,\?\.\!\-\;\:\"\“]' # TODO: adapt this list to include all special characters you removed from the data
|
103 |
+
resampler = torchaudio.transforms.Resample(48_000, 16_000)
|
104 |
+
|
105 |
+
# Preprocessing the datasets.
|
106 |
+
# We need to read the aduio files as arrays
|
107 |
+
def speech_file_to_array_fn(batch):
|
108 |
+
batch["sentence"] = re.sub(chars_to_ignore_regex, '', batch["sentence"]).lower()
|
109 |
+
speech_array, sampling_rate = torchaudio.load(batch["path"])
|
110 |
+
batch["speech"] = resampler(speech_array).squeeze().numpy()
|
111 |
+
return batch
|
112 |
+
|
113 |
+
test_dataset = test_dataset.map(speech_file_to_array_fn)
|
114 |
+
|
115 |
+
# Preprocessing the datasets.
|
116 |
+
# We need to read the aduio files as arrays
|
117 |
+
def evaluate(batch):
|
118 |
+
inputs = processor(batch["speech"], sampling_rate=16_000, return_tensors="pt", padding=True)
|
119 |
+
|
120 |
+
with torch.no_grad():
|
121 |
+
logits = model(inputs.input_values.to("cuda"), attention_mask=inputs.attention_mask.to("cuda")).logits
|
122 |
+
|
123 |
+
pred_ids = torch.argmax(logits, dim=-1)
|
124 |
+
batch["pred_strings"] = processor.batch_decode(pred_ids)
|
125 |
+
return batch
|
126 |
+
|
127 |
+
result = test_dataset.map(evaluate, batched=True, batch_size=8)
|
128 |
+
|
129 |
+
print("WER: {:2f}".format(100 * wer.compute(predictions=result["pred_strings"], references=result["sentence"])))
|
130 |
+
print("CER: {:2f}".format(100 * cer.compute(predictions=result["pred_strings"], references=result["sentence"])))
|
131 |
+
```
|
132 |
+
|
133 |
+
**Test Result**: 48.40 %
|
134 |
+
|
135 |
+
|
136 |
+
## Training
|
137 |
+
|
138 |
+
The script used for training can be found [here](https://colab.research.google.com/drive/1A7Y20c1QkSHfdOmLXPMiOEpwlTjDZ7m5?usp=sharing)
|