Instructions to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with Transformers:
# Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF", dtype="auto") - llama-cpp-python
How to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF", filename="VT-Orpheus-3B-TTS-Ceylia.Q4_K_M.gguf", )
llm.create_chat_completion( messages = "No input example has been defined for this model task." )
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with llama.cpp:
Install from brew
brew install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M # Run inference directly in the terminal: llama-cli -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M # Run inference directly in the terminal: llama-cli -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
Use pre-built binary
# Download pre-built binary from: # https://github.com/ggerganov/llama.cpp/releases # Start a local OpenAI-compatible server with a web UI: ./llama-server -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M # Run inference directly in the terminal: ./llama-cli -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
Build from source code
git clone https://github.com/ggerganov/llama.cpp.git cd llama.cpp cmake -B build cmake --build build -j --target llama-server llama-cli # Start a local OpenAI-compatible server with a web UI: ./build/bin/llama-server -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M # Run inference directly in the terminal: ./build/bin/llama-cli -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
Use Docker
docker model run hf.co/vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
- LM Studio
- Jan
- Ollama
How to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with Ollama:
ollama run hf.co/vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
- Unsloth Studio
How to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with Unsloth Studio:
Install Unsloth Studio (macOS, Linux, WSL)
curl -fsSL https://unsloth.ai/install.sh | sh # Run unsloth studio unsloth studio -H 0.0.0.0 -p 8888 # Then open http://localhost:8888 in your browser # Search for vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF to start chatting
Install Unsloth Studio (Windows)
irm https://unsloth.ai/install.ps1 | iex # Run unsloth studio unsloth studio -H 0.0.0.0 -p 8888 # Then open http://localhost:8888 in your browser # Search for vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF to start chatting
- Pi
How to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with Pi:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama-server -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
Configure the model in Pi
# Install Pi: npm install -g @mariozechner/pi-coding-agent # Add to ~/.pi/agent/models.json: { "providers": { "llama-cpp": { "baseUrl": "http://localhost:8080/v1", "api": "openai-completions", "apiKey": "none", "models": [ { "id": "vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M" } ] } } }Run Pi
# Start Pi in your project directory: pi
- Hermes Agent new
How to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with Hermes Agent:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama-server -hf vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
Configure Hermes
# Install Hermes: curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash hermes setup # Point Hermes at the local server: hermes config set model.provider custom hermes config set model.base_url http://127.0.0.1:8080/v1 hermes config set model.default vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
Run Hermes
hermes
- Docker Model Runner
How to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with Docker Model Runner:
docker model run hf.co/vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
- Lemonade
How to use vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull vinhnx90/VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF:Q4_K_M
Run and chat with the model
lemonade run user.VT-Orpheus-3B-TTS-Ceylia-Q4KM-GGUFF-Q4_K_M
List all available models
lemonade list
Update README.md
Browse files
README.md
CHANGED
|
@@ -57,50 +57,50 @@ This section provides a step-by-step guide to running the `VT-Orpheus-3B-TTS-Cey
|
|
| 57 |
### Setup Steps
|
| 58 |
|
| 59 |
1. **Install LM Studio**
|
| 60 |
-
|
| 61 |
-
|
| 62 |
|
| 63 |
2. **Load the GGUF model**
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
|
| 67 |
|
| 68 |
3. **Start the local server**
|
| 69 |
-
|
| 70 |
-
|
| 71 |
|
| 72 |
4. **Clone orpheus-tts-local repository**
|
| 73 |
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
|
| 79 |
5. **Install dependencies**
|
| 80 |
|
| 81 |
-
|
| 82 |
-
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
|
| 86 |
|
| 87 |
5.1 **Edit gguf_orpheus.py to include new ceylia voice**
|
| 88 |
|
| 89 |
Open `gguf_orpheus.py` file in ./orpheus-tts-local directory, find the line of `AVAILABLE_VOICES` and `DEFAULT_VOICE` and edit to include ceylia voice, default is `tara`.
|
| 90 |
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
|
| 97 |
Save the file `gguf_orpheus.py`.
|
| 98 |
|
| 99 |
6. **Run the model**
|
| 100 |
|
| 101 |
-
|
| 102 |
-
|
| 103 |
-
|
| 104 |
|
| 105 |
### Available Parameters
|
| 106 |
|
|
@@ -123,39 +123,39 @@ Save the file `gguf_orpheus.py`.
|
|
| 123 |
|
| 124 |
1. **Clone and build llama.cpp**
|
| 125 |
|
| 126 |
-
|
| 127 |
-
|
| 128 |
-
|
| 129 |
-
|
| 130 |
-
|
| 131 |
-
|
| 132 |
|
| 133 |
2. **Start the server**
|
| 134 |
|
| 135 |
-
|
| 136 |
-
|
| 137 |
-
|
| 138 |
|
| 139 |
3. **Clone orpheus-tts-local repository**
|
| 140 |
|
| 141 |
-
|
| 142 |
-
|
| 143 |
-
|
| 144 |
-
|
| 145 |
|
| 146 |
4. **Install dependencies**
|
| 147 |
|
| 148 |
-
|
| 149 |
-
|
| 150 |
-
|
| 151 |
-
|
| 152 |
-
|
| 153 |
|
| 154 |
5. **Run the model with custom API URL**
|
| 155 |
|
| 156 |
-
|
| 157 |
-
|
| 158 |
-
|
| 159 |
|
| 160 |
## Emotion Tags
|
| 161 |
|
|
|
|
| 57 |
### Setup Steps
|
| 58 |
|
| 59 |
1. **Install LM Studio**
|
| 60 |
+
- Download and install LM Studio from [lmstudio.ai](https://lmstudio.ai/)
|
| 61 |
+
- Launch LM Studio
|
| 62 |
|
| 63 |
2. **Load the GGUF model**
|
| 64 |
+
- In LM Studio, click "Add Model"
|
| 65 |
+
- Select the `VT-Orpheus-3B-TTS-Ceylia.Q4_K_M.gguf` file from your computer
|
| 66 |
+
- Once added, click on the model to load it
|
| 67 |
|
| 68 |
3. **Start the local server**
|
| 69 |
+
- Go to the "Local Server" tab in LM Studio
|
| 70 |
+
- Click "Start Server" to launch the local API server (default address is `http://127.0.0.1:1234`)
|
| 71 |
|
| 72 |
4. **Clone orpheus-tts-local repository**
|
| 73 |
|
| 74 |
+
```bash
|
| 75 |
+
git clone https://github.com/isaiahbjork/orpheus-tts-local.git
|
| 76 |
+
cd orpheus-tts-local
|
| 77 |
+
```
|
| 78 |
|
| 79 |
5. **Install dependencies**
|
| 80 |
|
| 81 |
+
```bash
|
| 82 |
+
python -m venv venv
|
| 83 |
+
source venv/bin/activate # On Windows: venv\Scripts\activate
|
| 84 |
+
pip install -r requirements.txt
|
| 85 |
+
```
|
| 86 |
|
| 87 |
5.1 **Edit gguf_orpheus.py to include new ceylia voice**
|
| 88 |
|
| 89 |
Open `gguf_orpheus.py` file in ./orpheus-tts-local directory, find the line of `AVAILABLE_VOICES` and `DEFAULT_VOICE` and edit to include ceylia voice, default is `tara`.
|
| 90 |
|
| 91 |
+
```python
|
| 92 |
+
# Available voices based on the Orpheus-TTS repository
|
| 93 |
+
AVAILABLE_VOICES = ["tara", "leah", "jess", "leo", "dan", "mia", "zac", "zoe", "ceylia"]
|
| 94 |
+
DEFAULT_VOICE = "ceylia"
|
| 95 |
+
```
|
| 96 |
|
| 97 |
Save the file `gguf_orpheus.py`.
|
| 98 |
|
| 99 |
6. **Run the model**
|
| 100 |
|
| 101 |
+
```bash
|
| 102 |
+
python gguf_orpheus.py --text "Hi! I'm Ceylia. <laugh> This is so exciting! <giggle>" --voice ceylia --output output.wav
|
| 103 |
+
```
|
| 104 |
|
| 105 |
### Available Parameters
|
| 106 |
|
|
|
|
| 123 |
|
| 124 |
1. **Clone and build llama.cpp**
|
| 125 |
|
| 126 |
+
```bash
|
| 127 |
+
git clone https://github.com/ggerganov/llama.cpp
|
| 128 |
+
cd llama.cpp
|
| 129 |
+
cmake -B build
|
| 130 |
+
cmake --build build --config Release
|
| 131 |
+
```
|
| 132 |
|
| 133 |
2. **Start the server**
|
| 134 |
|
| 135 |
+
```bash
|
| 136 |
+
./llama-server -m /path/to/VT-Orpheus-3B-TTS-Ceylia.Q4_K_M.gguf --port 8080
|
| 137 |
+
```
|
| 138 |
|
| 139 |
3. **Clone orpheus-tts-local repository**
|
| 140 |
|
| 141 |
+
```bash
|
| 142 |
+
git clone https://github.com/isaiahbjork/orpheus-tts-local.git
|
| 143 |
+
cd orpheus-tts-local
|
| 144 |
+
```
|
| 145 |
|
| 146 |
4. **Install dependencies**
|
| 147 |
|
| 148 |
+
```bash
|
| 149 |
+
python -m venv venv
|
| 150 |
+
source venv/bin/activate # On Windows: venv\Scripts\activate
|
| 151 |
+
pip install -r requirements.txt
|
| 152 |
+
```
|
| 153 |
|
| 154 |
5. **Run the model with custom API URL**
|
| 155 |
|
| 156 |
+
```bash
|
| 157 |
+
python gguf_orpheus.py --text "Hi! I'm Ceylia. <laugh> Let's play! <sniffle> This is so exciting! <giggle>" --voice ceylia --output output.wav --api_url http://localhost:8080/v1
|
| 158 |
+
```
|
| 159 |
|
| 160 |
## Emotion Tags
|
| 161 |
|