# 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, arm64)
- Android and iOS
- Chrome, Safari, Firefox, and Edge
- Raspberry Pi (3, 4, 5)
## Compatibility
- Python 3.8+
- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64, arm64), and Raspberry Pi (3, 4, 5).
## 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": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"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/1f/c2/51b36caa8a6b9943916918e5985c24782e8d1bacb9adf7fa5cd2df94304e/pvcheetahdemo-2.1.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, arm64)\n - Android and iOS\n - Chrome, Safari, Firefox, and Edge\n - Raspberry Pi (3, 4, 5)\n\n## Compatibility\n\n- Python 3.8+\n- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64, arm64), and Raspberry Pi (3, 4, 5).\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": null,
"summary": "Cheetah speech-to-text engine demos",
"version": "2.1.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": "1d9047a77a0d4caf823fb7ca884b6b1dbfe8b5a0a59edb8c87dd4adec98ef777",
"md5": "52ce1c4a09a4bcd153a572fa6b86ce3d",
"sha256": "bfe272901adaac1403251e6ba6f3fe6e696fb6b4494cd859c31a6ded0f6fe805"
},
"downloads": -1,
"filename": "pvcheetahdemo-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52ce1c4a09a4bcd153a572fa6b86ce3d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9239,
"upload_time": "2025-01-16T17:01:32",
"upload_time_iso_8601": "2025-01-16T17:01:32.834322Z",
"url": "https://files.pythonhosted.org/packages/1d/90/47a77a0d4caf823fb7ca884b6b1dbfe8b5a0a59edb8c87dd4adec98ef777/pvcheetahdemo-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1fc251b36caa8a6b9943916918e5985c24782e8d1bacb9adf7fa5cd2df94304e",
"md5": "1f89433053f5119161f58d43e43262de",
"sha256": "7ee197c5e514087b12a5daa214f4f9a8486ada6d21c16131264844f87e0948bd"
},
"downloads": -1,
"filename": "pvcheetahdemo-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1f89433053f5119161f58d43e43262de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8308,
"upload_time": "2025-01-16T17:01:34",
"upload_time_iso_8601": "2025-01-16T17:01:34.013805Z",
"url": "https://files.pythonhosted.org/packages/1f/c2/51b36caa8a6b9943916918e5985c24782e8d1bacb9adf7fa5cd2df94304e/pvcheetahdemo-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 17:01:34",
"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
