Update README.md

This commit is contained in:
Kristofer Rolf Söderström
2023-03-22 13:35:12 +01:00
committed by GitHub
parent 407c119116
commit 1332bb7538

View File

@@ -6,11 +6,10 @@ Simple implementation of OpenAI's Whisper to transcribe audio files from your lo
1. This script was made and tested in an Anaconda environment with python 3.10, if you're not familiar with python I would recommend this method. 1. This script was made and tested in an Anaconda environment with python 3.10, if you're not familiar with python I would recommend this method.
See [here](https://docs.anaconda.com/anaconda/install/index.html) for instructions. You might need administrator rights. See [here](https://docs.anaconda.com/anaconda/install/index.html) for instructions. You might need administrator rights.
2. Whisper requires some additional libraries. The [setup](https://github.com/openai/whisper#setup) page states: "The codebase also depends on a few Python packages, most notably HuggingFace Transformers for their fast tokenizer implementation and ffmpeg-python for reading audio files." 2. Whisper requires some additional libraries. The [setup](https://github.com/openai/whisper#setup) page states: "The codebase also depends on a few Python packages, most notably HuggingFace Transformers for their fast tokenizer implementation and ffmpeg-python for reading audio files."
Users might not need to specifically install Transfomers. However, a conda installation might be needed for ffmepg, which takes care of setting up PATH variables. Install with: Users might not need to specifically install Transfomers. However, a conda installation might be needed for ffmepg[^1], which takes care of setting up PATH variables. Install with:
``` ```
conda install -c conda-forge ffmpeg-python conda install -c conda-forge ffmpeg-python
``` ```
Advanced users can use ```pip install ffmpeg-python``` but be ready to deal with some [PATH issues](https://stackoverflow.com/questions/65836756/python-ffmpeg-wont-accept-path-why), which I encountered in Windows 11.
3. The main functionality comes from openai-whisper. See their [page](https://github.com/openai/whisper) for details. As of 2023-03-22 you can install via: 3. The main functionality comes from openai-whisper. See their [page](https://github.com/openai/whisper) for details. As of 2023-03-22 you can install via:
``` ```
pip install -U openai-whisper pip install -U openai-whisper
@@ -25,4 +24,4 @@ and use the example.ipynb template to use the script **OR** download the ```tran
### Example ### Example
See the [example](example.ipynb) implementation on jupyter notebook. See the [example](example.ipynb) implementation on jupyter notebook.
[^1]Advanced users can use ```pip install ffmpeg-python``` but be ready to deal with some [PATH issues](https://stackoverflow.com/questions/65836756/python-ffmpeg-wont-accept-path-why), which I encountered in Windows 11.