jlengrand/tldw
1
0
Fork 0
mirror of https://github.com/jlengrand/tldw.git synced 2026-03-10 08:51:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Fixed help output
This commit is contained in:
Robert
2024-05-15 22:45:48 -07:00
parent b64a02ae46
commit 88af24573a
1 changed files with 27 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -129,8 +129,9 @@ GUI
Save time and use the `config.txt` file, it allows you to set these settings and have them used when ran. Save time and use the `config.txt` file, it allows you to set these settings and have them used when ran.
``` ```
usage: summarize.py [-h] [-v] [-api API_NAME] [-ns NUM_SPEAKERS] [-wm WHISPER_MODEL] [-off OFFSET] [-vad] usage: summarize.py [-h] [-v] [-api API_NAME] [-key API_KEY] [-ns NUM_SPEAKERS] [-wm WHISPER_MODEL] [-off OFFSET] [-vad]
[-log {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-ui] [-demo] [-log {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-ui] [-demo] [-prompt CUSTOM_PROMPT] [-overwrite] [-roll]
[-detail DETAIL_LEVEL]
[input_path] [input_path]
Transcribe and summarize videos. Transcribe and summarize videos.
@@ -143,6 +144,8 @@ options:
-v, --video Download the video instead of just the audio -v, --video Download the video instead of just the audio
-api API_NAME, --api_name API_NAME -api API_NAME, --api_name API_NAME
API name for summarization (optional) API name for summarization (optional)
-key API_KEY, --api_key API_KEY
API key for summarization (optional)
-ns NUM_SPEAKERS, --num_speakers NUM_SPEAKERS -ns NUM_SPEAKERS, --num_speakers NUM_SPEAKERS
Number of speakers (default: 2) Number of speakers (default: 2)
-wm WHISPER_MODEL, --whisper_model WHISPER_MODEL -wm WHISPER_MODEL, --whisper_model WHISPER_MODEL
@@ -155,19 +158,34 @@ options:
-ui, --user_interface -ui, --user_interface
Launch the Gradio user interface Launch the Gradio user interface
-demo, --demo_mode Enable demo mode -demo, --demo_mode Enable demo mode
-prompt CUSTOM_PROMPT, --custom_prompt CUSTOM_PROMPT
Pass in a custom prompt to be used in place of the existing one. (Probably should just modify the script itself...)
-overwrite, --overwrite
Overwrite existing files
-roll, --rolling_summarization
Enable rolling summarization
-detail DETAIL_LEVEL, --detail_level DETAIL_LEVEL
Mandatory if rolling summarization is enabled, defines the chunk size. Default is 0.01(lots of chunks) -> 1.00 (few
chunks) Currently only OpenAI works.
-Download Audio only from URL -> Transcribe audio: -Download Audio only from URL -> Transcribe audio:
>python summarize.py https://www.youtube.com/watch?v=4nd1CDZP21s >python summarize.py https://www.youtube.com/watch?v=4nd1CDZP21s
-Download Audio only from URL -> Transcribe audio -> Summarize using (`anthropic`/`cohere`/`openai`/`llama` i.e. llama.cpp/`ooba`/`kobold`/`tabby`) API: -Transcribe audio from a Youtube URL & Summarize it using (anthropic/cohere/openai/llama (llama.cpp)/ooba (oobabooga/text-gen-webui)/kobold (kobold.cpp)/tabby (Tabbyapi)) API:
>python summarize.py https://www.youtube.com/watch?v=4nd1CDZP21s -api <your choice of API> >python summarize.py https://www.youtube.com/watch?v=4nd1CDZP21s -api <your choice of API>
- Make sure to put your API key into `config.txt` under the appropriate API variable
-Download Audio+Video from URL -> Transcribe audio from Video: -Download Video with audio from URL -> Transcribe audio from Video:
>python summarize.py --video https://www.youtube.com/watch?v=4nd1CDZP21s >python summarize.py -v https://www.youtube.com/watch?v=4nd1CDZP21s
-Download Audio+Video from a list of videos in a text file (can be file paths or URLs) and have them all summarized: -Download Audio+Video from a list of videos in a text file (can be file paths or URLs) and have them all summarized:
>python summarize.py --video ./local/file_on_your/system --api_name <API_name> >python summarize.py --video ./local/file_on_your/system --api_name <API_name>
-Transcribe & Summarize a List of Videos on your local filesytem with a text file:
>python summarize.py -v ./local/file_on_your/system
-Run it as a WebApp:
>python summarize.py -gui
By default videos, transcriptions and summaries are stored in a folder with the video's name under './Results', unless otherwise specified in the config file. By default videos, transcriptions and summaries are stored in a folder with the video's name under './Results', unless otherwise specified in the config file.
``` ```