Open carmen-chau opened 4 months ago
Please feel free to add more documentation improvements here (or in another document if prefered)
The CLI currently supports the following options:
-howtouse
: Explains how to use tool (To use this, run the following command: ./streetwhisperapp -howtouse
(if with generated exe) or python streetwhisperapp -howtouse
(if directly interacting with the script))-credits
: Credits section (To use this, run the following command: ./streetwhisperapp -credits
(if with generated exe) or python streetwhisperapp -credits
(if directly interacting with the script))--help
: Shows all the options available (To use this, run the following command: ./streetwhisperapp --help
(if with generated exe) or python streetwhisperapp --help
(if directly interacting with the script))To start up the app, run the following command: ./streetwhisperapp
(if running the generated exe) or python streetwhisperapp
(if running the script).
General list of additional information / instructions to add:
models--pyannote--speaker-diarization-3.1
located in their .cache folder, then the CLI would download it first. This leads to a progress bar (with no label) showing up). Users should be made aware about this.Picture reference:
define_whisper_model
. There is no label to this progress bar, so users should be aware about what this progress bar is.Picture for reference: