Sepformer Wham

🚀 SepFormer trained on WHAM!

This repository offers all the essential tools for audio source separation using a SepFormer model. Implemented with SpeechBrain and pretrained on the WHAM! dataset, it provides effective separation capabilities. The model achieves 16.3 dB SI - SNRi on the WHAM! test set.

🚀 Quick Start

This repository provides all the necessary tools to perform audio source separation with a SepFormer model, implemented with SpeechBrain, and pretrained on WHAM! dataset, which is basically a version of WSJ0 - Mix dataset with environmental noise. For a better experience we encourage you to learn more about SpeechBrain. The model performance is 16.3 dB SI - SNRi on the test set of WHAM! dataset.

📦 Installation

Install SpeechBrain

First of all, please install SpeechBrain with the following command:

pip install speechbrain

💡 Usage Tip

Please notice that we encourage you to read our tutorials and learn more about SpeechBrain.

💻 Usage Examples

Perform source separation on your own audio file

from speechbrain.inference.separation import SepformerSeparation as separator
import torchaudio

model = separator.from_hparams(source="speechbrain/sepformer-wham", savedir='pretrained_models/sepformer-wham')

# for custom file, change path
est_sources = model.separate_file(path='speechbrain/sepformer-wsj02mix/test_mixture.wav') 

torchaudio.save("source1hat.wav", est_sources[:, :, 0].detach().cpu(), 8000)
torchaudio.save("source2hat.wav", est_sources[:, :, 1].detach().cpu(), 8000)

⚠️ Important Note

The system expects input recordings sampled at 8kHz (single channel). If your signal has a different sample rate, resample it (e.g, using torchaudio or sox) before using the interface.

Inference on GPU

To perform inference on the GPU, add run_opts={"device":"cuda"} when calling the from_hparams method.

Training

The model was trained with SpeechBrain (e375cd13). To train it from scratch follows these steps:

1. Clone SpeechBrain:

git clone https://github.com/speechbrain/speechbrain/

2. Install it:

cd speechbrain
pip install -r requirements.txt
pip install -e .

3. Run Training:

cd  recipes/WHAMandWHAMR/separation
python train.py hparams/sepformer-wham.yaml --data_folder=your_data_folder

You can find our training results (models, logs, etc) [here](https://drive.google.com/drive/folders/1dIAT8hZxvdJPZNUb8Zkk3BuN7GZ9 - mZb?usp=sharing).

Limitations

⚠️ Important Note

The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.

📚 Documentation

Referencing SpeechBrain

@misc{speechbrain,
  title={{SpeechBrain}: A General-Purpose Speech Toolkit},
  author={Mirco Ravanelli and Titouan Parcollet and Peter Plantinga and Aku Rouhe and Samuele Cornell and Loren Lugosch and Cem Subakan and Nauman Dawalatabad and Abdelwahab Heba and Jianyuan Zhong and Ju-Chieh Chou and Sung-Lin Yeh and Szu-Wei Fu and Chien-Feng Liao and Elena Rastorgueva and François Grondin and William Aris and Hwidong Na and Yan Gao and Renato De Mori and Yoshua Bengio},
  year={2021},
  eprint={2106.04624},
  archivePrefix={arXiv},
  primaryClass={eess.AS},
  note={arXiv:2106.04624}
}

Referencing SepFormer

@inproceedings{subakan2021attention,
      title={Attention is All You Need in Speech Separation}, 
      author={Cem Subakan and Mirco Ravanelli and Samuele Cornell and Mirko Bronzi and Jianyuan Zhong},
      year={2021},
      booktitle={ICASSP 2021}
}

📄 License

This project is licensed under the Apache - 2.0 license.

🔗 About SpeechBrain

• Website: https://speechbrain.github.io/
• Code: https://github.com/speechbrain/speechbrain/
• HuggingFace: https://huggingface.co/speechbrain/