Skip to main content

Text-to-Speech Synthesis for the Speech Generation for Indigenous Language Education Small Teams Project

Project description

:construction: :construction: Warning! This repository is not quite ready yet. We're releasing it publicly in alpha, but it should be expected to change drastically over the coming months. :construction: :construction:

EveryVoice TTS Toolkit 💬

codecov Documentation Build Status license

This is the Text-to-Speech (TTS) toolkit used by the Small Teams "Speech Generation for Indigenous Language Education" project.

Quickstart

Install conda

First, you'll need to install conda. Miniforge3 is a fully open-source option which is free for all users and works well. You can also use Anaconda3 or Miniconda3 if you have or can get a license.

Clone the repo

git clone https://github.com/EveryVoiceTTS/EveryVoice.git
cd EveryVoice
git submodule update --init

Environment and installation – automated

To run EveryVoice, you need to create a new environment using Conda and Python 3.10, install all our dependencies and EveryVoice itself.

We have automated the procedure required to do all this in the script make-everyvoice-env, which you can run like this:

./make-everyvoice-env --name <env-name-of-your-choice>
conda activate <env-name-of-your-choice>

Add the option --cuda CUDA_VERSION if you need to override the default CUDA version, or --cpu to use Torch compiled for CPU use only.

Environment and installation – manual

If the automated installation process does not work for you, or if you prefer to do the full installation manually, please refer to EveryVoice / Installation.

Documentation

Read the full EveryVoice documentation.

In particular, read the Guides to get familiar with the whole process.

Contributing

Feel free to dive in! Open an issue or submit PRs.

This repo follows the Contributor Covenant Code of Conduct.

Please make sure our standard Git hooks are activated, by running these commands in your sandbox (if you used our make-everyvoice-env script then this step is already done for you):

pip install -r requirements.dev.txt
pre-commit install
gitlint install-hook
git submodule foreach 'pre-commit install'
git submodule foreach 'gitlint install-hook'

Have a look at Contributing.md for the full details on the Conventional Commit messages we prefer, our code formatting conventions, our Git hooks, and recommendations on how to make effective pull requests.

Acknowledgements

This repository draws on many other wonderful code bases. Many thanks to:

Tests

Run unit tests by python -m unittest tests/test_configs.py or suites of tests by running everyvoice test dev if you have the package installed interactively.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

everyvoice-0.2.0a1.tar.gz (152.0 kB view details)

Uploaded Source

Built Distribution

everyvoice-0.2.0a1-py3-none-any.whl (196.1 kB view details)

Uploaded Python 3

File details

Details for the file everyvoice-0.2.0a1.tar.gz.

File metadata

  • Download URL: everyvoice-0.2.0a1.tar.gz
  • Upload date:
  • Size: 152.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for everyvoice-0.2.0a1.tar.gz
Algorithm Hash digest
SHA256 c908ae971df5f95cd20c547f9d8abc9f49ad98f3102c021e0475f60bac09b476
MD5 4bb7d066548bb7de9afcadafddcdb9aa
BLAKE2b-256 0326e561d11a0bda37aedd82363985a6c0d942db7410d02ec27e54b387804050

See more details on using hashes here.

File details

Details for the file everyvoice-0.2.0a1-py3-none-any.whl.

File metadata

  • Download URL: everyvoice-0.2.0a1-py3-none-any.whl
  • Upload date:
  • Size: 196.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for everyvoice-0.2.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 593743361e542c4153f38e1ce030de0f59e3b2701d33f267c9dc2e5f485a709c
MD5 c46d0e8a6594cbf3104a3bfe9095ad2f
BLAKE2b-256 29a836d26c318893c06ac60b8f291ead340ceb9187bebbb4f48cf31cbeaf4edd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page