Upload folder contents

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+example_wham.wav filter=lfs diff=lfs merge=lfs -text

CKPT.yaml

@@ -0,0 +1,4 @@
+# yamllint disable
+end-of-epoch: true
+si-snr: -15.359142046070115
+unixtime: 1638387953.7461503

README.md

@@ -0,0 +1,106 @@
+---
+language: "en"
+thumbnail:
+tags:
+- audio-to-audio 
+- Speech Enhancement
+- WHAM!
+- SepFormer
+- Transformer 
+- pytorch
+- speechbrain
+license: "apache-2.0"
+metrics:
+- SI-SNR
+- PESQ
+
+---
+
+<iframe src="https://ghbtns.com/github-btn.html?user=speechbrain&repo=speechbrain&type=star&count=true&size=large&v=2" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
+<br/><br/>
+
+# SepFormer trained on WHAM! for speech enhancement (8k sampling frequency)
+This repository provides all the necessary tools to perform speech enhancement (denoising) with a [SepFormer](https://arxiv.org/abs/2010.13154v2) model, implemented with SpeechBrain, and pretrained on [WHAM!](http://wham.whisper.ai/) dataset with 8k sampling frequency, which is basically a version of WSJ0-Mix dataset with environmental noise and reverberation in 8k. For a better experience we encourage you to learn more about [SpeechBrain](https://speechbrain.github.io). The given model performance is 14.35 dB SI-SNR on the test set of WHAM! dataset.
+
+
+| Release | Test-Set SI-SNR | Test-Set PESQ |
+|:-------------:|:--------------:|:--------------:|
+| 01-12-21 | 14.35 | 3.07 |
+
+
+## Install SpeechBrain
+
+First of all, please install SpeechBrain with the following command:
+
+```
+pip install speechbrain
+```
+
+Please notice that we encourage you to read our tutorials and learn more about [SpeechBrain](https://speechbrain.github.io).
+
+### Perform speech enhancement on your own audio file
+
+```python
+from speechbrain.inference.separation import SepformerSeparation as separator
+import torchaudio
+
+model = separator.from_hparams(source="speechbrain/sepformer-wham-enhancement", savedir='pretrained_models/sepformer-wham-enhancement')
+
+# for custom file, change path
+est_sources = model.separate_file(path='speechbrain/sepformer-wham-enhancement/example_wham.wav') 
+
+torchaudio.save("enhanced_wham.wav", est_sources[:, :, 0].detach().cpu(), 8000)
+
+```
+
+### Inference on GPU
+To perform inference on the GPU, add  `run_opts={"device":"cuda"}`  when calling the `from_hparams` method.
+
+### Training
+The training script is currently being worked on an ongoing pull-request. 
+
+We will update the model card as soon as the PR is merged. 
+
+You can find our training results (models, logs, etc) [here](https://drive.google.com/drive/folders/1bbQvaiN-R79M697NnekA7Rr0jIYtO6e3).
+
+### Limitations
+The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
+
+#### Referencing SpeechBrain
+
+```bibtex
+@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
+```bibtex
+@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}
+}
+
+@article{subakan2023exploring,
+  author={Subakan, Cem and Ravanelli, Mirco and Cornell, Samuele and Grondin, François and Bronzi, Mirko},
+  journal={IEEE/ACM Transactions on Audio, Speech, and Language Processing}, 
+  title={Exploring Self-Attention Mechanisms for Speech Separation}, 
+  year={2023},
+  volume={31},
+  pages={2169-2180},
+}
+```
+
+# **About SpeechBrain**
+- Website: https://speechbrain.github.io/
+- Code: https://github.com/speechbrain/speechbrain/
+- HuggingFace: https://huggingface.co/speechbrain/

brain.ckpt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d9e24193f36931b7f57932532efbdcf64971f42732383ba6808825f77db258f6
+size 28

config.json

@@ -0,0 +1,5 @@
+{
+
+  "speechbrain_interface": "SepformerSeparation"
+
+}

counter.ckpt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:65a699905c02619370bcf9207f5a477c3d67130ca71ec6f750e07fe8d510b084
+size 3

decoder.ckpt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:19e50784f377a79b514eb5664a0d6ac2841be0b2f6d8e21e77457875a4347514
+size 17628

encoder.ckpt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:751d8918200ad05804f5ac20f46eecc34a91466a07e2bb42781bf564f315f245
+size 17692

example_wham.wav

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:47a294d20a02f8e933fc338f81054bf9b07f5b2257ab259be03ecdaa5f47826e
+size 164992

hyperparams.yaml

@@ -0,0 +1,66 @@
+# ################################
+# Model: Pretrained SepFormer for speech enhancement
+# Dataset : WHAM!
+# ################################
+
+num_spks: 1
+sample_rate: 8000
+
+# Encoder parameters
+N_encoder_out: 256
+out_channels: 256
+kernel_size: 16
+kernel_stride: 8
+
+# Specifying the network
+Encoder: !new:speechbrain.lobes.models.dual_path.Encoder
+  kernel_size: 16
+  out_channels: 256
+
+SBtfintra: !new:speechbrain.lobes.models.dual_path.SBTransformerBlock
+  num_layers: 8
+  d_model: 256
+  nhead: 8
+  d_ffn: 1024
+  dropout: 0
+  use_positional_encoding: true
+  norm_before: true
+
+SBtfinter: !new:speechbrain.lobes.models.dual_path.SBTransformerBlock
+  num_layers: 8
+  d_model: 256
+  nhead: 8
+  d_ffn: 1024
+  dropout: 0
+  use_positional_encoding: true
+  norm_before: true
+
+MaskNet: !new:speechbrain.lobes.models.dual_path.Dual_Path_Model
+  num_spks: 1
+  in_channels: 256
+  out_channels: 256
+  num_layers: 2
+  K: 250
+  intra_model: !ref <SBtfintra>
+  inter_model: !ref <SBtfinter>
+  norm: ln
+  linear_layer_after_inter_intra: false
+  skip_around_intra: true
+
+Decoder: !new:speechbrain.lobes.models.dual_path.Decoder
+  in_channels: 256
+  out_channels: 1
+  kernel_size: 16
+  stride: 8
+  bias: false
+
+modules:
+  encoder: !ref <Encoder>
+  decoder: !ref <Decoder>
+  masknet: !ref <MaskNet>
+
+pretrainer: !new:speechbrain.utils.parameter_transfer.Pretrainer
+  loadables:
+    encoder: !ref <Encoder>
+    masknet: !ref <MaskNet>
+    decoder: !ref <Decoder>

lr_scheduler.ckpt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c0840f13c40bd42cf305668c49c51459d17e45634c63e9760d21e1ae76f930af
+size 2036

masknet.ckpt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6647188f00277e570076178b1a5d53eaae171b6ff4139baf6043e10054fe9fc0
+size 112839988

optimizer.ckpt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8c658c95669088b11871cdf232d637b29a4e17a5e4270be7e26ba5f2eb5cda1f
+size 205152122