Cheetah - Go Quick Start

Platforms

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64)
• NVIDIA Jetson Nano
• Raspberry Pi (3, 4)

Requirements

• Picovoice Account & AccessKey
• Go 1.16+
• Windows only: a gcc compiler like Mingw in $PATH

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

2. Install the Cheetah Go Package using the Go CLI:

go get github.com/Picovoice/cheetah/binding/go

Usage

Create an instance of the Cheetah engine:

import . "github.com/Picovoice/cheetah/binding/go"

cheetah = NewCheetah{AccessKey: "${ACCESS_KEY}"} // AccessKey provided by Picovoice Console (https://console.picovoice.ai/)
err := cheetah.Init()
if err != nil {
    // handle init err
}
defer cheetah.Delete()

Transcribe audio:

func getNextFrameAudio() []int16{
    // get audio frame
}

for {
  partialTranscript, isEndpoint, err = cheetah.Process(getNextFrameAudio())
  if isEndpoint {
    finalTranscript, err = cheetah.Flush()
  }
}

When done be sure to explicitly release the resources using cheetah.Delete().

Demo

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

Setup

Clone the Cheetah repository from GitHub using HTTPS:

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

Usage

To see the usage options for the demos, use the -h flag:

cd cheetah/demo/go
go run micdemo/cheetah_mic_demo.go -h

Ensure you have a working microphone connected to your system and run the following command to perform live speech-to-text:

go run micdemo/cheetah_mic_demo.go -access_key "${ACCESS_KEY}"

For more information on our Cheetah demos for Go, head over to our GitHub repository.

Resources

Packages

• cheetah on pkg.go.dev

API

• cheetah Go API Docs

GitHub

• Cheetah Go SDK on GitHub
• Cheetah Go demo on GitHub

Benchmark

• Speech-to-Text Benchmark