sinapsis-speech 0.1.0

Generate speech using various libraries.

Sinapsis Speech

Templates for a wide range of voice generation tasks.

🐍 Installation • 📦 Packages • 🌐 Webapp • 📙 Documentation • 🔍 License

🐍 Installation

[!IMPORTANT] Sinapsis projects requires Python 3.10 or higher.

We strongly encourage the use of uv, although any other package manager should work too. If you need to install uv please see the official documentation.

1. Install using your favourite package manager.

Example 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

Change the name of the package for the one you want to install.

[!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

Each package can be used independently or combined to create more complex workflows. Below is an overview of the available packages:

Elevenlabs

This package provides a suite of templates and utilities for seamlessly integrating, configuring, and running text-to-speech (TTS) and voice generation functionalities powered by ElevenLabs:

• Text-to-speech: Template for converting text into speech using ElevenLabs' voice models.

• Voice generation: Template for generating custom synthetic voices based on user-provided descriptions.

🌐 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 [e-mail]: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] The CosyVoice model requires at least 4GB of ram to work.

[!IMPORTANT] Elevenlabs requires an api key to run any inference. Please go to the official website, create an account. If you already have an account, go to the token page and generate a token.

[!IMPORTANT] set your env var using export ELEVENLABS_API_KEY='your-api-key'

[!TIP] The agent configuration can be updated using the AGENT_CONFIG_PATH environment var.

🐳 Build with Docker

IMPORTANT This docker image depends on the sinapsis-nvidia:base image. Please refer to the official sinapsis instructions to Build with Docker.

1. Build the Docker image:

docker compose -f docker/compose.yaml build

2. Launch the service:

docker compose -f docker/compose_apps.yaml up -d sinapsis-elevenlabs

2. Check the logs

docker logs -f sinapsis-elevenlabs

3. The logs will display the URL to access the webapp, e.g.,::

Running on local URL:  http://127.0.0.1:7860

4. To stop the app:

docker compose -f docker/compose_apps.yaml down sinapsis-elevenlabs

💻 UV

1. Sync the virtual environment:

uv sync --frozen

2. Install the wheel:

uv pip install sinapsis-speech[all] --extra-index-url https://pypi.sinapsis.tech

3. Activate the virtual environment:

source .venv/bin/activate

4. Declare PYTHONPATH

export PYTHONPATH=$PWD/webapps 

NOTE if not located in sinapsis-speech folder, change $PWD for the actual path to sinapsis-speech

5. Launch the demo:

python webapps/elevenlabs/elevenlabs_tts_app.py

6. Open the displayed URL, e.g.:

Running on local URL:  http://127.0.0.1:7860

NOTE: The URL can be different, please make sure you check the logs.

📙 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.