Spaces:
Configuration error
Configuration error
gabriel chua
commited on
Commit
•
9149e8d
1
Parent(s):
9c20b4e
update README
Browse files
README.md
CHANGED
@@ -1,8 +1,8 @@
|
|
1 |
-
# PDF to Podcast
|
2 |
|
3 |
## Overview
|
4 |
|
5 |
-
This project provides a tool to convert any PDF document into a podcast episode!
|
6 |
|
7 |
## Features
|
8 |
|
@@ -16,7 +16,7 @@ To set up the project, follow these steps:
|
|
16 |
|
17 |
1. **Clone the repository:**
|
18 |
```bash
|
19 |
-
git clone https://github.com/
|
20 |
cd pdf-to-podcast
|
21 |
```
|
22 |
|
@@ -34,11 +34,7 @@ To set up the project, follow these steps:
|
|
34 |
## Usage
|
35 |
|
36 |
1. **Set up API Key(s):**
|
37 |
-
|
38 |
-
Use it as the value to `GEMINI_API_KEY`.
|
39 |
-
You'll also need an api key for OpenAI which you can either pass through the interface or set as the `OPENAI_API_KEY` environment variable.
|
40 |
-
|
41 |
-
Gemini flash is used as the LLM and OpenAI is used for text-to-speech.
|
42 |
|
43 |
2. **Run the application:**
|
44 |
```bash
|
@@ -49,12 +45,13 @@ To set up the project, follow these steps:
|
|
49 |
3. **Upload a PDF:**
|
50 |
Upload the PDF document you want to convert into a podcast.
|
51 |
|
52 |
-
4. **
|
53 |
-
Provide your OpenAI API key in the designated textbox.
|
54 |
-
|
55 |
-
5. **Generate Audio:**
|
56 |
Click the button to start the conversion process. The output will be an MP3 file containing the podcast dialogue.
|
57 |
|
|
|
|
|
|
|
|
|
58 |
## License
|
59 |
|
60 |
This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for more information.
|
|
|
1 |
+
# Open PDF to Podcast
|
2 |
|
3 |
## Overview
|
4 |
|
5 |
+
This project provides a tool to convert any PDF document into a podcast episode! Leveraging open-source LLMs and text-to-speech models, this tool processes the content of a PDF, generates a natural dialogue suitable for an audio podcast, and outputs it as an MP3 file.
|
6 |
|
7 |
## Features
|
8 |
|
|
|
16 |
|
17 |
1. **Clone the repository:**
|
18 |
```bash
|
19 |
+
git clone https://github.com/gabrielchua/open-pdf2podcast.git
|
20 |
cd pdf-to-podcast
|
21 |
```
|
22 |
|
|
|
34 |
## Usage
|
35 |
|
36 |
1. **Set up API Key(s):**
|
37 |
+
For this project, I am using LLama 3.1 405B hosted on Fireworks API as its JSON Mode supports passing a pydantic object. So, please set the API key as the `FIREWORKS_API_KEY` environment variable
|
|
|
|
|
|
|
|
|
38 |
|
39 |
2. **Run the application:**
|
40 |
```bash
|
|
|
45 |
3. **Upload a PDF:**
|
46 |
Upload the PDF document you want to convert into a podcast.
|
47 |
|
48 |
+
4. **Generate Audio:**
|
|
|
|
|
|
|
49 |
Click the button to start the conversion process. The output will be an MP3 file containing the podcast dialogue.
|
50 |
|
51 |
+
## Acknowledgements
|
52 |
+
|
53 |
+
This project is forked from [`knowsuchagency/pdf-to-podcast`](https://github.com/knowsuchagency/pdf-to-podcast)
|
54 |
+
|
55 |
## License
|
56 |
|
57 |
This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for more information.
|