Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -9,7 +9,6 @@ pinned: false
|
|
| 9 |
license: mit
|
| 10 |
---
|
| 11 |
|
| 12 |
-
Here's a **cleaned-up, styled, and Hugging Face-compatible version** of your `README.md` β optimized for clarity, presentation, and ease of use on **Hugging Face Spaces**.
|
| 13 |
|
| 14 |
---
|
| 15 |
|
|
@@ -24,6 +23,21 @@ This is a full-stack chatbot application supporting both **text** and **voice in
|
|
| 24 |
|
| 25 |
---
|
| 26 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 27 |
## π Features
|
| 28 |
|
| 29 |
* π¬ **Interactive Chat UI** β Clean and responsive frontend built in React
|
|
@@ -65,26 +79,6 @@ This is a full-stack chatbot application supporting both **text** and **voice in
|
|
| 65 |
|
| 66 |
---
|
| 67 |
|
| 68 |
-
## βοΈ Workflow Overview
|
| 69 |
-
|
| 70 |
-
### πΉ Frontend (React)
|
| 71 |
-
|
| 72 |
-
* User types or records voice.
|
| 73 |
-
* Sends requests to `/api/ask` (text) or `/api/transcribe-audio` (audio).
|
| 74 |
-
* Displays streamed response from LLM.
|
| 75 |
-
|
| 76 |
-
### πΉ Backend (FastAPI)
|
| 77 |
-
|
| 78 |
-
* `/api/ask`: Sends prompt to TinyLlama via Ollama API and streams back result.
|
| 79 |
-
* `/api/transcribe-audio`: Converts voice to base64, sends to Whisper model, returns transcribed text.
|
| 80 |
-
|
| 81 |
-
### πΉ Ollama Server
|
| 82 |
-
|
| 83 |
-
* Hosts and runs both models locally inside Docker.
|
| 84 |
-
* Communicates via `http://localhost:11434/api/generate`.
|
| 85 |
-
|
| 86 |
-
---
|
| 87 |
-
|
| 88 |
## π οΈ Local Development (No Docker)
|
| 89 |
|
| 90 |
### 1. Clone Repo
|
|
@@ -191,7 +185,8 @@ npm run dev
|
|
| 191 |
|
| 192 |
* `krishna_choudhary/tinyllama`
|
| 193 |
* `anagram/whispertiny`
|
|
|
|
| 194 |
|
| 195 |
-
|
| 196 |
|
| 197 |
-
|
|
|
|
| 9 |
license: mit
|
| 10 |
---
|
| 11 |
|
|
|
|
| 12 |
|
| 13 |
---
|
| 14 |
|
|
|
|
| 23 |
|
| 24 |
---
|
| 25 |
|
| 26 |
+
## π Fine-Tuning Dataset & Training Code
|
| 27 |
+
|
| 28 |
+
π **Looking to fine-tune the chatbot yourself?**
|
| 29 |
+
Check out the open-source dataset and training scripts used to fine-tune `tinyllama`:
|
| 30 |
+
|
| 31 |
+
π **GitHub Repository:** [Byte-Maste/krishna\_Chatbot\_Dataset](https://github.com/Byte-Maste/krishna_Chatbot_Dataset)
|
| 32 |
+
|
| 33 |
+
This repository includes:
|
| 34 |
+
|
| 35 |
+
* ποΈ Custom chatbot dialogue dataset
|
| 36 |
+
* π§ͺ Fine-tuning scripts and setup
|
| 37 |
+
* π Prompt formatting for LLM compatibility
|
| 38 |
+
|
| 39 |
+
---
|
| 40 |
+
|
| 41 |
## π Features
|
| 42 |
|
| 43 |
* π¬ **Interactive Chat UI** β Clean and responsive frontend built in React
|
|
|
|
| 79 |
|
| 80 |
---
|
| 81 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 82 |
## π οΈ Local Development (No Docker)
|
| 83 |
|
| 84 |
### 1. Clone Repo
|
|
|
|
| 185 |
|
| 186 |
* `krishna_choudhary/tinyllama`
|
| 187 |
* `anagram/whispertiny`
|
| 188 |
+
* Dataset & Fine-tuning:
|
| 189 |
|
| 190 |
+
* π [Byte-Maste/krishna\_Chatbot\_Dataset](https://github.com/Byte-Maste/krishna_Chatbot_Dataset)
|
| 191 |
|
| 192 |
+
---
|