readme
This commit is contained in:
@@ -1,21 +1,25 @@
|
|||||||
|
|
||||||
# `AutoTranscript`: Fully Automated Transcription using AI
|
# `AutoTranscript`: Fully Automated Transcription using AI
|
||||||
|
|
||||||
`AutoTranscript` is a [PyTorch](https://pytorch.org/) based interface for. To enable fully auomated Transcription using AI models containing speaker diarization models:
|
`AutoTranscript` is a [PyTorch](https://pytorch.org/) based interface speech-to-text tool to generate fully automated transcriptions. AutoTranscript uses AI models containing speaker diarization models:
|
||||||
|
|
||||||
- [whisper](https://github.com/openai/whisper): an a general-purpose speech recognition model
|
- [whisper](https://github.com/openai/whisper): A general-purpose speech recognition model.
|
||||||
- [payannote-audio](https://github.com/pyannote/pyannote-audio) an open-source toolkit for speaker diarization
|
- [payannote-audio](https://github.com/pyannote/pyannote-audio): An open-source toolkit for speaker diarization-.
|
||||||
|
|
||||||
Therefore `AutoTranscript` can be used as a Commandline Interface a Webserver or as a Python API.
|
`AutoTranscript` can be used as a command-line interface, a webserver, or as a Python API.
|
||||||
|
|
||||||
## Setup:
|
## Install `AutoTranscript` :
|
||||||
For this Project, Python 3.9 were [PyTorch](https://pytorch.org/) version 1.11.0
|
|
||||||
|
|
||||||
The following command will pull and install the latest commit from this repository, along with its Python dependencies.
|
The following command will pull and install the latest commit from this repository, along with its Python dependencies.
|
||||||
|
|
||||||
pip install https://github.com/JSchmie/autotranscript.git
|
pip install https://github.com/JSchmie/autotranscript.git
|
||||||
|
|
||||||
## Example Python usage
|
- **Python version**: Python 3.9
|
||||||
|
- **PyTorch version**: Python 1.11.0
|
||||||
|
|
||||||
|
## Usage examples
|
||||||
|
|
||||||
|
### Python usage
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from autotranscript import AutoTranscribe
|
from autotranscript import AutoTranscribe
|
||||||
@@ -28,9 +32,9 @@ print(f"Transcription: \n{text}")
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Command-line usage
|
### Command-line usage
|
||||||
|
|
||||||
If you not want to control the optimization using python, you also can use the Command-line:
|
If you do not want to control the optimization using Python, you also can use the command-line:
|
||||||
|
|
||||||
autotranscript audio.wav
|
autotranscript audio.wav
|
||||||
|
|
||||||
@@ -38,10 +42,11 @@ Run the following to view all available options:
|
|||||||
|
|
||||||
autotranscript -h
|
autotranscript -h
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
## Citation
|
## Cite `AutoTranscript` :
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user