Update README.md

README.md

@@ -1,24 +1,69 @@
----
+"""---
+language:
+- hi
+- en
+- hinglish
 tags:
+- agriculture
+- farming
+- india
+- kisan
+- gemma
 - gguf
-- llama.cpp
-- unsloth
-
+- text-generation-inference
+- on-device
+- android
+base_model: unsloth/gemma-2-2b-it-bnb-4bit
+license: gemma
+pipeline_tag: text-generation
+quantized_by: bf369
 ---
 
-# BeejX-Gemma2-2B-Hindi-SFT - GGUF
+# BeejX-Gemma2-2B-Hindi-SFT (GGUF)
+
+**BeejX** is a lightweight, offline-capable AI assistant specifically fine-tuned for **Indian Agriculture** (Bhartiya Krishi). 
+It is designed to run on low-end Android smartphones (4GB+ RAM) using the GGUF format, making it accessible to farmers without active internet connections.
+
+## Model Details
+- **Base Model:** [Gemma 2 2B Instruct](https://huggingface.co/google/gemma-2-2b-it) (Google)
+- **Fine-tuning:** Supervised Fine-Tuning (SFT) using [Unsloth](https://github.com/unslothai/unsloth) on 1,000+ samples of Indian agriculture Q&A.
+- **Language:** Hindi (Devanagari), Hinglish (Roman Hindi), and English.
+- **Format:** GGUF (Quantized to `Q4_K_M` for best Mobile balance).
+- **File Size:** ~1.5 GB (Fits easily on modern Android phones).
+
+## Capabilities
+- **Crop Advice:** Detailed guides for Wheat (Gehu), Rice (Dhaan), Sugarcane (Ganna), Maize (Makka), etc.
+- **Disease Identification:** Describes symptoms and organic/chemical remedies (e.g., Yellow Rust, Termites, Blight).
+- **Localized Knowledge:** Understands Indian seasons (Rabi, Kharif, Zaid) and local fertilizers (DAP, Urea, NPK).
+- **Safety:** Trained to refuse non-agriculture questions to keep the app focused.
+
+## How to Run on Android (Flutter)
+This model is optimized for the `llama.cpp` ecosystem. 
+
+1. **Download:** Get the `unsloth.Q4_K_M.gguf` file from the [Files tab](./tree/main).
+2. **Move to Device:** Place the file in your App's `ApplicationDocumentsDirectory`.
+3. **Flutter Integration:** Use a library like `llama_cpp_dart` or `fllama`.
+4. **Recommended Parameters:**
+    - `context_size`: 2048
+    - `temperature`: 0.7
+    - `system_prompt`:
+    ```text
+    You are BeejX, an expert Indian agriculture assistant. 
+    Answer in the same language as the user (Hindi/Hinglish). 
+    Keep answers short, practical, and easy for a farmer to understand.
+    ```
 
-This model was finetuned and converted to GGUF format using [Unsloth](https://github.com/unslothai/unsloth).
+## How to Run on PC (Ollama)
+You can test this model on your laptop using Ollama before deploying to mobile.
 
-**Example usage**:
-- For text only LLMs:    **llama-cli** **--hf** repo_id/model_name **-p** "why is the sky blue?"
-- For multimodal models: **llama-mtmd-cli** **-m** model_name.gguf **--mmproj** mmproj_file.gguf
+## Limitations & Disclaimer
+AI Advice: This is an AI model. While trained on agricultural data, it can hallucinate. Users should verify chemical dosages with a local Krishi Vigyan Kendra (KVK) expert.
 
-## Available Model files:
-- `gemma-2-2b-it.Q4_K_M.gguf`
+Language: Performance is best in Hindi and Hinglish. Pure regional dialects (like Punjabi/Bhojpuri) may have lower accuracy.
 
-## Ollama
-An Ollama Modelfile is included for easy deployment.
+## Credits
+Finetuned by **Bhashkar Fulara** using Unsloth .
 
-## Note
-The model's BOS token behavior was adjusted for GGUF compatibility.
+```bash
+# Run directly from Hugging Face
+ollama run hf.co/bf369/BeejX-Gemma2-2B-Hindi-SFT