🐍 Installation • 📦 Packages • 🌐 Webapps • 📙 Documentation • 🔍 License
Important
Sinapsis projects requires Python 3.10 or higher.
This repo includes packages for performing speech synthesis using different tools:
sinapsis-elevenlabssinapsis-f5-tts-
sinapsis-kokoro
sinapsis-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.techOr with raw pip:
pip install sinapsis-elevenlabs --extra-index-url https://pypi.sinapsis.techReplace 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.techOr with raw pip:
pip install sinapsis-elevenlabs[all] --extra-index-url https://pypi.sinapsis.techBe 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.techThis 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 Kokoro
This package provides a single template for integrating, configuring, and running text-to-speech (TTS) synthesis using the Kokoro 82M v1.0 model.
KokoroTTS: Converts text to speech using the Kokoro TTS model. The template processes text packets from the input container, generates corresponding audio using Kokoro, and adds the resulting audio packets to the container. 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.
Important
To run the app you first need to clone this repository:
git clone git@github.com:Sinapsis-ai/sinapsis-speech.git
cd sinapsis-speechNote
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_PATH env 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 Kokoro:
docker compose -f docker/compose_apps.yaml up -d sinapsis-kokoro- 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 Kokoro:
docker logs -f sinapsis-kokoro- 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:7860NOTE: 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/generic_tts_apps/elevenlabs_tts_app.py- For F5-TTS:
uv run webapps/packet_tts_apps/f5_tts_app.py- For Kokoro:
uv run webapps/packet_tts_apps/kokoro_tts_app.py- For Zonos:
uv run webapps/generic_tts_apps/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:7860NOTE: The URL may vary; check the terminal output for the correct address.
Documentation is available on the sinapsis website
Tutorials for different projects within sinapsis are available at sinapsis tutorials page
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.
