minutes-maker
minutes-maker copied to clipboard
A web app that automatically generates transcripts and summaries of meetings or lectures.
Minutes Maker
Minutes Maker is a web app that automatically generates transcripts and summaries of meetings or lectures.
Note 日本語のREADMEはこちらです。
Overview
Key features:
- Transcribe almost any audio/video file with faster-whisper
- Summarize transcripts using OpenAI LLMs
- Easy-to-use web interface
- Support for English and Japanese
- Compatible with both CPU and GPU
Installation
1. Place the environment variables in the .env file
You need to place the following environment variables.
-
OPENAI_API_KEYis the API key for summarization, which can be found here. -
REACT_APP_PUBLIC_IPis the public IP address of the machine that runs the app.- If you deploy the app on your local machine, should be
'0.0.0.0'. - If you deploy the app on a remote server, should be the public IP address of the server.
- If you deploy the app on your local machine, should be
You can place the environment variables in the .env file by running the following commands:
cd minutes-maker
echo "OPENAI_API_KEY='sk-XXX'" >> .env
echo "REACT_APP_PUBLIC_IP='XXX.XXX.XXX.XXX'" >> .env
2. Build the Docker image
Whether the machine has a NVIDIA GPU or not is automatically detected and the appropriate Docker image is built.
make build
3. Run the app
make up
4. Access the app
Open http://<PUBLIC_IP or 0.0.0.0>:10356 in your browser.
Usage
Just fill the form and click the Submit button!
Here is a brief explanation of the form:
-
Upload audio/video file
Select an audio/video file to be transcribed and summarized. Almost any audio/video file can be used, and the file size is not limited.
-
Select target language
Select the target language to be summarized. Note that the language of the audio/video file is automatically detected and cannot be changed, so you should select what language you want to summarize.
Currently, English and Japanese are supported.
-
Select category
Select the category of the audio/video file, meeting or lecture. Appropriate setting of this parameter will improve the quality of the summary.
-
Enter meeting/lecture topic
Enter the topic of the meeting/lecture, such as the theme of it (e.g. "development of the new product"). Set appropriate topic to improve the quality of the transcript.
Requirements
- Computer
- Docker
License
This repository is licensed under CC BY-NC-SA 4.0. See LICENSE for more information.