Skip to content

Commit 87d4ed2

Browse files
authored
Update README.md
1 parent c0e15e0 commit 87d4ed2

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
<p align="center">
44
<a href="https://github.com/badges/shields/pulse" alt="Activity">
55
<img src="https://img.shields.io/github/commit-activity/m/leopiney/neuralnoise" /></a>
6-
<a href="https://pypi.python.org/pypi/neuralnoise" alt="Activity">
6+
<a href="https://pypi.python.org/pypi/neuralnoise" alt="PyPI - Latest version">
77
<img src="https://img.shields.io/pypi/v/neuralnoise.svg" /></a>
8+
<a href="https://pypistats.org/packages/neuralnoise" alt="Latest version">
9+
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/neuralnoise"></a>
810
</p>
911

1012
<div align="center">
@@ -13,6 +15,10 @@
1315

1416
NeuralNoise is an AI-powered podcast studio that uses multiple AI agents working together. These agents collaborate to analyze content, write scripts, and generate audio, creating high-quality podcast content with minimal human input. The team generates a script that the cast team (using a TTS tool of your choice) will then record.
1517

18+
<p align="center">
19+
<img src="https://api.star-history.com/svg?repos=leopiney/neuralnoise&type=Date" alt="leopiney/neuralnoise GithubStars history" />
20+
</p>
21+
1622
## Examples
1723

1824
| Source | Type | NeuralNoise | Download |
@@ -72,7 +78,7 @@ To run the NeuralNoise application first make sure that you create a configurati
7278
Then you can run the application with:
7379
7480
```
75-
nn new <url|filepath> --name <name> --config-path <config>
81+
nn generate --name <name> <url|file> [<url|file>...]
7682
```
7783
7884
## Want to edit the generated script?
@@ -81,17 +87,18 @@ The generated script and audio segments are saved in the `output/<name>` folder.
8187
8288
1. Locate the JSON file in this folder containing all script segments and their text content.
8389
2. Make your desired changes to specific segments in the JSON file. Locate the "sections" and "segments" content in this file that you want to change, then feel free to edit the content of the segments you want to change.
84-
3. Run the same command as before (same name) to regenerate the podcast.
90+
3. Run the same command as before with the same name (`nn generate --name <name>`) to regenerate the podcast.
8591
8692
The application will regenerate the podcast, preserving unmodified segments and only processing the changed ones. This approach allows for efficient editing without regenerating the entire podcast from scratch.
8793
8894
## Roadmap
8995
90-
- [ ] Better PDF and articles content extraction.
96+
- [x] Better PDF and articles content extraction.
97+
- [ ] Add interactive ways of using NeuralNoise (Gradio/Colab/etc)
9198
- [ ] Add local LLM provider. More generic LLM configuration. Leverage AutoGen for this.
9299
- [ ] Add local TTS provider
93100
- [ ] Add podcast generation format options: interview, narrative, etc.
94-
- [ ] Add podcast generation from multiple source files
101+
- [x] Add podcast generation from multiple source files
95102
- [ ] Add more agent roles to the studio. For example, a "Content Curator" or "Content Researcher" that uses tools to find and curate content before being analyzed. Or a "Sponsor" agent that adds segways to ads in the podcast script ([à la LTT](https://www.youtube.com/live/EefvOLKoXdg?si=G1714t2jK4ZIvao0&t=5307)).
96103
- [ ] Add music and sound effects options
97104
- [ ] Real-time podcast generation with human and AI collaboration (🤔)

0 commit comments

Comments
 (0)