Metadata-Version: 2.1
Name: pvcheetahdemo
Version: 1.1.3
Summary: Cheetah speech-to-text engine demos
Home-page: https://github.com/Picovoice/cheetah
Author: Picovoice
Author-email: hello@picovoice.ai
License: UNKNOWN
Description: # 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 (4, 3) and NVIDIA Jetson Nano
        
        ## Compatibility
        
        - Python 3.5+
        - Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (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.
        
Keywords: Speech-to-Text,ASR,Speech Recognition,Voice Recognition,Automatic Speech Recognition
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Requires-Python: >=3.5
Description-Content-Type: text/markdown
