https://github.com/azzedde/paper_to_podcast
A very quick project that transforms research papers into engaging three-person discussions, offering an intuitive and thought-provoking listening experience. Perfect for podcast enthusiasts seeking a fresh way to explore academic content.
https://github.com/azzedde/paper_to_podcast
langchain llms openai python
Last synced: 9 months ago
JSON representation
A very quick project that transforms research papers into engaging three-person discussions, offering an intuitive and thought-provoking listening experience. Perfect for podcast enthusiasts seeking a fresh way to explore academic content.
- Host: GitHub
- URL: https://github.com/azzedde/paper_to_podcast
- Owner: Azzedde
- License: apache-2.0
- Created: 2024-10-27T00:20:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-09T14:42:16.000Z (about 1 year ago)
- Last Synced: 2025-04-08T06:35:45.986Z (10 months ago)
- Topics: langchain, llms, openai, python
- Language: Python
- Homepage:
- Size: 17.2 MB
- Stars: 557
- Watchers: 7
- Forks: 66
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Paper-to-Podcast 🎤
**Paper-to-Podcast** is a tool that transforms academic research papers into an engaging and conversational podcast format. With this project, listeners can absorb the content of a research paper in a lively discussion involving three distinct personas—perfect for those who prefer listening over reading, especially during commutes or travel.
## Project Overview
### Objective
This app simulates a three-person discussion around the content of a research paper, making complex information more accessible and enjoyable to absorb. Instead of merely reading aloud, it converts papers into conversations that are engaging and intuitive, providing valuable insights and critical thinking.
### Personas
- **Host**: Guides the conversation, introducing each section and explaining the main points in an engaging and warm tone.
- **Learner**: Asks intuitive questions and brings curiosity to the discussion, helping listeners grasp core concepts.
- **Expert**: Provides in-depth knowledge and additional details, enhancing the discussion with profound insights.
This structure fosters an interactive listening experience, helping users better understand the paper in a way that feels natural and human.
### Code Structure and Key Components
- **Planning Chain**: Starts by creating a detailed plan for each section of the paper. Planning helps the model stay on track, reducing the chances of hallucinations or redundancy.
- **Discussion Chain**: Uses a retrieval-augmented generation model to expand on each section. This ensures the script stays true to the source content while generating meaningful dialogue.
- **Enhancement Chain**: Finalizes the script by removing redundancies, refining transitions, and ensuring a smooth flow.
- **Text-to-Speech**: The generated script is then converted into audio using the OpenAI API, producing realistic voices for each persona.
### Cost Efficiency
The app is cost-effective, utilizing OpenAI's API. For example, generating a 9-minute podcast from a 19-page research paper costs approximately $0.16.
## Usage Instructions
### Prerequisites
1. Clone this repository:
```bash
git clone https://github.com/Azzedde/paper_to_podcast.git
```
2. Move into the project directory:
```bash
cd paper_to_podcast
```
3. Ensure you have a valid OpenAI API key stored in your `.env` file.
### Running the App
1. Place a research paper in PDF format in the project directory.
2. Run the script from the terminal, providing the path to your PDF file as an argument:
```bash
python paper_to_podcast.py path/to/your/research_paper.pdf
```
### Sample Podcasts
You can find examples of podcasts generated using this pipeline in the `./sample_podcasts` directory.
## Roadmap
- [ ] **Optimization**: Currently, the process takes times. Further optimization is planned to reduce runtime.
- [ ] **Local LLMs and TTS**: Exploring alternatives to OpenAI’s API for a completely free, local implementation using **Ollama** and open-source TTS models.
## Contributing
If you’d like to contribute, there is an open issue for optimizing the podcast generation time. Feel free to explore or create new issues to enhance the app!