You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
General list of additional information / instructions to add:
If the user does not have 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:
If the user does not have the desired whisper .pt file in their local .cache folder, then a progress bar would show up during the running of method 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:
The text was updated successfully, but these errors were encountered:
Please feel free to add more documentation improvements here (or in another document if prefered)
carmen-chau
changed the title
Minor: Revise README.md with new CLI instructions
Documentation addition: Revise README.md (and/or the "help" feature from the CLI) with new instructions
Apr 29, 2024
moonsdust
changed the title
Documentation addition: Revise README.md (and/or the "help" feature from the CLI) with new instructions
Documentation addition: Revise README.md (and/or the "help"/"how to use" feature from the CLI) with new instructions
May 11, 2024
The README.md needs to be updated with the following:
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:
The text was updated successfully, but these errors were encountered: