cltl-asr
Speech to text service for Leolani. This repository is a component of the Leolani framework. For usage of the component within the framework see the instructions there.
Description
This package contains multiple implementations to convert text from spoken language for any written text.
Getting started
Prerequisites
This repository uses Python >= 3.7
Be sure to run in a virtual python environment (e.g. conda, venv, mkvirtualenv, etc.)
Installation
-
In the root directory of this repo run
pip install -e .
Usage
For using this repository as a package different project and on a different virtual environment, you may
-
install a published version from PyPI:
pip install cltl.asr
-
or, for the latest snapshot, run:
pip install git+git://github.com/leolani/cltl-asr.git@main
Then you can import it in a python script as:
import numpy as np
import soundfile as sf
from importlib_resources import path
from cltl.asr.speechbrain_asr import SpeechbrainASR
asr = SpeechbrainASR("speechbrain/asr-transformer-transformerlm-librispeech")
with path("resources", "test.wav") as wav:
speech_array, sampling_rate = sf.read(wav, dtype=np.int16)
transcript = asr.speech_to_text(speech_array, sampling_rate)Examples
Please take a look at the example scripts provided to get an idea on how to run and use this package. Each example has a comment at the top of the script describing the behaviour of the script.
For these example scripts, you need
-
To change your current directory to ./examples/
-
Run some examples (e.g. python test_speechbrain_asr.py)
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
To DO
- Fix logging
- Fix config of language, save/play audio file, audio directory
- Check if we can switch voices via different APIs
- Check implementation middle layer
License
Distributed under the MIT License. See LICENSE
for more information.