Cheetah Speech-to-Text
Python Quick Start

Platforms

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64, arm64)
• Raspberry Pi (3, 4, 5)

Requirements

• Picovoice Account & AccessKey
• Python 3.9+
• PIP

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Install Python 3.

2. Install the pvcheetah Python package using PIP:

pip3 install pvcheetah

Usage

Create an instance of the engine and transcribe audio:

import pvcheetah

cheetah = pvcheetah.create(access_key='${ACCESS_KEY}')

def get_next_audio_frame():
    pass

while True:
    partial_transcript, is_endpoint = cheetah.process(get_next_audio_frame())
    if is_endpoint:
        final_transcript = cheetah.flush()

Free resources used by Cheetah Streaming Speech-to-Text:

cheetah.delete()

Non-English Languages

In order to use Cheetah with other languages, you need to use the corresponding model file (.pv) for the desired language. The model files for all supported languages are available on the Cheetah GitHub repository.

Train Models over API

You can train models over API without going to the console:

train_model_from_words(
        "${ACCESS_KEY}",                                                   # AccessKey obtained from Picovoice Console (https://console.picovoice.ai/).
        "${OUTPUT_PATH}",                                                  # Path to save the newly trained model.
        "${LANGUAGE}",                                                     # Two-character language code.
        {"${NEW_WORD}": set(["${PRONUNCIATION1}", "${PRONUNCIATION2}"])},  # New words with optional custom pronunciation to add to the model.
        set(["${BOOST_WORD1}", "${BOOST_WORD2}"]))                         # Boost words.

(or)

train_model_from_yaml(
        "${ACCESS_KEY}",   # AccessKey obtained from Picovoice Console (https://console.picovoice.ai/).
        "${OUTPUT_PATH}",  # Path to save the newly trained model.
        "${LANGUAGE}",     # Two-character language code.
        "${YAML_PATH}")    # Path to YAML configuration file.

Check Cheetah Model API docs for a list of supported languages.

Demo

For the Cheetah Streaming Speech-to-Text Python SDK, we offer demo applications that demonstrate how to use the Speech-to-Text engine on real-time audio streams (i.e. microphone input).

Setup

Install the pvcheetahdemo Python package using PIP:

pip3 install pvcheetahdemo

This package installs command-line utilities for the Cheetah Streaming Speech-to-Text Python demos.

Usage

Use the --help flag to see the usage options for the demo:

cheetah_demo_mic --help

Run the following command to start transcribing microphone input:

cheetah_demo_mic --access_key ${ACCESS_KEY}

For more information on our Cheetah Streaming Speech-to-Text demos for Python, head over to our GitHub repository.

Resources