Generate speech using various libraries.
Project description
Sinapsis Speech
Templates for a wide range of voice generation tasks.
🐍 Installation • 📦 Packages • 🌐 Webapps • 📙 Documentation • 🔍 License
🐍 Installation
[!IMPORTANT] Sinapsis projects requires Python 3.10 or higher.
This repo includes packages for performing speech synthesis using different tools:
sinapsis-elevenlabssinapsis-f5-ttssinapsis-zonos
Install using your preferred package manager. We strongly recommend using uv. To install uv, refer to the official documentation.
Install with uv:
uv pip install sinapsis-elevenlabs --extra-index-url https://pypi.sinapsis.tech
Or with raw pip:
pip install sinapsis-elevenlabs --extra-index-url https://pypi.sinapsis.tech
Replace sinapsis-elevenlabs with the name of the package you intend to install.
[!IMPORTANT] Templates in each package may require additional dependencies. For development, we recommend installing the package all optional dependencies:
With uv:
uv pip install sinapsis-elevenlabs[all] --extra-index-url https://pypi.sinapsis.tech
Or with raw pip:
pip install sinapsis-elevenlabs[all] --extra-index-url https://pypi.sinapsis.tech
Be sure to substitute sinapsis-elevenlabs with the appropriate package name.
[!TIP] You can also install all the packages within this project:
uv pip install sinapsis-speech[all] --extra-index-url https://pypi.sinapsis.tech
📦 Packages
This repository is organized into modular packages, each designed for integration with different text-to-speech tools. These packages provide ready-to-use templates for speech synthesis. Below is an overview of the available packages:
Sinapsis ElevenLabs
This package offers a suite of templates and utilities designed for effortless integrating, configuration, and execution of text-to-speech (TTS) and voice generation functionalities powered by ElevenLabs.
-
ElevenLabsTTS: Template for converting text into speech using ElevenLabs' voice models.
-
ElevenLabsVoiceGeneration: Template for generating custom synthetic voices based on user-provided descriptions.
For specific instructions and further details, see the README.md.
Sinapsis F5-TTS
This package provides a template for seamlessly integrating, configuring, and running text-to-speech (TTS) functionalities powered by F5TTS.
- F5TTSInference: Converts text to speech using the F5TTS model with voice cloning capabilities.
For specific instructions and further details, see the README.md.
Sinapsis Zonos
This package provides a single template for integrating, configuring, and running text-to-speech (TTS) and voice cloning functionalities powered by Zonos.
- ZonosTTS: Template for converting text to speech or performing voice cloning based on the presence of an audio sample.
For specific instructions and further details, see the README.md.
🌐 Webapps
The webapps included in this project showcase the modularity of the templates, in this case for speech generation tasks.[!IMPORTANT] To run the app you first need to clone this repository:
git clone git@github.com:Sinapsis-ai/sinapsis-speech.git
cd sinapsis-speech
[!NOTE] If you'd like to enable external app sharing in Gradio,
export GRADIO_SHARE_APP=True
[!IMPORTANT] Elevenlabs requires an API key to run any inference. To get started, visit the official website and create an account. If you already have an account, go to the API keys page to generate a token.
[!IMPORTANT] Set your env var using
export ELEVENLABS_API_KEY='your-api-key'
[!IMPORTANT] F5-TTS requires a reference audio file for voice cloning. Make sure you have a reference audio file in the artifacts directory.
[!NOTE] Agent configuration can be changed through the
AGENT_CONFIG_PATHenv var. You can check the available configurations in each package configs folder.
🐳 Docker
IMPORTANT: This Docker image depends on the sinapsis-nvidia:base image. For detailed instructions, please refer to the Sinapsis README.
- Build the sinapsis-speech image:
docker compose -f docker/compose.yaml build
- Start the app container: For ElevenLabs:
docker compose -f docker/compose_apps.yaml up -d sinapsis-elevenlabs
For F5-TTS:
docker compose -f docker/compose_apps.yaml up -d sinapsis-f5_tts
For Zonos:
docker compose -f docker/compose_apps.yaml up -d sinapsis-zonos
- Check the logs For ElevenLabs:
docker logs -f sinapsis-elevenlabs
For F5-TTS:
docker logs -f sinapsis-f5tts
For Zonos:
docker logs -f sinapsis-zonos
- The logs will display the URL to access the webapp, e.g.,::
Running on local URL: http://127.0.0.1:7860
NOTE: The url may be different, check the output of logs. 5. To stop the app:
docker compose -f docker/compose_apps.yaml down
💻 UV
To run the webapp using the uv package manager, follow these steps:
- Sync the virtual environment:
uv sync --frozen
- Install the wheel:
uv pip install sinapsis-speech[all] --extra-index-url https://pypi.sinapsis.tech
- Run the webapp: For ElevenLabs:
uv run webapps/elevenlabs/elevenlabs_tts_app.py
For F5-TTS:
uv run webapps/f5-tts/f5_tts_app.py
For Zonos:
uv run webapps/zonos/zonos_tts_app.py
- The terminal will display the URL to access the webapp (e.g.):
Running on local URL: http://127.0.0.1:7860
NOTE: The URL may vary; check the terminal output for the correct address.
📙 Documentation
Documentation is available on the sinapsis website
Tutorials for different projects within sinapsis are available at sinapsis tutorials page
🔍 License
This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the LICENSE file.
For commercial use, please refer to our official Sinapsis website for information on obtaining a commercial license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sinapsis_speech-0.2.2.tar.gz.
File metadata
- Download URL: sinapsis_speech-0.2.2.tar.gz
- Upload date:
- Size: 33.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e5a4d7d5201504aa17dd63cee5b2cb22d8f6e5179a11699f80612944f4c22455
|
|
| MD5 |
b5a602286daf5e2066d833fbfcaa493d
|
|
| BLAKE2b-256 |
b9160fbc8986013f00edcc764f3cff99c91ef713c88778d6744cc5115153af37
|
File details
Details for the file sinapsis_speech-0.2.2-py3-none-any.whl.
File metadata
- Download URL: sinapsis_speech-0.2.2-py3-none-any.whl
- Upload date:
- Size: 36.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
658f102d3ad40037f5e71bdf80b40f832ad8ed21f79e2e62b3b517413b6cfb11
|
|
| MD5 |
da636de23d269219da1d494f333cf1f4
|
|
| BLAKE2b-256 |
a3b8ff906f6a4c3f6f4c6edc3c7f7c935b4772b4d9e59b64c683c74a10c7332d
|