teddybear082 commited on
Commit ·
cce21a0
1
Parent(s): 3cf437a
Enhance README with EXE installation and usage info
Browse filesUpdated README to include EXE installation instructions and clarify usage details.
README.md
CHANGED
|
@@ -13,12 +13,22 @@ Pocket-TTS Huggingface: https://huggingface.co/kyutai/pocket-tts
|
|
| 13 |
- **Web Interface**: Simple built-in UI to test voices and generation.
|
| 14 |
- **Custom Voices**: Easy addition of new voices by dragging and dropping `.wav` files.
|
| 15 |
- **Flexible Configuration**: Run via command line or an interactive batch launcher.
|
|
|
|
| 16 |
|
| 17 |
## Prerequisites
|
| 18 |
|
| 19 |
- **Python 3.10+**: Ensure Python is installed and added to your system PATH.
|
| 20 |
|
| 21 |
-
## Installation
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 22 |
|
| 23 |
1. **Clone or Download** this repository to your local machine.
|
| 24 |
|
|
@@ -47,7 +57,7 @@ Pocket-TTS Huggingface: https://huggingface.co/kyutai/pocket-tts
|
|
| 47 |
3. **Hugging Face Login (If required)**:
|
| 48 |
Until a workaround is found, to enable voice cloning of .wavs you will need to insert your hugging face token when prompted in the .bat file.
|
| 49 |
|
| 50 |
-
## Usage
|
| 51 |
|
| 52 |
### Method 1: Interactive Launcher (Windows)
|
| 53 |
|
|
|
|
| 13 |
- **Web Interface**: Simple built-in UI to test voices and generation.
|
| 14 |
- **Custom Voices**: Easy addition of new voices by dragging and dropping `.wav` files.
|
| 15 |
- **Flexible Configuration**: Run via command line or an interactive batch launcher.
|
| 16 |
+
- **Windows EXE included**: If you want to use defaults (host: 0.0.0.0, port: 5002, streaming enabled, local model file and built-in voices) just double click on .exe and you're up and running!
|
| 17 |
|
| 18 |
## Prerequisites
|
| 19 |
|
| 20 |
- **Python 3.10+**: Ensure Python is installed and added to your system PATH.
|
| 21 |
|
| 22 |
+
## EXE Installation and Usage (Windows only)
|
| 23 |
+
|
| 24 |
+
- Download latest release .zip from https://github.com/teddybear082/pocket-tts-openai_streaming_server/releases
|
| 25 |
+
- Unzip to location on your computer that is not protected, like C://Pocket-TTS-Server/
|
| 26 |
+
- To use all defaults for server (host: 0.0.0.0, port: 5002, streaming enabled, local model file and built-in voices) just double click on .exe and you're up and running!
|
| 27 |
+
- To be able to input custom arguments for any of those, run the run_pocket_tts_server_exe.bat instead and follow the UI prompts.
|
| 28 |
+
- To use the WebUI, navigate to the host and port you set in the .bat file, by default: http://localhost:5002
|
| 29 |
+
- Supports cloning .wav, .mp3. and .flac files. To try out custom cloning, use the WebUI and in the voice list select the last option to upload a custom file and insert the path to the .wav, .mp3, or .flac with the voice you want to clone.
|
| 30 |
+
|
| 31 |
+
## Python Installation
|
| 32 |
|
| 33 |
1. **Clone or Download** this repository to your local machine.
|
| 34 |
|
|
|
|
| 57 |
3. **Hugging Face Login (If required)**:
|
| 58 |
Until a workaround is found, to enable voice cloning of .wavs you will need to insert your hugging face token when prompted in the .bat file.
|
| 59 |
|
| 60 |
+
## Python Usage
|
| 61 |
|
| 62 |
### Method 1: Interactive Launcher (Windows)
|
| 63 |
|