Merge pull request #66 from pgosar/master

Create and Add Google Colab to README
This commit is contained in:
Puyuan Peng 2024-04-05 16:24:49 -05:00 committed by GitHub
commit cf1a4483f3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 6 deletions

View File

@ -17,21 +17,31 @@ To clone or edit an unseen voice, VoiceCraft needs only a few seconds of referen
- [x] Training guidance - [x] Training guidance
- [x] RealEdit dataset and training manifest - [x] RealEdit dataset and training manifest
- [x] Model weights (both 330M and 830M, the former seems to be just as good) - [x] Model weights (both 330M and 830M, the former seems to be just as good)
- [ ] Write colab notebooks for better hands-on experience - [x] Write colab notebooks for better hands-on experience
- [ ] HuggingFace Spaces demo - [ ] HuggingFace Spaces demo
- [ ] Better guidance on training/finetuning - [ ] Better guidance on training/finetuning
## How to run TTS inference ## How to run TTS inference
There are two ways: There are three ways:
1. with docker. see [quickstart](#quickstart)
2. without docker. see [envrionment setup](#environment-setup) 1. with Google Colab. see [quickstart colab](#quickstart-colab)
2. with docker. see [quickstart docker](#quickstart-docker)
3. without docker. see [environment setup](#environment-setup)
When you are inside the docker image or you have installed all dependencies, Checkout [`inference_tts.ipynb`](./inference_tts.ipynb). When you are inside the docker image or you have installed all dependencies, Checkout [`inference_tts.ipynb`](./inference_tts.ipynb).
If you want to do model development such as training/finetuning, I recommend following [envrionment setup](#environment-setup) and [training](#training). If you want to do model development such as training/finetuning, I recommend following [envrionment setup](#environment-setup) and [training](#training).
## QuickStart ## QuickStart Colab
:star: To try out TTS inference with VoiceCraft, the best way is using docker. Thank [@ubergarm](https://github.com/ubergarm) and [@jayc88](https://github.com/jay-c88) for making this happen.
:star: To try out speech editing or TTS Inference with VoiceCraft, the simplest way is using Google Colab.
Instructions to run are on the Colab itself.
1. To try [Speech Editing](https://colab.research.google.com/drive/1FV7EC36dl8UioePY1xXijXTMl7X47kR_?usp=sharing)
2. To try [TTS Inference](https://colab.research.google.com/drive/1lch_6it5-JpXgAQlUTRRI2z2_rk5K67Z?usp=sharing)
## QuickStart Docker
:star: To try out TTS inference with VoiceCraft, you can also use docker. Thank [@ubergarm](https://github.com/ubergarm) and [@jayc88](https://github.com/jay-c88) for making this happen.
Tested on Linux and Windows and should work with any host with docker installed. Tested on Linux and Windows and should work with any host with docker installed.
```bash ```bash