Spaces:
Sleeping
Sleeping
Tanuj
commited on
Commit
·
8752221
1
Parent(s):
770027a
Update README.md
Browse files
README.md
CHANGED
|
@@ -4,7 +4,7 @@ author: MrTanTan & swkasula
|
|
| 4 |
colorFrom: yellow
|
| 5 |
colorTo: purple
|
| 6 |
sdk: gradio
|
| 7 |
-
sdk_version: 5.33.
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
short_description: A agent with memory tools. Upload and query away!
|
|
@@ -20,13 +20,21 @@ license: mit
|
|
| 20 |
|
| 21 |
Authors: [MrTanTan](https://huggingface.co/MrTanTan) && [swkasula](https://huggingface.co/MrTanTan)
|
| 22 |
|
| 23 |
-
|
| 24 |
-
- Our website: https://you-two-delta.vercel.app/
|
| 25 |
-
- This app is also deployed using modal [here](https://tangentleman--youtwo-gradio-gradio-app.modal.run/).
|
| 26 |
|
|
|
|
|
|
|
|
|
|
| 27 |
|
| 28 |
-
This app uses [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
|
| 29 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 30 |
|
| 31 |
# Add environment variables to your .env file
|
| 32 |
```bash
|
|
@@ -63,23 +71,17 @@ This repository contains the YouTwo Agent, a conversational AI agent powered by
|
|
| 63 |
pip install modal
|
| 64 |
```
|
| 65 |
|
| 66 |
-
2.
|
| 67 |
```bash
|
| 68 |
-
modal
|
|
|
|
| 69 |
```
|
| 70 |
|
| 71 |
-
3. Create the following secrets and volumes on Modal:
|
| 72 |
-
- Secret: `youtwo-secrets` with the following values:
|
| 73 |
-
- `NEBIUS_API_KEY` - Your Nebius API key for the LLM
|
| 74 |
-
- `VECTARA_API_KEY` - Your Vectara API key for RAG
|
| 75 |
-
- Volume: `youtwo-volume` - For storing any persistent data
|
| 76 |
-
|
| 77 |
## Project Structure
|
| 78 |
-
|
| 79 |
-
- `
|
| 80 |
-
- `
|
| 81 |
-
- `
|
| 82 |
-
- `schemas.py`: Data schemas for the app
|
| 83 |
|
| 84 |
## Deployment Instructions
|
| 85 |
|
|
@@ -88,7 +90,7 @@ modal token new
|
|
| 88 |
To run the app locally during development:
|
| 89 |
|
| 90 |
```bash
|
| 91 |
-
modal serve
|
| 92 |
```
|
| 93 |
|
| 94 |
This will provide you with a URL to access your app during development.
|
|
@@ -98,7 +100,7 @@ This will provide you with a URL to access your app during development.
|
|
| 98 |
To deploy the app to Modal for production:
|
| 99 |
|
| 100 |
```bash
|
| 101 |
-
modal deploy
|
| 102 |
```
|
| 103 |
|
| 104 |
After deployment, you'll receive a URL where your application is accessible.
|
|
@@ -112,10 +114,6 @@ The application requires the following environment variables:
|
|
| 112 |
|
| 113 |
These should be set up as secrets in Modal.
|
| 114 |
|
| 115 |
-
##
|
| 116 |
-
|
| 117 |
-
- **Issue:** "WebRTC peer connection failed"
|
| 118 |
-
- **Solution:** Ensure your browser has permission to access your microphone and that you're using HTTPS or localhost.
|
| 119 |
|
| 120 |
-
|
| 121 |
-
- **Solution:** Verify that you've created the `youtwo-volume` volume in Modal.
|
|
|
|
| 4 |
colorFrom: yellow
|
| 5 |
colorTo: purple
|
| 6 |
sdk: gradio
|
| 7 |
+
sdk_version: 5.33.1
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
short_description: A agent with memory tools. Upload and query away!
|
|
|
|
| 20 |
|
| 21 |
Authors: [MrTanTan](https://huggingface.co/MrTanTan) && [swkasula](https://huggingface.co/MrTanTan)
|
| 22 |
|
| 23 |
+
Video submission:https://youtu.be/HTngofSD8zE
|
|
|
|
|
|
|
| 24 |
|
| 25 |
+
Full-featured project repository: https://github.com/TanGentleman/YouTwo
|
| 26 |
+
- Our website: https://you-two-delta.vercel.app/
|
| 27 |
+
- This app is also deployed using modal: https://tangentleman--youtwo-gradio-gradio-app.modal.run/
|
| 28 |
|
|
|
|
| 29 |
|
| 30 |
+
This project is made with the help of:
|
| 31 |
+
- [Gradio](https://gradio.app)
|
| 32 |
+
- [Hugging Face](https://huggingface.co)
|
| 33 |
+
- [Modal](https://modal.com)
|
| 34 |
+
- [Vectara](https://vectara.com)
|
| 35 |
+
- [Nebius](https://nebius.com)
|
| 36 |
+
- [Convex](https://convex.dev)
|
| 37 |
+
- And open-source contributions from the community!
|
| 38 |
|
| 39 |
# Add environment variables to your .env file
|
| 40 |
```bash
|
|
|
|
| 71 |
pip install modal
|
| 72 |
```
|
| 73 |
|
| 74 |
+
2. Set the following secrets on Modal:
|
| 75 |
```bash
|
| 76 |
+
modal secret create nebius NEBIUS_API_KEY=your_nebius_api_key
|
| 77 |
+
modal secret create vectara VECTARA_API_KEY=your_vectara_api_key
|
| 78 |
```
|
| 79 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 80 |
## Project Structure
|
| 81 |
+
- `run_modal_app.py`: The main Modal deployment file
|
| 82 |
+
- `yt_agent`: Core agent logic
|
| 83 |
+
- `yt_rag`: Retrieval-augmented generation module
|
| 84 |
+
- `yt_gradio_app`: Gradio blocks for the project
|
|
|
|
| 85 |
|
| 86 |
## Deployment Instructions
|
| 87 |
|
|
|
|
| 90 |
To run the app locally during development:
|
| 91 |
|
| 92 |
```bash
|
| 93 |
+
modal serve run_modal_app.py
|
| 94 |
```
|
| 95 |
|
| 96 |
This will provide you with a URL to access your app during development.
|
|
|
|
| 100 |
To deploy the app to Modal for production:
|
| 101 |
|
| 102 |
```bash
|
| 103 |
+
modal deploy run_modal_app.py
|
| 104 |
```
|
| 105 |
|
| 106 |
After deployment, you'll receive a URL where your application is accessible.
|
|
|
|
| 114 |
|
| 115 |
These should be set up as secrets in Modal.
|
| 116 |
|
| 117 |
+
## License
|
|
|
|
|
|
|
|
|
|
| 118 |
|
| 119 |
+
This project is licensed under the MIT License. Have fun!
|
|
|