# Cheetah Speech-to-Text Demos
Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
## Cheetah
Cheetah is an on-device streaming speech-to-text engine. Cheetah is:
- Private; All voice processing runs locally.
- [Accurate](https://picovoice.ai/docs/benchmark/stt/)
- [Compact and Computationally-Efficient](https://github.com/Picovoice/speech-to-text-benchmark#rtf)
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), and Windows (x86_64)
- Android and iOS
- Chrome, Safari, Firefox, and Edge
- Raspberry Pi (5, 4, 3) and NVIDIA Jetson Nano
## Compatibility
- Python 3.7+
- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (5, 4, 3), and NVIDIA Jetson Nano.
## Installation
```console
pip3 install pvcheetahdemo
```
## AccessKey
Cheetah requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Cheetah SDKs.
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
## Usage
### Microphone Demo
You need a working microphone connected to your machine for this demo. Run the following in the terminal:
```console
cheetah_demo_mic --access_key ${ACCESS_KEY}
```
Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console.
### File Demo
Run the following in the terminal:
```console
cheetah_demo_file --access_key ${ACCESS_KEY} --wav_paths ${WAV_PATH}
```
Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console and `${WAV_PATH}` with a path to a compatible
(single-channel, 16 kHz, 16-bit PCM) wav file you wish to transcribe.
Raw data
{
"_id": null,
"home_page": "https://github.com/Picovoice/cheetah",
"name": "pvcheetahdemo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Speech-to-Text,ASR,Speech Recognition,Voice Recognition,Automatic Speech Recognition",
"author": "Picovoice",
"author_email": "hello@picovoice.ai",
"download_url": "https://files.pythonhosted.org/packages/e8/a9/4f9586847f331fe570470080c93003dd1c8a5f53004b66ca720e9a1cbbb2/pvcheetahdemo-2.0.1.tar.gz",
"platform": null,
"description": "# Cheetah Speech-to-Text Demos\n\nMade in Vancouver, Canada by [Picovoice](https://picovoice.ai)\n\n## Cheetah\n\nCheetah is an on-device streaming speech-to-text engine. Cheetah is:\n\n- Private; All voice processing runs locally.\n- [Accurate](https://picovoice.ai/docs/benchmark/stt/)\n- [Compact and Computationally-Efficient](https://github.com/Picovoice/speech-to-text-benchmark#rtf)\n- Cross-Platform:\n - Linux (x86_64), macOS (x86_64, arm64), and Windows (x86_64)\n - Android and iOS\n - Chrome, Safari, Firefox, and Edge\n - Raspberry Pi (5, 4, 3) and NVIDIA Jetson Nano\n\n## Compatibility\n\n- Python 3.7+\n- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (5, 4, 3), and NVIDIA Jetson Nano.\n\n## Installation\n\n```console\npip3 install pvcheetahdemo\n```\n\n## AccessKey\n\nCheetah requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Cheetah SDKs.\nYou can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.\nSignup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.\n\n## Usage\n\n### Microphone Demo\n\nYou need a working microphone connected to your machine for this demo. Run the following in the terminal:\n\n```console\ncheetah_demo_mic --access_key ${ACCESS_KEY}\n```\n\nReplace `${ACCESS_KEY}` with yours obtained from Picovoice Console.\n\n### File Demo\n\nRun the following in the terminal:\n\n```console\ncheetah_demo_file --access_key ${ACCESS_KEY} --wav_paths ${WAV_PATH}\n```\n\nReplace `${ACCESS_KEY}` with yours obtained from Picovoice Console and `${WAV_PATH}` with a path to a compatible\n(single-channel, 16 kHz, 16-bit PCM) wav file you wish to transcribe.\n",
"bugtrack_url": null,
"license": "",
"summary": "Cheetah speech-to-text engine demos",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://github.com/Picovoice/cheetah"
},
"split_keywords": [
"speech-to-text",
"asr",
"speech recognition",
"voice recognition",
"automatic speech recognition"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95eddf6a17701ef66d0baef67bddf10dfc6aa4831c46b4fcb8a98fdc3d899c26",
"md5": "4e0d3ae1976a63db6cfa300b62df5017",
"sha256": "71fde4d6f036623c053d85f51be9aea6f194d61eb02e33f241439eb86233cc27"
},
"downloads": -1,
"filename": "pvcheetahdemo-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e0d3ae1976a63db6cfa300b62df5017",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9257,
"upload_time": "2024-02-06T01:33:14",
"upload_time_iso_8601": "2024-02-06T01:33:14.926075Z",
"url": "https://files.pythonhosted.org/packages/95/ed/df6a17701ef66d0baef67bddf10dfc6aa4831c46b4fcb8a98fdc3d899c26/pvcheetahdemo-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e8a94f9586847f331fe570470080c93003dd1c8a5f53004b66ca720e9a1cbbb2",
"md5": "fd38769d5f804211ecf6a2ea7a55a3af",
"sha256": "bb0313f93afae402ae961dbef4180c40cdd89a1c88670b1b8a5fbadffaffd4b3"
},
"downloads": -1,
"filename": "pvcheetahdemo-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "fd38769d5f804211ecf6a2ea7a55a3af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8259,
"upload_time": "2024-02-06T01:33:16",
"upload_time_iso_8601": "2024-02-06T01:33:16.823044Z",
"url": "https://files.pythonhosted.org/packages/e8/a9/4f9586847f331fe570470080c93003dd1c8a5f53004b66ca720e9a1cbbb2/pvcheetahdemo-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-06 01:33:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Picovoice",
"github_project": "cheetah",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pvcheetahdemo"
}
JSON
