Krish-05 commited on
Commit
4a001ac
Β·
verified Β·
1 Parent(s): 83bc15a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +18 -23
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
- Let me know if you'd like me to **add Hugging Face-specific buttons**, badges (e.g. "Open in Spaces"), or deployment examples!
 
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
+ ---