# Cheetah Binding for Python
## Cheetah Speech-to-Text Engine
Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
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 (3, 4, 5)
## Compatibility
- Python 3.8+
- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), and Raspberry Pi (3, 4, 5).
## Installation
```console
pip3 install pvcheetah
```
## 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
Create an instance of the engine and transcribe audio:
```python
import pvcheetah
handle = pvcheetah.create(access_key='${ACCESS_KEY}')
def get_next_audio_frame():
pass
while True:
partial_transcript, is_endpoint = handle.process(get_next_audio_frame())
if is_endpoint:
final_transcript = handle.flush()
```
Replace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/). When done be sure
to explicitly release the resources using `handle.delete()`.
## Demos
[pvcheetahdemo](https://pypi.org/project/pvcheetahdemo/) provides command-line utilities for processing audio using
Cheetah.
Raw data
{
"_id": null,
"home_page": "https://github.com/Picovoice/cheetah",
"name": "pvcheetah",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Speech-to-Text, Speech Recognition, Voice Recognition, ASR, Automatic Speech Recognition",
"author": "Picovoice",
"author_email": "hello@picovoice.ai",
"download_url": "https://files.pythonhosted.org/packages/b1/7d/edf63e9b86064334828b42d461d19bdfa7c0985f2df0ba2a33fe3cbfae6d/pvcheetah-2.0.2.tar.gz",
"platform": null,
"description": "# Cheetah Binding for Python\n\n## Cheetah Speech-to-Text Engine\n\nMade in Vancouver, Canada by [Picovoice](https://picovoice.ai)\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 (3, 4, 5)\n\n## Compatibility\n\n- Python 3.8+\n- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), and Raspberry Pi (3, 4, 5).\n\n## Installation\n\n```console\npip3 install pvcheetah\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\nCreate an instance of the engine and transcribe audio:\n\n```python\nimport pvcheetah\n\nhandle = pvcheetah.create(access_key='${ACCESS_KEY}')\n\ndef get_next_audio_frame():\n pass\n\nwhile True:\n partial_transcript, is_endpoint = handle.process(get_next_audio_frame())\n if is_endpoint:\n final_transcript = handle.flush()\n```\n\nReplace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/). When done be sure\nto explicitly release the resources using `handle.delete()`.\n\n## Demos\n\n[pvcheetahdemo](https://pypi.org/project/pvcheetahdemo/) provides command-line utilities for processing audio using\nCheetah.\n",
"bugtrack_url": null,
"license": null,
"summary": "Cheetah Speech-to-Text Engine.",
"version": "2.0.2",
"project_urls": {
"Homepage": "https://github.com/Picovoice/cheetah"
},
"split_keywords": [
"speech-to-text",
" speech recognition",
" voice recognition",
" asr",
" automatic speech recognition"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc262d24d242bfc1bed5d77ee19d071cd38a655732112f873d8e49dc2aa867e7",
"md5": "b40f984f66b1165f39c2146618e88e8d",
"sha256": "ec8a698b4bc601ace4a3c84993cff74652c835f3f1a8150eab8311b3e30bfa3a"
},
"downloads": -1,
"filename": "pvcheetah-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b40f984f66b1165f39c2146618e88e8d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 29389383,
"upload_time": "2024-09-17T23:37:37",
"upload_time_iso_8601": "2024-09-17T23:37:37.666506Z",
"url": "https://files.pythonhosted.org/packages/dc/26/2d24d242bfc1bed5d77ee19d071cd38a655732112f873d8e49dc2aa867e7/pvcheetah-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b17dedf63e9b86064334828b42d461d19bdfa7c0985f2df0ba2a33fe3cbfae6d",
"md5": "ebd05b1d82195f3981f4e1a135b6569d",
"sha256": "c266a9ef8d59ebae4daa6d8b011976129ca497847dd40271f54f6e15f221c901"
},
"downloads": -1,
"filename": "pvcheetah-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "ebd05b1d82195f3981f4e1a135b6569d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 29381812,
"upload_time": "2024-09-17T23:37:46",
"upload_time_iso_8601": "2024-09-17T23:37:46.719158Z",
"url": "https://files.pythonhosted.org/packages/b1/7d/edf63e9b86064334828b42d461d19bdfa7c0985f2df0ba2a33fe3cbfae6d/pvcheetah-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-17 23:37:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Picovoice",
"github_project": "cheetah",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pvcheetah"
}
JSON
