Skip to content

athena-alpha/auto-summary

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 

Repository files navigation

Auto Summary

This is a VERY rough bash script that automatically summarizes any YouTube link or local PDF, audio or video file.

All processing is done locally and thus, requires a decent CPU and/or GPU for it to run. Please don't expect any support or growth for this, it's just something we found useful to quickly and easily summarize all the various podcasts, YouTube videos, PDF files, videos and audio files that we come accross day to day.

Here is an example of it summarizing this 1.5 hour long YouTube Podcast. With a desktop CPU and modest GPU (eg. RTX 3060) it takes around 5 minutes.

image

🔥 REQUIREMENTS

Ubuntu: As of now, the bash script only works on Ubuntu. While there's no reason why it couldn't be adapted to run on Windows, macOS etc, we'll leave that to others.

🚀 INSTALLATION & RUNNING

  1. Download and install LM Studio (Auto Summary relies on open source LLMs to do the summarizing)

  2. In LM Studio download any LLM that works for your machine (Search -> "Mistral" -> Download)

image

  1. Once download, navigate to the Local Server area, select your LLM and click Start Server

image

  1. In a terminal, download Auto Summary to your system and give it execution permission
gh repo clone athena-alpha/auto-summary
cd auto-summary && chmod +x auto-summary.sh
  1. Run the Auto Summary script:

YouTube Summary Example:

./auto-summary.sh https://www.youtube.com/watch?v=dQw4w9WgXcQ

Local PDF Example:

./auto-summary.sh highly_technical_scientific_paper.pdf

Local Audio/Video Example:

./auto-summary.sh highly_questionable_video_file.mp4

Auto Summary will automatically detect and install a few required programs on its first run including:

  • yt-dlp: Used to download and extract YouTube audio
  • Whisper: Used to transacribe audio or video to text
  • jq: Uused to process the API JSON replies

We'd like to thank the developers of the above programs as well as LM Studio for their great work! 🧡

About

A bash script that automatically summarizes any YouTube link or local PDF, audio or video file

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages