readme: ---
  language: es
  datasets:
  - common_voice
  metrics:
  - wer
  tags:
  - audio
  - automatic-speech-recognition
  - es 
  - speech
  - Spanish
  model-index:
  - name: Wav2vec 2.0 300m XLS-R
    results:
    - task:
        name: Automatic Speech Recognition
        type: automatic-speech-recognition
      dataset:
        name: Common Voice 10.0
        type: common_voice
        args: es
      metrics:
      - name: Common-Voice Test WER (Without LM)
        type: wer
        value: 10.61
      - name: Common-Voice Test WER (With LM, Weight=0.7)
        type: wer
        value: 6.73
      - name: Common-Voice Dev WER (Without LM)
        type: wer
        value: 9.38
      - name: Common-Voice Dev WER (With LM, Weight=0.7)
        type: wer
        value: 5.92
      - name: Voxforge Test (Without LM)
        type: wer
        value: 8.68
  ---
  
  # Spanish Automatic Speech Recognition
  
  This model is created by fine-tuning facebook/wav2vec2-xls-r-300m on Spanish using the train and validation splits of Common Voice 10.1. When using this model, make sure that your speech input is sampled at 16kHz.
  
  ### How to use
  Example of transcribing the Common Voice audio clip from the invalidated dataset, using GPU if available. The model expects 16kHz audio.
  
  ```python
  # install the below dependencies if you do not have installed.
  !pip install https://github.com/kpu/kenlm/archive/master.zip 
  !pip install pyctcdecode
  !pip install datasets
  !pip install evaluate
  !pip install jiwer
  !pip install transformers
  
  #you would require a csv with audiofile paths you want to transcribe
  
  #import libraries
  from datasets import DatasetDict, load_dataset, Audio
  from transformers import Wav2Vec2Processor, Wav2Vec2ForCTC, Wav2Vec2ProcessorWithLM 
  import torch
  
  processor = Wav2Vec2Processor.from_pretrained("Aditya3107/wav2vec2-common_voice-es-xls-r-300m")
  model = Wav2Vec2ForCTC.from_pretrained("Aditya3107/wav2vec2-common_voice-es-xls-r-300m")
  processor_LM = Wav2Vec2ProcessorWithLM.from_pretrained("Aditya3107/wav2vec2-common_voice-es-xls-r-300m")
  
  test_datasets = load_dataset("csv",data_files={"eval":"testing_dataset.csv"})
  test_datasets["eval"] = test_datasets["eval"].cast_column("audiopath", Audio(sampling_rate=16000))
  
  #select the audiofile you want to transcribe
  
  audio_sample = test_datasets["eval"][1]
  inputs = processor(audio_sample["audiopath"]["array"], sampling_rate=16_000, return_tensors="pt")
  with torch.no_grad():
    logits = model(**inputs).logits
  
  predicted_ids = torch.argmax(logits, dim=-1)
  
  #transcript without LM
  transcription = processor.batch_decode(predicted_ids)
  print(transcription[0].lower())
  
  #transcript with LM
  transcription_withlm = processor_LM.batch_decode(logits.numpy()).text
  print(transcription_withlm[0].lower())
  ```
  ### Below are some results
  |Reference | Transcript without LM | Transcript with LM|
  |---|---|---|
  |el minero roger coleman hermano del esposo de wanda fue señalado como principal sospechoso|el minero royer colleman hermano de esposo de guanda fue señalada como principal sospechoso|el mineroroyer colleman hermano de esposo de guanda fue señalada como principal sospechoso|
  |de esa manera va a la cárcel por tres años|de esa manera va a la cárcel por tres años|de esa manera va a la cárcel por tres años|
  |la cheek mansion en sí misma está considerada como parte de la colección|la chickmansion en sí misma está considerada como parte de la colección|la chickmansion en sí misma está considerada como parte de la colección|
  |los guajolotes se alimentan mayormente de bellotas otras semillas e insectos|los guajolotes se alimentan mayormente de bellotas otras semillas e insectos|los guajolotes se alimentan mayormente de bellotas otras semillas e insectos|
  |a la entrada de un sistema se le llama referencia|a la entrada de un sistema se le llama referencia|a la entrada de un sistema se le llama referencia|
  |entonces su hermano menor ernesto augusto se convirtió en el duque reinante en hanover|entonces su hermano menor ernesto augusto se convirtió en el duque reinante en hannover|entonces su hermano menor ernesto augusto se convirtió en el duque reinante en hannover|
  |el artesonado central del techo de la iglesia podría ser obra de gaudí|el artesonado central del techo de la iglesia podría ser obra de gaaudí|el artesonado central del techo de la iglesia podría ser obra de gaaudí|
  |se desmienten así los rumores acerca de su presunta retirada del mundo del cine|se desmienten asi los rumores acerca de su presunta retirada del mundo del cine|se desmienten asi los rumores acerca de su presunta retirada del mundo del cine|
  |con la ayuda de su padre originalmente quería ser escritora|con ayuda de su padre originalmente quería ser escritora|con ayuda de su padre originalmente quería ser escritora|
  
  
  
  ## Citation
  If you want to cite this model you can use this:
  
  ```bibtex
  @misc{aparikh2022xls-r300m-large-spanish,
    title={Fine-tuned {XLS-R}-300m large model for speech recognition in {S}panish},
    author={Parikh, Aditya},
    howpublished={\url{https://huggingface.co/Aditya3107/wav2vec2-common_voice-