mirror of
https://github.com/jasonppy/VoiceCraft.git
synced 2025-06-05 21:49:11 +02:00
add simple running instructions
This commit is contained in:
15
README.md
15
README.md
@@ -13,6 +13,8 @@ There are three ways (besides running Gradio in Colab):
|
|||||||
1. More flexible inference beyond Gradio UI in Google Colab. see [quickstart colab](#quickstart-colab)
|
1. More flexible inference beyond Gradio UI in Google Colab. see [quickstart colab](#quickstart-colab)
|
||||||
2. with docker. see [quickstart docker](#quickstart-docker)
|
2. with docker. see [quickstart docker](#quickstart-docker)
|
||||||
3. without docker. see [environment setup](#environment-setup). You can also run gradio locally if you choose this option
|
3. without docker. see [environment setup](#environment-setup). You can also run gradio locally if you choose this option
|
||||||
|
4. As a standalone script that you can easily integrate into other projects.
|
||||||
|
see [quickstart command line](#quickstart-command-line).
|
||||||
|
|
||||||
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).
|
||||||
|
|
||||||
@@ -37,11 +39,9 @@ If you want to do model development such as training/finetuning, I recommend fol
|
|||||||
- [x] Better guidance on training/finetuning
|
- [x] Better guidance on training/finetuning
|
||||||
- [x] Colab notebooks
|
- [x] Colab notebooks
|
||||||
- [x] HuggingFace Spaces demo
|
- [x] HuggingFace Spaces demo
|
||||||
- [ ] Command line
|
- [x] Command line
|
||||||
- [ ] Improve efficiency
|
- [ ] Improve efficiency
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## QuickStart Colab
|
## QuickStart Colab
|
||||||
|
|
||||||
:star: To try out speech editing or TTS Inference with VoiceCraft, the simplest way is using Google Colab.
|
:star: To try out speech editing or TTS Inference with VoiceCraft, the simplest way is using Google Colab.
|
||||||
@@ -50,6 +50,15 @@ Instructions to run are on the Colab itself.
|
|||||||
1. To try [Speech Editing](https://colab.research.google.com/drive/1FV7EC36dl8UioePY1xXijXTMl7X47kR_?usp=sharing)
|
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)
|
2. To try [TTS Inference](https://colab.research.google.com/drive/1lch_6it5-JpXgAQlUTRRI2z2_rk5K67Z?usp=sharing)
|
||||||
|
|
||||||
|
## QuickStart Command Line
|
||||||
|
|
||||||
|
:star: To use it as a standalone script, check out tts_demo.py and speech_editing_demo.py.
|
||||||
|
Be sure to first [setup your environment](#environment-setup).
|
||||||
|
Without arguments, they will run the standard demo arguments used as an example elsewhere
|
||||||
|
in this repository. You can use the command line arguments to specify unique input audios,
|
||||||
|
target transcripts, and inference hyperparameters. Run the help command for more information:
|
||||||
|
`python3 tts_demo.py -h` and `python3 speech-editing_demo.py -h`
|
||||||
|
|
||||||
## QuickStart Docker
|
## 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.
|
: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.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user