Update README.md
Browse files
README.md
CHANGED
|
@@ -1,80 +1,11 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
---
|
| 14 |
-
|
| 15 |
-
### It uses the following AI services:
|
| 16 |
-
|
| 17 |
-
**Deepgram - Speech-to-Text**
|
| 18 |
-
|
| 19 |
-
Transcribes inbound participant voice media to text.
|
| 20 |
-
|
| 21 |
-
**OpenAI (GPT4) - LLM**
|
| 22 |
-
|
| 23 |
-
Our creative writer LLM. You can see the context used to prompt it [here](src/prompts.py)
|
| 24 |
-
|
| 25 |
-
**ElevenLabs - Text-to-Speech**
|
| 26 |
-
|
| 27 |
-
Converts and streams the LLM response from text to audio
|
| 28 |
-
|
| 29 |
-
**Fal.ai - Image Generation**
|
| 30 |
-
|
| 31 |
-
Adds pictures to our story (really fast!) Prompting is quite key for style consistency, so we task the LLM to turn each story page into a short image prompt.
|
| 32 |
-
|
| 33 |
-
---
|
| 34 |
-
|
| 35 |
-
## Setup
|
| 36 |
-
|
| 37 |
-
**Install requirements**
|
| 38 |
-
|
| 39 |
-
```shell
|
| 40 |
-
python3 -m venv venv
|
| 41 |
-
source venv/bin/activate
|
| 42 |
-
pip install -r requirements.txt
|
| 43 |
-
```
|
| 44 |
-
|
| 45 |
-
**Create environment file and set variables:**
|
| 46 |
-
|
| 47 |
-
```shell
|
| 48 |
-
mv env.example .env
|
| 49 |
-
```
|
| 50 |
-
|
| 51 |
-
**Build the frontend:**
|
| 52 |
-
|
| 53 |
-
This project uses a custom frontend, which needs to built. Note: this is done automatically as part of the Docker deployment.
|
| 54 |
-
|
| 55 |
-
```shell
|
| 56 |
-
cd frontend/
|
| 57 |
-
npm install
|
| 58 |
-
npm run build
|
| 59 |
-
```
|
| 60 |
-
|
| 61 |
-
The build UI files can be found in `frontend/out`
|
| 62 |
-
|
| 63 |
-
## Running it locally
|
| 64 |
-
|
| 65 |
-
Start the API / bot manager:
|
| 66 |
-
|
| 67 |
-
`python src/server.py`
|
| 68 |
-
|
| 69 |
-
If you'd like to run a custom domain or port:
|
| 70 |
-
|
| 71 |
-
`python src/server.py --host somehost --p 7777`
|
| 72 |
-
|
| 73 |
-
➡️ Open the host URL in your browser `http://localhost:7860`
|
| 74 |
-
|
| 75 |
-
---
|
| 76 |
-
|
| 77 |
-
## Improvements to make
|
| 78 |
-
|
| 79 |
-
- Wait for track_started event to avoid rushed intro
|
| 80 |
-
- Show 5 minute timer on the UI
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Storytime
|
| 3 |
+
emoji: 📊
|
| 4 |
+
colorFrom: yellow
|
| 5 |
+
colorTo: green
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_port: 7860
|
| 8 |
+
pinned: false
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|