Metadata-Version: 2.1
Name: pythaiasr
Version: 1.2.0
Summary: Python Thai ASR
Home-page: https://github.com/pythainlp/pythaiasr
Author: Wannaphong Phatthiyaphaibun
Author-email: wannaphong@yahoo.com
License: Apache Software License 2.0
Description: # PyThaiASR
        
        Python Thai Automatic Speech Recognition
        
         <a href="https://pypi.python.org/pypi/pythaiasr"><img alt="pypi" src="https://img.shields.io/pypi/v/pythaiasr.svg"/></a><a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a><a href="https://pepy.tech/project/pythaiasr"><img alt="Download" src="https://pepy.tech/badge/pythaiasr/month"/></a>
        
        PyThaiASR is a Python package for Automatic Speech Recognition with focus on Thai language. It have offline thai automatic speech recognition model.
        
        License: [Apache-2.0 License](https://github.com/PyThaiNLP/pythaiasr/blob/main/LICENSE)
        
        Google Colab: [Link Google colab](https://colab.research.google.com/drive/1zHt3GoxXWCaNSMRzE5lrvpYm9RolcxOW?usp=sharing)
        
        Model homepage: https://huggingface.co/airesearch/wav2vec2-large-xlsr-53-th
        
        ## Install
        
        ```sh
        pip install pythaiasr
        ```
        
        **For Wav2Vec2 with language model:**
        if you want to use wannaphong/wav2vec2-large-xlsr-53-th-cv8-* model with language model, you needs to install by the step.
        
        ```sh
        pip install pythaiasr[lm]
        pip install https://github.com/kpu/kenlm/archive/refs/heads/master.zip
        ```
        
        ## Usage
        
        ```python
        from pythaiasr import asr
        
        file = "a.wav"
        print(asr(file))
        ```
        ### API
        
        ```python
        asr(file: str, model: str = _model_name, lm: bool=False, device: str=None)
        ```
        
        - file: path of sound file
        - model: The ASR model
        - lm: Use language model (except *airesearch/wav2vec2-large-xlsr-53-th* model)
        - device: device
        - return: thai text from ASR
        
        **Options for model**
        - *airesearch/wav2vec2-large-xlsr-53-th* (default) - AI RESEARCH - PyThaiNLP model
        - *wannaphong/wav2vec2-large-xlsr-53-th-cv8-newmm* - Thai Wav2Vec2 with CommonVoice V8 (newmm tokenizer)
        - *wannaphong/wav2vec2-large-xlsr-53-th-cv8-deepcut* - Thai Wav2Vec2 with CommonVoice V8 (deepcut tokenizer)
        
        You can read about models from the list:
        
        - [*airesearch/wav2vec2-large-xlsr-53-th* - AI RESEARCH - PyThaiNLP model](https://medium.com/airesearch-in-th/airesearch-in-th-3c1019a99cd)
        - [*annaphong/wav2vec2-large-xlsr-53-th-cv8-newmm* - Thai Wav2Vec2 with CommonVoice V8 (newmm tokenizer) + language model](https://huggingface.co/wannaphong/wav2vec2-large-xlsr-53-th-cv8-newmm) 
        - [*wannaphong/wav2vec2-large-xlsr-53-th-cv8-deepcut* - Thai Wav2Vec2 with CommonVoice V8 (deepcut tokenizer) + language model](https://huggingface.co/wannaphong/wav2vec2-large-xlsr-53-th-cv8-deepcut)
        
        ### Docker
        To use this inside of Docker do the following:
        ```sh
        docker build -t <Your Tag name> .
        docker run docker run --entrypoint /bin/bash -it <Your Tag name>
        ```
        You will then get access to a interactive shell environment where you can use python with all packages installed.
        
Keywords: asr
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: Thai
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
Provides-Extra: lm
