Recasepunc

README.md

@@ -9,17 +9,26 @@ This python package serves as an Vosk interface for Opencast. It allows to gener
 Clone this project, go into the root directory and run `pip install . ` (the dot is important)
 
 ### 2. Install this dependencies
+From package manager
 
-- ffmpeg
-- vosk (with pip - package installer for python)
-- webvtt-py (pip)
+- ffmpeg 
+
+From pip - package installer for python:
+- vosk 
+- webvtt-py
+- numpy
+- regex
+- torch
+- tqdm
+- transformers
 
 ### 3. Download the language model
 
 Go to the Website `https://alphacephei.com/vosk/models` and download at least the english language model.
 
-Unzip the folder of the language model into `/usr/share/vosk/language/***`, and rename the folder from `***` to `eng` for example.
+Unzip the folder of the language model into `/usr/share/vosk/language/***`, and rename the folder from `***` to `eng` for example. \
+The punctation checkpoint have to be at `/usr/share/vosk/language/***-punctuation` and rename `***`to `eng` for example. \
 Please use 3 digit language codes for the directory name. The default and fallback language directory of vosk-cli is `eng`.
 The directory name should match the workflow operation field `language-code`.
 
-Now you are able to run `vosk-cli -i <input_file_path> -o <output_file_path> -l <3_digit_language_code>`.
+Now you are able to run `vosk-cli [-p] -i <input_file_path> -o <output_file_path> -l <3_digit_language_code>`.