Test Audio

🚀 S2T-SMALL-COVOST2-FR-EN-ST

s2t-small-covost2-fr-en-st is a Speech to Text Transformer (S2T) model designed for end-to-end Speech Translation (ST), offering efficient French speech to English text translation.

🚀 Quick Start

The s2t-small-covost2-fr-en-st model can be used for end-to-end French speech to English text translation. As a standard sequence to sequence transformer model, you can use the generate method to generate transcripts by passing speech features to the model.

💻 Usage Examples

Basic Usage

import torch
from transformers import Speech2TextProcessor, Speech2TextForConditionalGeneration
from datasets import load_dataset
import soundfile as sf

model = Speech2TextForConditionalGeneration.from_pretrained("facebook/s2t-small-covost2-fr-en-st")
processor = Speech2TextProcessor.from_pretrained("facebook/s2t-small-covost2-fr-en-st")

def map_to_array(batch):
    speech, _ = sf.read(batch["file"])
    batch["speech"] = speech
    return batch

ds = load_dataset(
    "patrickvonplaten/librispeech_asr_dummy",
    "clean",
    split="validation"
)
ds = ds.map(map_to_array)

inputs = processor(
    ds["speech"][0],
    sampling_rate=48_000,
    return_tensors="pt"
)
generated_ids = model.generate(input_ids=inputs["input_features"], attention_mask=inputs["attention_mask"])

translation = processor.batch_decode(generated_ids, skip_special_tokens=True)

Advanced Usage

Note: The Speech2TextProcessor object uses torchaudio to extract the filter bank features. Make sure to install the torchaudio package before running this example.

You could either install those as extra speech dependancies with pip install transformers"[speech, sentencepiece]" or install the packages seperatly with pip install torchaudio sentencepiece.

✨ Features

• End - to - End Translation: Capable of directly translating French speech to English text.
• Transformer - Based: Utilizes a transformer-based seq2seq (encoder - decoder) architecture.
• Convolutional Downsampler: Reduces the length of speech inputs by 3/4th before feeding them into the encoder.

📦 Installation

You need to install the necessary dependencies. You can install them as extra speech dependencies with the following command:

pip install transformers"[speech, sentencepiece]"

Or install the packages separately:

pip install torchaudio sentencepiece

📚 Documentation

Model description

S2T is a transformer-based seq2seq (encoder-decoder) model designed for end-to-end Automatic Speech Recognition (ASR) and Speech Translation (ST). It uses a convolutional downsampler to reduce the length of speech inputs by 3/4th before they are fed into the encoder. The model is trained with standard autoregressive cross-entropy loss and generates the transcripts/translations autoregressively.

Intended uses & limitations

This model can be used for end-to-end French speech to English text translation. See the model hub to look for other S2T checkpoints.

🔧 Technical Details

Training data

The s2t-small-covost2-fr-en-st is trained on French-English subset of CoVoST2. CoVoST is a large-scale multilingual ST corpus based on Common Voice, created to foster ST research with the largest ever open dataset.

Training procedure

Preprocessing

The speech data is pre-processed by extracting Kaldi-compliant 80-channel log mel-filter bank features automatically from WAV/FLAC audio files via PyKaldi or torchaudio. Further utterance-level CMVN (cepstral mean and variance normalization) is applied to each example.

The texts are lowercased and tokenized using character based SentencePiece vocab.

Training

The model is trained with standard autoregressive cross-entropy loss and using SpecAugment. The encoder receives speech features, and the decoder generates the transcripts autoregressively. To accelerate model training and for better performance the encoder is pre-trained for English ASR.

Evaluation results

CoVOST2 test results for fr-en (BLEU score): 26.25

📄 License

This model is released under the MIT license.

BibTeX entry and citation info

@inproceedings{wang2020fairseqs2t,
  title = {fairseq S2T: Fast Speech-to-Text Modeling with fairseq},
  author = {Changhan Wang and Yun Tang and Xutai Ma and Anne Wu and Dmytro Okhonko and Juan Pino},
  booktitle = {Proceedings of the 2020 Conference of the Asian Chapter of the Association for Computational Linguistics (AACL): System Demonstrations},
  year = {2020},
}

Information Table

Important Notes

⚠️ Important Note

The Speech2TextProcessor object uses torchaudio to extract the filter bank features. Make sure to install the torchaudio package before running the usage example.

💡 Usage Tip

You could either install the necessary packages as extra speech dependencies with pip install transformers"[speech, sentencepiece]" or install the packages separately with pip install torchaudio sentencepiece.