imvladikon commited on
Commit
171b594
1 Parent(s): 483a9de

update readme

Browse files
Files changed (1) hide show
  1. README.md +91 -0
README.md CHANGED
@@ -0,0 +1,91 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: he
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: Hebrew XLSR Wav2Vec2 Large 53
15
+ results:
16
+ - task:
17
+ name: Speech Recognition
18
+ type: automatic-speech-recognition
19
+ dataset:
20
+ name:
21
+ type:
22
+ args: he
23
+ metrics:
24
+ - name: Test WER
25
+ type: wer
26
+ value:
27
+ ---
28
+ # wav2vec2-large-xlsr-53-hebrew
29
+ Fine-tuned [facebook/wav2vec2-large-xlsr-53](https://huggingface.co/facebook/wav2vec2-large-xlsr-53) on the several downloaded youtube samples.
30
+ When using this model, make sure that your speech input is sampled at 16kHz.
31
+ ## Usage
32
+ The model can be used directly (without a language model) as follows:
33
+ ```python
34
+ import torch
35
+ import torchaudio
36
+ from datasets import load_dataset
37
+ from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor
38
+ test_dataset = load_dataset("common_voice", "he", split="test[:2%]") # there is no common dataset for Hebrew, please, paste your data
39
+ processor = Wav2Vec2Processor.from_pretrained("imvladikon/wav2vec2-large-xlsr-53-hebrew")
40
+ model = Wav2Vec2ForCTC.from_pretrained("imvladikon/wav2vec2-large-xlsr-53-hebrew")
41
+ resampler = torchaudio.transforms.Resample(48_000, 16_000)
42
+ # Preprocessing the datasets.
43
+ # We need to read the aduio files as arrays
44
+ def speech_file_to_array_fn(batch):
45
+ speech_array, sampling_rate = torchaudio.load(batch["path"])
46
+ batch["speech"] = resampler(speech_array).squeeze().numpy()
47
+ return batch
48
+ test_dataset = test_dataset.map(speech_file_to_array_fn)
49
+ inputs = processor(test_dataset["speech"][:2], sampling_rate=16_000, return_tensors="pt", padding=True)
50
+ with torch.no_grad():
51
+ tlogits = model(inputs.input_values, attention_mask=inputs.attention_mask).logits
52
+ predicted_ids = torch.argmax(logits, dim=-1)
53
+ print("Prediction:", processor.batch_decode(predicted_ids))
54
+ print("Reference:", test_dataset["sentence"][:2])
55
+ ```
56
+ ## Evaluation
57
+ The model can be evaluated as follows on some Hebrew test data
58
+ ```python
59
+ import torch
60
+ import torchaudio
61
+ from datasets import load_dataset, load_metric
62
+ from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor
63
+ import re
64
+ test_dataset = load_dataset("common_voice", "he", split="test") # there is no common dataset for Hebrew, please, paste your data
65
+ wer = load_metric("wer")
66
+ processor = Wav2Vec2Processor.from_pretrained("imvladikon/wav2vec2-large-xlsr-53-hebrew")
67
+ model = Wav2Vec2ForCTC.from_pretrained("imvladikon/wav2vec2-large-xlsr-53-hebrew").to("cuda")
68
+ chars_to_ignore_regex = '[\,\?\.\!\-\;\:\"\“\%\‘\”\�]'
69
+ resampler = torchaudio.transforms.Resample(48_000, 16_000)
70
+ # Preprocessing the datasets.
71
+ # We need to read the aduio files as arrays
72
+ def speech_file_to_array_fn(batch):
73
+ batch["sentence"] = re.sub(chars_to_ignore_regex, '', batch["sentence"]).lower()
74
+ speech_array, sampling_rate = torchaudio.load(batch["path"])
75
+ batch["speech"] = resampler(speech_array).squeeze().numpy()
76
+ return batch
77
+ test_dataset = test_dataset.map(speech_file_to_array_fn)
78
+ # Preprocessing the datasets.
79
+ # We need to read the aduio files as arrays
80
+ def evaluate(batch):
81
+ inputs = processor(batch["speech"], sampling_rate=16_000, return_tensors="pt", padding=True)
82
+ with torch.no_grad():
83
+ logits = model(inputs.input_values.to("cuda"), attention_mask=inputs.attention_mask.to("cuda")).logits
84
+ pred_ids = torch.argmax(logits, dim=-1)
85
+ batch["pred_strings"] = processor.batch_decode(pred_ids)
86
+ return batch
87
+ result = test_dataset.map(evaluate, batched=True, batch_size=8)
88
+ print("WER: {:2f}".format(100 * wer.compute(predictions=result["pred_strings"], references=result["sentence"])))
89
+ ```
90
+ **Test Result**:
91
+ # Example Predictions