Metadata-Version: 2.1
Name: pvcheetah
Version: 0.9.0
Summary: Cheetah Speech-to-Text Engine.
Home-page: https://github.com/Picovoice/cheetah
Author: Picovoice
Author-email: hello@picovoice.ai
License: UNKNOWN
Description: # 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 [[1]](https://github.com/Picovoice/speech-to-text-benchmark#results)
        - Compact and Computationally-Efficient [[1]](https://github.com/Picovoice/speech-to-text-benchmark#results)
        - Cross-Platform:
            - Linux (x86_64)
            - macOS (x86_64, arm64)
            - Windows (x86_64)
            - Android
            - iOS
            - Raspberry Pi (4, 3)
            - NVIDIA Jetson Nano
        
        ## Compatibility
        
        - Python 3
        - Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (4, 3), and NVIDIA Jetson Nano.
        
        ## Installation
        
        ```console
        pip3 install pvcheetah
        ```
        
        ## AccessKey
        
        AccessKey is your authentication and authorization token for deploying Picovoice SDKs, including Cheetah. Anyone who is
        using Picovoice needs to have a valid AccessKey. You must keep your AccessKey secret. You would need internet
        connectivity to validate your AccessKey with Picovoice license servers even though the voice recognition is running 100%
        offline.
        
        AccessKey also verifies that your usage is within the limits of your account. Everyone who signs up for
        [Picovoice Console](https://console.picovoice.ai/) receives the `Free Tier` usage rights described
        [here](https://picovoice.ai/pricing/). If you wish to increase your limits, you can purchase a subscription plan.
        
        ### 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.
        
Keywords: Speech-to-Text,Speech Recognition,Voice Recognition,ASR
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
Description-Content-Type: text/markdown
