Create README.md

README.md

@@ -0,0 +1,64 @@
+---
+language:
+- en
+datasets:
+tags:
+- speech
+---
+
+# WavLM-Base-Plus
+
+[Microsoft's WavLM](https://github.com/microsoft/unilm/tree/master/wavlm)
+
+The model was pretrained on 16kHz sampled speech audio with utterance and speaker contrastive loss. When using the model, make sure that your speech input is also sampled at 16kHz. 
+
+**Note**: This model does not have a tokenizer as it was pretrained on audio alone. In order to use this model **speech recognition**, a tokenizer should be created and the model should be fine-tuned on labeled text data. Check out [this blog](https://huggingface.co/blog/fine-tune-wav2vec2-english) for more in-detail explanation of how to fine-tune the model.
+
+The model was pre-trained on:
+
+- 60,000 hours of [Libri-Light](https://arxiv.org/abs/1912.07875)
+- 10,000 hours of [GigaSpeech](https://arxiv.org/abs/2106.06909)
+- 24,000 hours of [VoxPopuli](https://arxiv.org/abs/2101.00390)
+
+[Paper: WavLM: Large-Scale Self-Supervised Pre-Training for Full Stack Speech Processing](https://arxiv.org/abs/2110.13900)
+
+Authors: Sanyuan Chen, Chengyi Wang, Zhengyang Chen, Yu Wu, Shujie Liu, Zhuo Chen, Jinyu Li, Naoyuki Kanda, Takuya Yoshioka, Xiong Xiao, Jian Wu, Long Zhou, Shuo Ren, Yanmin Qian, Yao Qian, Jian Wu, Michael Zeng, Furu Wei
+
+**Abstract**
+*Self-supervised learning (SSL) achieves great success in speech recognition, while limited exploration has been attempted for other speech processing tasks. As speech signal contains multi-faceted information including speaker identity, paralinguistics, spoken content, etc., learning universal representations for all speech tasks is challenging. In this paper, we propose a new pre-trained model, WavLM, to solve full-stack downstream speech tasks. WavLM is built based on the HuBERT framework, with an emphasis on both spoken content modeling and speaker identity preservation. We first equip the Transformer structure with gated relative position bias to improve its capability on recognition tasks. For better speaker discrimination, we propose an utterance mixing training strategy, where additional overlapped utterances are created unsupervisely and incorporated during model training. Lastly, we scale up the training dataset from 60k hours to 94k hours. WavLM Large achieves state-of-the-art performance on the SUPERB benchmark, and brings significant improvements for various speech processing tasks on their representative benchmarks.*
+
+The original model can be found under https://github.com/microsoft/unilm/tree/master/wavlm.
+
+# Fine-tuning details
+The model is fine-tuned on the [VoxCeleb1 dataset](https://www.robots.ox.ac.uk/~vgg/data/voxceleb/vox1.html) using an X-Vector head with an Additive Margin Softmax loss
+[X-Vectors: Robust DNN Embeddings for Speaker Recognition](https://www.danielpovey.com/files/2018_icassp_xvectors.pdf)
+# Usage
+## Speaker Verification
+```python
+from transformers import Wav2Vec2FeatureExtractor, UniSpeechSatForXVector
+from datasets import load_dataset
+import torch
+
+dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
+
+feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained('microsoft/wavlm-base-plus-sv')
+model = UniSpeechSatForXVector.from_pretrained('microsoft/wavlm-base-plus-sv')
+
+# audio files are decoded on the fly
+inputs = feature_extractor(dataset[:2]["audio"]["array"], return_tensors="pt")
+embeddings = model(**inputs).embeddings
+embeddings = torch.nn.functional.normalize(embeddings, dim=-1).cpu()
+
+# the resulting embeddings can be used for cosine similarity-based retrieval
+cosine_sim = torch.nn.CosineSimilarity(dim=-1)
+similarity = cosine_sim(embeddings[0], embeddings[1])
+threshold = 0.86  # the optimal threshold is dataset-dependent
+if similarity < threshold:
+    print("Speakers are not the same!")
+```
+
+# License
+
+The official license can be found [here](https://github.com/microsoft/UniSpeech/blob/main/LICENSE)
+
+![design](https://raw.githubusercontent.com/patrickvonplaten/scientific_images/master/wavlm.png)