Giter Club home page Giter Club logo

audiomind's Introduction

AudioMind

Star the repository if this was useful. ⭐️

This repository is currently under rapid development. Breaking changes may occur frequently.

PyPI version Downloads Downloads Downloads

GitHub license

Overview

AudioMind is a Python-based solution designed to extract meaningful insights from audio files. By leveraging whisper and LLMs, the platform transcribes and summarizes audio content, making it easier to derive actionable information.

Stack

LLM

  • OpenAI

Speech to Text

  • Whisper (Openai API) [DEFAULT]
  • Whisper (On-Device)

Current Solutions

  • Create a journal entry from your voice note.

Goals

  • Transcribe audio files to text.
  • Summarize the transcribed text.
  • Easy to integrate and use.
  • Get Insights from any audio file, including podcasts , interviews, lectures, etc.
  • Solve actual problems.

Installation

Prerequisites

  • Python 3.x
  • pip

Use PIP Package (Recommended)

pip install audiomind
from audiomind import AudioMind

audiomind = AudioMind()
audiomind.process(file="examples/1.mp3")

Steps to Install

  1. Clone the Repository

    git clone https://github.com/onlyoneaman/audiomind.git
    cd audiomind
  2. Create a Virtual Environment

    python3 -m venv .venv

    Activate the virtual environment:

    • Unix or MacOS

      source .venv/bin/activate
    • Windows

      .\.venv\Scripts\activate
  3. Install Dependencies

    pip install -r requirements.txt
  4. Environment Variables

    Copy .env.template to .env.

    cp .env.template .env

    Open .env and provide your OpenAI API key:

    OPENAI_API_KEY=your_openai_api_key_here
    DREAMBOAT_API_KEY=your_dreamboat_api_key_here // optional
  5. Run the Application

    python3 -m audiomind

Usage

Place the audio files in the /exmaples folder and run the audio_to_journal.py script. The script will transcribe the audio and summarize it.

python3 -m audiomind --file examples/1.mp3

You can add some information about yourself in person.txt file. Audiomind will use this information too while creating the journal entry.

Roadmap

  • Transcribe audio files to text.
  • Summarize the transcribed text.
  • Easy to integrate and use.
  • Get Insights from any audio file, including podcasts , interviews, lectures, etc.
  • Create a journal entry from your voice note.
  • Improve the journal entry.
  • Create a summary of a podcast episode.
  • Create a summary of a lecture.
  • Create a summary of a meeting.

Contributing

Feel free to submit issues and enhancement requests.

License

MIT


Enjoy using AudioMind!

audiomind's People

Stargazers

Abhinav Rai avatar Aman (e/acc) avatar

Watchers

Aman (e/acc) 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.