Git Product home page Git Product logo

consultaudio-demo's Introduction

ConsultAudio project demo

by Andrii Shevtsov, Yaroslav Prytula, Viacheslav Hodlevskyi

Main idea

ConsultAudio is a personal assistant for lecturers, allowing them to answer many direct messages after lectures without much effort. Also, it will enable people to get answers from lecturers who are not reachable to them: those who are too busy, too high-level, or who have passed away.

The project clones the lecturer's voice and tries to capture his answering style. It uses the lecture and supplementary materials from YouTube video descriptions and PDFs.

Demo videos

Demo 1 (click on the image to watch the YouTube video):

Demo1 preview

Demo 2 (click on the image to watch the YouTube video):

Demo1 preview

How to run it?

Environment setup

We are using Python's native virtual environments along with pip package manager and requirements.txt files.

To run the project, create a virtual environment via python<version> -m venv .venv.

Then, activate the environment:

  • On Linux/Mac: source .venv/bin/activate.
  • On Windows: .venv/Scripts/activate.bat.

And install requirements.txt:

pip install -r requirements.txt

Then, fill .env environment file, like the sample.env file is filled:

SAVE_PATH=./data/audios

HUGGINGFACEHUB_API_TOKEN=<your_token(with_write_access)_here>
OPENAI_API_KEY=<your_key_here>

Run the UI

To run the UI after the environment is set up, you can just run it with Python:

python gradio_ui.py

Main architecture

The architecture here consists of two main parts: indexing and retrieval. The first allows us to store all the needed data for the RAG system, and the second uses the first to answer the user's question and convert the answer to the lecturer's voice.

Indexing stage

Retrieval stage

LLM QA is possible here with two models: GPT-3.5 and Gemma-2b for now. Gemma's context length and ability to understand context are pretty low for now, but they allow us to have a local model performing the crucial task.

Folder structure

  • components folder contains the main RAG pipeline, YouTube parsing, and TTS parts.
  • data folder stores audio, transcriptions, and other data.
  • images is supplementary folder to store Readme images.
  • notebooks folder contains notebooks with experiments that lay behind the whole model.

Following steps

  • Add separate demos for adding materials to DB and using them.
  • Add OCR for frames for better video understanding.
  • Assure better DB usage: a person who wants to get info from one lecturer shouldn't get info from others' lectures.

Acknowledgements

Thanks to AI House, Ukrainian Catholic University, Faculty of Applied Sciences of UCU for organizing Generative AI Spring School. Also, thanks to the school's partners: GlobalLogic, SoftServe, Skylum, and ADVA Soft.

Special thanks to Ampersand Education Foundation which allows me (Andrii Shevtsov, PrometheusUA) to obtain my education at the Ukrainian Catholic University.

consultaudio-demo's People

Contributors

prometheusua avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.