Krishkanth commited on
Commit
d1c1073
Β·
verified Β·
1 Parent(s): 920297a

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +251 -56
README.md CHANGED
@@ -7,6 +7,8 @@ tags:
7
  - ai-assistant
8
  - llama.cpp
9
  - ollama
 
 
10
  language:
11
  - en
12
  pipeline_tag: text-generation
@@ -16,118 +18,311 @@ pipeline_tag: text-generation
16
 
17
  <div align="center">
18
 
19
- **✨ Krish Mind is an elite independent AI assistant developed by Krish CS. ✨**
20
- *🧠 Designed to be intelligent, helpful, and blazing fast!*
21
 
22
  [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
23
  [![Format: GGUF](https://img.shields.io/badge/Format-GGUF-orange)](https://github.com/ggerganov/llama.cpp)
24
- [![Privacy Focused](https://img.shields.io/badge/Privacy-100%25-blue)]()
 
25
 
26
  </div>
27
 
28
  ---
29
 
30
- ## 🌟 What is Krish Mind? 🌈
31
 
32
- **Krish Mind** is a state-of-the-art independent AI assistant developed by **Krish CS**. It is designed to be conversational, genuinely helpful, and easy to use for everyone. Unlike generic AI models, Krish Mind has its own unique identity, personality, and knowledge base. 🦾
33
 
34
- **This Repository contains the MOBILE version** β€” the ultra-compact edition designed specifically to run **completely offline** on smartphones and low-end computers. It packs incredible intelligence into a tiny file under **2 GB**! πŸ“¦
35
 
36
- ### πŸ’Ž Why Choose Krish Mind?
37
- - πŸ“΅ **Zero Internet Required** β€” Works in airplane mode once downloaded!
38
- - πŸ’° **100% Free** β€” No subscriptions, no hidden costs!
39
- - πŸ”’ **Total Privacy** β€” Your chats never leave your device. Period.
40
- - ⚑ **Instant Responses** β€” Optimized for your specific hardware!
 
41
 
42
  ---
43
 
44
- ## πŸ—‚οΈ The Complete Krish Mind Family πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦
45
 
46
- Pick the version that matches your hardware for the best experience! 🏎️
47
 
48
- | 🏷️ Version | πŸ“¦ Size | 🏠 Repository | πŸ’Ύ RAM Needed | ⬇️ Quick Action |
49
  |---|---|---|---|---|
50
- | πŸ“± **Mobile** | ~2 GB | krish-mind-mobile | 3-4 GB | [πŸ“₯ Download Now](https://huggingface.co/Krishkanth/krish-mind-mobile/resolve/main/krish-mind-mobile.gguf) |
51
- | ⚑ **Q4 Balanced** | ~5 GB | krish-mind-gguf-Q4 | 8-16 GB | [πŸ”— Visit Repository](https://huggingface.co/Krishkanth/krish-mind-gguf-Q4) |
52
- | πŸš€ **Full Quality** | ~16 GB | krish-mind-gguf-standalone-16 | 32+ GB | [πŸ”— Visit Repository](https://huggingface.co/Krishkanth/krish-mind-gguf-standalone-16) |
53
 
54
- > πŸ’‘ **Tip:** Clicking "Download Now" on your current repository will start the file download immediately! Clicking "Visit Repository" will navigate you to that specific model's page.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
55
 
56
  ---
57
 
58
- ## πŸ“‚ Files in This Repository πŸ“₯
 
 
 
 
 
 
59
 
60
- | πŸ“„ File Name | πŸ”— Direct Link |
61
- |---|---|
62
- | `krish-mind-mobile.gguf` | [Download](https://huggingface.co/Krishkanth/krish-mind-mobile/resolve/main/krish-mind-mobile.gguf) |
 
 
63
 
64
  ---
65
 
66
- ## πŸ€” Which Version Should I Use? 🧐
 
 
 
 
 
 
 
 
67
 
68
- - 🀳 **Have a Smartphone?** βž” Use **krish-mind-mobile.gguf** (~2 GB)
69
- - πŸ’» **Old Laptop?** βž” Use **krish-mind-mobile.gguf** (~2 GB)
70
- - πŸ–₯️ **Normal PC (8-16 GB RAM)?** βž” Use **krish-mind-gguf-Q4** (~5 GB)
71
- - πŸš€ **Gaming PC / Workstation?** βž” Use **krish-mind-gguf-standalone-16** (~16 GB)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
72
 
73
  ---
74
 
75
- ## πŸš€ How To Run on Your Laptop (Windows/Mac/Linux) πŸ’»
 
 
76
 
77
- ### 🟒 Option 1 β€” Ollama (Super Easy!) ⚑
78
 
79
- **1. Install Ollama:** Download from [ollama.ai/download](https://ollama.ai/download)
80
- **2. Download Model:** Get `krish-mind-mobile.gguf` from this page.
81
- **3. Create Modelfile:** Create a file named `Modelfile` in the same folder as your model and paste:
82
- ```dockerfile
83
- FROM "./krish-mind-mobile.gguf"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
84
  ```
85
- **4. Build & Chat:** Open your terminal in that folder and run:
86
  ```bash
87
  ollama create krish-mind -f Modelfile
 
 
 
 
 
88
  ollama run krish-mind
89
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
90
 
91
  ---
92
 
93
- ### 🎨 Option 2 β€” LM Studio (Visual App) πŸ–ΌοΈ
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
94
 
95
- 1. Download **LM Studio** from [lmstudio.ai](https://lmstudio.ai)
96
- 2. Open the app and click the **Folder Icon** πŸ“‚ on the left.
97
- 3. Drag and drop your `krish-mind-mobile.gguf` file into the app.
98
- 4. Go to **AI Chat**, select your model at the top, and start talking! πŸ—£οΈ
 
 
99
 
100
  ---
101
 
102
- ## 🀳 How To Run on Your Smartphone (Android & iOS) πŸ“±
103
 
104
- Running Krish Mind Mobile on your phone is easy! *(Works best with the Mobile 2GB version)* 🌟
 
 
 
 
105
 
106
- ### πŸ€– For Android Users:
107
- - **PocketPal AI (Recommended):** Install from Play Store. Search for `Krishkanth/krish-mind-mobile` inside the app and hit download! πŸ“₯
108
- - **SmolChat:** Lightweight and lightning fast. Import the GGUF file directly from your storage. ⚑
109
- - **LLM Hub:** Great for all-in-one assistant features and offline tools. πŸ› οΈ
 
 
110
 
111
- ### 🍎 For iPhone / iPad Users:
112
- - **PocketPal AI:** The most smooth and premium experience! Download from the App Store and search for our model. 🌟
113
- - **LLMFarm:** Very stable and supports advanced custom settings. Import via Files app. 🚜
114
- - **ChatterUI:** A modern, clean, and snappy interface for your local models. πŸ’¬
115
 
116
  ---
117
 
118
- ## ❓ Frequently Asked Questions (FAQ) πŸ™‹β€β™‚οΈ
 
 
 
119
 
120
- **Q: What is GGUF?**
121
- A: It's a magic file format that makes AI run fast on normal CPUs! No expensive graphics cards required. πŸ› οΈ
122
 
123
- **Q: Is it really 100% private?**
124
- A: YES! It runs entirely on your device hardware. No data is ever uploaded or tracked. πŸ”’
125
 
126
  ---
127
 
128
  <div align="center">
129
 
130
- **✨ Happy Chatting with Krish Mind! ✨**
131
  *Made with ❀️ by Krish CS*
132
 
133
  </div>
 
7
  - ai-assistant
8
  - llama.cpp
9
  - ollama
10
+ - mobile-ready
11
+ - on-device
12
  language:
13
  - en
14
  pipeline_tag: text-generation
 
18
 
19
  <div align="center">
20
 
21
+ **✨ Krish Mind is an elite independent AI assistant developed by Krish CS. ✨**
22
+ *🧠 Designed to be intelligent, helpful, and blazing fast β€” even on your phone!*
23
 
24
  [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
25
  [![Format: GGUF](https://img.shields.io/badge/Format-GGUF-orange)](https://github.com/ggerganov/llama.cpp)
26
+ [![Mobile Ready](https://img.shields.io/badge/Mobile-Ready%20βœ…-brightgreen)]()
27
+ [![Privacy Focused](https://img.shields.io/badge/Privacy-100%25%20Offline-blue)]()
28
 
29
  </div>
30
 
31
  ---
32
 
33
+ ## 🌟 What is Krish Mind Mobile?
34
 
35
+ **Krish Mind** is a state-of-the-art independent AI assistant developed by **Krish CS**. Krish Mind has its own unique identity, personality, and knowledge base. It is designed to be genuinely helpful, conversational, and easy to use for everyone.
36
 
37
+ **Krish Mind Mobile** is the ultra-compact edition engineered specifically to run **completely offline on smartphones**. It fits in under **2 GB**, making it the perfect AI companion in your pocket! 🦾
38
 
39
+ ### πŸ’Ž Why Krish Mind Mobile?
40
+ - πŸ“± **Under 2 GB** β€” fits on almost any modern smartphone without a worry
41
+ - πŸ“΅ **Fully Offline** β€” works even in airplane mode, no internet needed
42
+ - πŸ’° **Completely Free** β€” no subscriptions, no hidden costs, ever
43
+ - πŸ”’ **100% Private** β€” your conversations never leave your device
44
+ - ⚑ **Blazing Fast** β€” optimized to respond instantly even on older phones
45
 
46
  ---
47
 
48
+ ## πŸ—‚οΈ The Complete Krish Mind Family
49
 
50
+ Choose the version that matches your hardware!
51
 
52
+ | 🏷️ Version | πŸ“¦ Size | πŸ’Ύ RAM | πŸ“± Mobile Support | ⬇️ Action |
53
  |---|---|---|---|---|
54
+ | πŸ“± **Mobile (This Repo)** | ~2 GB | 3-4 GB | βœ… Full Support | [πŸ“₯ Download Mobile](https://huggingface.co/Krishkanth/krish-mind-mobile/resolve/main/krish-mind-mobile.gguf) |
55
+ | ⚑ **Q4 Balanced** | ~5 GB | 8-16 GB | ❌ Desktop Only | [πŸ”— Visit Repository](https://huggingface.co/Krishkanth/krish-mind-gguf-Q4) |
56
+ | πŸš€ **Full Quality** | ~16 GB | 32+ GB | ❌ Desktop Only | [πŸ”— Visit Repository](https://huggingface.co/Krishkanth/krish-mind-gguf-standalone-16) |
57
 
58
+ ---
59
+
60
+ ## πŸ“‚ Files in This Repository
61
+
62
+ | πŸ“„ File | πŸ“¦ Size | πŸ”— Download |
63
+ |---|---|---|
64
+ | `krish-mind-mobile.gguf` | ~1.96 GB | [πŸ“₯ Download Now](https://huggingface.co/Krishkanth/krish-mind-mobile/resolve/main/krish-mind-mobile.gguf) |
65
+ | `krish-mind-full.gguf` | ~7.60 GB | [πŸ“₯ Download](https://huggingface.co/Krishkanth/krish-mind-mobile/resolve/main/krish-mind-full.gguf) |
66
+
67
+ ---
68
+
69
+ ## 🀳 Running Krish Mind on Your Smartphone (Android & iOS)
70
+
71
+ This is where Krish Mind Mobile truly shines! Below are all the apps that support running GGUF models offline on your phone.
72
+
73
+ ---
74
+
75
+ ### πŸ€– Android β€” Step by Step
76
+
77
+ #### βœ… Option A: PocketPal AI (Most Recommended!)
78
+
79
+ PocketPal AI is the best Android app for running GGUF models. It has a built-in Hugging Face browser so you can find and download Krish Mind directly inside the app!
80
+
81
+ **Step 1:** Open the Google Play Store and search for **PocketPal AI**. Install it.
82
+
83
+ **Step 2:** Open the app. Tap the **Models** tab at the bottom.
84
+
85
+ **Step 3:** Tap **Add Model** and then tap **Search Hugging Face**.
86
+
87
+ **Step 4:** Type `Krishkanth/krish-mind-mobile` in the search bar and press search.
88
+
89
+ **Step 5:** Tap **Download** next to `krish-mind-mobile.gguf` (~2 GB). Wait for the download to complete.
90
+
91
+ **Step 6:** Tap the **Chat** tab. Select `krish-mind-mobile` from the model list and start chatting!
92
+
93
+ > πŸ’‘ You can now disable your Wi-Fi and the model will keep working perfectly offline!
94
+
95
+ ---
96
+
97
+ #### βœ… Option B: SmolChat
98
+
99
+ SmolChat is a lightweight open-source Android app for running small AI models in GGUF format.
100
+
101
+ **Step 1:** Download `krish-mind-mobile.gguf` from the link above to your phone's storage.
102
+
103
+ **Step 2:** Install SmolChat from the Google Play Store or from GitHub.
104
+
105
+ **Step 3:** Open the app and tap the **+** (plus) button to add a model.
106
+
107
+ **Step 4:** Tap **Import from Storage** and navigate to your downloaded GGUF file.
108
+
109
+ **Step 5:** Set the **Prompt Template** to `ChatML` or `Default`. Tap **Load Model**.
110
+
111
+ **Step 6:** Start chatting! The model works completely offline.
112
 
113
  ---
114
 
115
+ #### βœ… Option C: LLM Hub
116
+
117
+ LLM Hub is an all-in-one Android AI assistant supporting text generation, image generation, and translation entirely offline.
118
+
119
+ **Step 1:** Download `krish-mind-mobile.gguf` to your phone.
120
+
121
+ **Step 2:** Install LLM Hub from the Google Play Store.
122
 
123
+ **Step 3:** Open the app and go to **Models** section.
124
+
125
+ **Step 4:** Tap **Import Local Model** and select your downloaded GGUF file.
126
+
127
+ **Step 5:** Tap **Load** and the model will be ready. Open the chat and start talking!
128
 
129
  ---
130
 
131
+ #### βœ… Option D: Off Grid (Open Source Power App)
132
+
133
+ Off Grid is a powerful open-source Android app for fully offline AI.
134
+
135
+ **Step 1:** Install Off Grid from the Play Store or download the APK from GitHub.
136
+
137
+ **Step 2:** Download `krish-mind-mobile.gguf` to your device.
138
+
139
+ **Step 3:** Open Off Grid and navigate to the **Language Model** section.
140
 
141
+ **Step 4:** Tap **Import GGUF** and select your file from storage.
142
+
143
+ **Step 5:** Once loaded, open the chat interface and begin your conversation!
144
+
145
+ ---
146
+
147
+ ### 🍎 iPhone & iPad β€” Step by Step
148
+
149
+ #### βœ… Option A: PocketPal AI (Most Recommended for iOS!)
150
+
151
+ PocketPal AI is available on the Apple App Store and is the most seamless iOS experience.
152
+
153
+ **Step 1:** Open the App Store and search for **PocketPal AI**. Install it.
154
+
155
+ **Step 2:** Open the app and go to the **Models** tab.
156
+
157
+ **Step 3:** Tap **Add Model** and search for `Krishkanth/krish-mind-mobile`.
158
+
159
+ **Step 4:** Download `krish-mind-mobile.gguf` directly inside the app. Wait for the download to complete.
160
+
161
+ **Step 5:** Go to **Chat**, select the model from the dropdown, and start chatting!
162
 
163
  ---
164
 
165
+ #### βœ… Option B: LLMFarm
166
+
167
+ LLMFarm is one of the most well-established iOS apps for running GGUF models.
168
 
169
+ **Step 1:** Install **LLMFarm** from the Apple App Store.
170
 
171
+ **Step 2:** On your iPhone, open **Safari** and download `krish-mind-mobile.gguf` from the download link above. When prompted, choose **Download** (not Open).
172
+
173
+ **Step 3:** Go to the **Files** app on your iPhone. Find `krish-mind-mobile.gguf` in your Downloads folder.
174
+
175
+ **Step 4:** Tap and hold the file, then tap **Share** and choose **LLMFarm** from the share sheet to import it.
176
+
177
+ **Step 5:** Open LLMFarm and tap the **+** button. Select your imported model file.
178
+
179
+ **Step 6:** Set the model type to **Auto** or **ChatML**. Tap **Load** and begin chatting!
180
+
181
+ ---
182
+
183
+ #### βœ… Option C: ChatterUI
184
+
185
+ ChatterUI is a modern and clean iOS app for running local AI models.
186
+
187
+ **Step 1:** Install **ChatterUI** from the App Store.
188
+
189
+ **Step 2:** Download `krish-mind-mobile.gguf` via Safari and save it to your Files app.
190
+
191
+ **Step 3:** Open ChatterUI and tap **Model Settings** in the top right corner.
192
+
193
+ **Step 4:** Tap **Import Model** and select the GGUF file from your Files app.
194
+
195
+ **Step 5:** Tap **Load Model** and open the chat to start talking!
196
+
197
+ ---
198
+
199
+ ## πŸ’» Running Krish Mind on Your Laptop
200
+
201
+ ### 🟒 Option 1 β€” Ollama (Recommended for Beginners!)
202
+
203
+ Ollama is a free, open-source tool for running AI models locally. Works on Windows, Mac, and Linux!
204
+
205
+ **Step 1: Install Ollama**
206
+ Download and install Ollama from: https://ollama.ai/download
207
+ Run the installer. No configuration needed.
208
+
209
+ **Step 2: Download the Model**
210
+ Download `krish-mind-mobile.gguf` from the link above. Save it to a convenient folder, for example:
211
+ - Windows: `C:\Users\YourName\krish-mind\`
212
+ - Mac/Linux: `~/krish-mind/`
213
+
214
+ **Step 3: Create a Modelfile**
215
+ Inside the same folder as your GGUF file, create a new plain text file named exactly `Modelfile` (no extension). Open it and paste this single line:
216
+ ```
217
+ FROM ./krish-mind-mobile.gguf
218
+ ```
219
+ Save and close the file.
220
+
221
+ **Step 4: Import into Ollama**
222
+ Open your terminal (or Command Prompt on Windows). Navigate to the folder where your Modelfile is:
223
+ ```bash
224
+ cd C:\Users\YourName\krish-mind
225
  ```
226
+ Then run this command to register the model with Ollama:
227
  ```bash
228
  ollama create krish-mind -f Modelfile
229
+ ```
230
+ Wait for it to complete. This step only needs to be done once.
231
+
232
+ **Step 5: Start Chatting!**
233
+ ```bash
234
  ollama run krish-mind
235
  ```
236
+ Krish Mind is now loaded and ready. Type your message and press Enter!
237
+
238
+ **Useful Ollama Commands:**
239
+ ```bash
240
+ ollama list # Show all installed models
241
+ ollama run krish-mind # Start a chat session
242
+ ollama rm krish-mind # Remove the model
243
+ ```
244
+
245
+ ---
246
+
247
+ ### 🎨 Option 2 β€” LM Studio (Visual Desktop App, Zero Commands!)
248
+
249
+ LM Studio gives you a beautiful chat interface just like ChatGPT, running entirely locally.
250
+
251
+ **Step 1:** Download LM Studio from https://lmstudio.ai and install it.
252
+
253
+ **Step 2:** Download `krish-mind-mobile.gguf` to your computer.
254
+
255
+ **Step 3:** Open LM Studio. Click the folder icon on the left sidebar that says **My Models**.
256
+
257
+ **Step 4:** Click **Add Model** and drag your downloaded GGUF file into the window, or click **Browse** to find it.
258
+
259
+ **Step 5:** Go to the **AI Chat** tab (speech bubble icon on the left). At the top centre of the screen, click the model selector dropdown and choose `krish-mind-mobile`.
260
+
261
+ **Step 6:** Start typing your message and press Enter. Krish Mind will respond!
262
 
263
  ---
264
 
265
+ ### πŸ› οΈ Option 3 β€” Python (For Developers)
266
+
267
+ Install llama-cpp-python:
268
+ ```bash
269
+ pip install llama-cpp-python
270
+ ```
271
+
272
+ Run Krish Mind in your Python code:
273
+ ```python
274
+ from llama_cpp import Llama
275
+
276
+ llm = Llama(
277
+ model_path="./krish-mind-mobile.gguf",
278
+ n_ctx=4096,
279
+ n_threads=4,
280
+ )
281
 
282
+ response = llm.create_chat_completion(
283
+ messages=[{"role": "user", "content": "Hello! Who are you?"}]
284
+ )
285
+
286
+ print(response["choices"][0]["message"]["content"])
287
+ ```
288
 
289
  ---
290
 
291
+ ## πŸ› οΈ System Requirements
292
 
293
+ ### Smartphone Requirements
294
+ | πŸ“± Platform | πŸ₯‰ Minimum | πŸ₯‡ Recommended |
295
+ |---|---|---|
296
+ | **Android** | 4 GB RAM, Android 10 | 8 GB RAM, Snapdragon 8 Gen 1+ |
297
+ | **iPhone** | iPhone 12+ | iPhone 14 Pro or newer |
298
 
299
+ ### Laptop/Desktop Requirements
300
+ | πŸ’» Platform | πŸ₯‰ Minimum | πŸ₯‡ Recommended |
301
+ |---|---|---|
302
+ | **Windows** | 4 GB Free RAM, Any modern CPU | 8 GB RAM, Intel i5/AMD Ryzen 5 |
303
+ | **Mac** | 4 GB Free RAM, Apple M1 | Apple M2 or newer |
304
+ | **Linux** | 4 GB Free RAM | 8 GB RAM |
305
 
306
+ **Storage Space Required:** 2.5 GB free
 
 
 
307
 
308
  ---
309
 
310
+ ## ❓ Frequently Asked Questions
311
+
312
+ **Q: Does it really work without internet?**
313
+ A: Yes! After the first download, Krish Mind runs 100% offline. You can even enable Airplane Mode.
314
 
315
+ **Q: My phone only has 4 GB RAM. Will it work?**
316
+ A: Yes. The Mobile version is specifically designed for devices with 4 GB of RAM. It will work on most modern mid-range smartphones.
317
 
318
+ **Q: Is it free forever?**
319
+ A: Yes. It is released under Apache 2.0. Free for personal and commercial use.
320
 
321
  ---
322
 
323
  <div align="center">
324
 
325
+ **✨ Happy Chatting with Krish Mind Mobile! ✨**
326
  *Made with ❀️ by Krish CS*
327
 
328
  </div>