56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
<p align="center">
|
|
<img src="https://user-images.githubusercontent.com/25312635/195514652-e4526cd1-1177-48e9-a80d-c8bfdb95d35f.png" />
|
|
</p>
|
|
|
|
|
|
|
|
|
|
mayavoz is a Pytorch-based opensource toolkit for speech enhancement. It is designed to save time for audio researchers. Is provides easy to use pretrained audio enhancement models and facilitates highly customisable model training.
|
|
|
|
| **[Quick Start](#quick-start-fire)** | **[Installation](#installation)** | **[Tutorials](https://github.com/shahules786/enhancer/notebooks/)** | **[Available Recipes](#recipes)** | **[Demo]()**
|
|
## Key features :key:
|
|
|
|
* Various pretrained models nicely integrated with huggingface :hugs: that users can select and use without any hastle.
|
|
* :package: Ability to train and validation your own custom speech enhancement models with just under 10 lines of code!
|
|
* :magic_wand: A command line tool that facilitates training of highly customisable speech enhacement models from the terminal itself!
|
|
* :zap: Supports multi-gpu training integrated with Pytorch Lightning.
|
|
|
|
## Quick Start :fire:
|
|
``` python
|
|
from mayavoz import Mayamodel
|
|
|
|
model = Mayamodel.from_pretrained("mayavoz/waveunet")
|
|
model("noisy_audio.wav")
|
|
```
|
|
|
|
## Recipes
|
|
|
|
| Model | Dataset | STOI | PESQ | URL |
|
|
| :---: | :---: | :---: | :---: | :---: |
|
|
| WaveUnet | Vctk-28spk | 0.836 | 2.78 | shahules786/mayavoz-waveunet-valentini-28spk |
|
|
| Demucs | DNS-2020 (30hrs) | 0.961 | 2.56 | shahules786/mayavoz-demucs-valentini-28spk |
|
|
| DCCRN | DNS-2020 (30hrs) | | | mayavoz/dccrn-vctk28 |
|
|
|
|
|
|
## Installation
|
|
Only Python 3.8+ is officially supported (though it might work with Python 3.7)
|
|
|
|
- With Pypi
|
|
```
|
|
pip install mayavoz
|
|
```
|
|
|
|
- With conda
|
|
|
|
```
|
|
conda env create -f environment.yml
|
|
conda activate mayavoz
|
|
```
|
|
|
|
- From source code
|
|
```
|
|
git clone url
|
|
cd mayavoz
|
|
pip install -e .
|
|
```
|