Cheetah Speech-to-Text
Rust Quick Start

Platforms

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

Requirements

• Picovoice Account & AccessKey
• Rust 1.54+
• Cargo

Picovoice Account & AccessKey

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

Quick Start

Setup

1. Download and install Rust.

2. Add pv_cheetah to the Cargo.toml manifest:

[dependencies]
pv_cheetah = "*"

Usage

Create an instance of the engine and transcribe audio:

use cheetah::CheetahBuilder;

let access_key = "${ACCESS_KEY}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)

let cheetah: Cheetah = CheetahBuilder::new()
    .access_key(access_key)
    .init()
    .expect("Unable to create Cheetah");

fn next_audio_frame() -> Vec<i16> {
  // get audio frame
}

if let Ok(cheetah_transcript) = cheetah.process(&next_audio_frame()) {
  println!("{}", cheetah_transcript.transcript)
  if cheetah_transcript.is_endpoint {
    if let Ok(cheetah_transcript) = cheetah.flush() {
      println!("{}", cheetah_transcript.transcript)
    }
  }
}

Model File

The Cheetah Rust SDK comes preloaded with a default English language model (.pv file). Default models for other supported languages can be found in the Cheetah Speech-to-Text GitHub repository.

Create custom language models using the Picovoice Console. Here you can train language models with custom vocabulary and boost words in the existing vocabulary.

Pass in the .pv file via the .model_path() Builder argument:

let leopard: Cheetah = CheetahBuilder::new()
    .access_key("${ACCESS_KEY}")
    .model_path("${MODEL_FILE_PATH}")
    .init()
    .expect("Unable to create Cheetah");

Demo

For the Cheetah Streaming Speech-to-Text Rust 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

Clone the Cheetah Streaming Speech-to-Text repository from GitHub using HTTPS:

git clone --recurse-submodules https://github.com/Picovoice/cheetah.git

Usage

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

cheetah/demo/rust/micdemo
cargo run --release -- --help

Run the following command to transcribe real-time audio:

cargo run --release -- --access_key ${ACCESS_KEY}

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

Resources