Update README.md

README.md

@@ -1,23 +1,49 @@
 ---
+license: mit
+base_model: microsoft/Phi-3-mini-4k-instruct
 tags:
-- gguf
-- llama.cpp
+- text-to-sql
+- natural-language-to-sql
+- phi-3
 - unsloth
-
+- gguf
+- ollama
+- logic
+datasets:
+- b-mc2/sql-create-context
+language:
+- en
+library_name: unsloth
+pipeline_tag: text-generation
 ---
 
-# phi3-text2sql-lora : GGUF
+# Phi-3-SQL-Expert (GGUF)
+
+This is a specialized **Text-to-SQL** model fine-tuned from the **Microsoft Phi-3-mini-4k-instruct** architecture. It has been optimized using **Unsloth** to provide high-accuracy SQL generation while remaining lightweight enough to run on consumer hardware.
+
+## 🚀 Key Features
+- **Architecture:** Phi-3-mini (3.8B parameters)
+- **Quantization:** Q4_K_M GGUF (Optimized balance of speed and logic)
+- **Fast Training:** Fine-tuned using [Unsloth](https://github.com/unslothai/unsloth).
+- **Format:** GGUF (Ready for Ollama, LM Studio, and llama.cpp)
+
+## 🛠 Usage Instructions
 
-This model was finetuned and converted to GGUF format using [Unsloth](https://github.com/unslothai/unsloth).
+### 1. Ollama (Recommended)
+To deploy locally:
 
-**Example usage**:
-- For text only LLMs:    `./llama.cpp/llama-cli -hf mrcmilo/phi3-text2sql-lora --jinja`
-- For multimodal models: `./llama.cpp/llama-mtmd-cli -hf mrcmilo/phi3-text2sql-lora --jinja`
+1. Download the `.gguf` file.
+2. Create a file named `Modelfile` and paste the following:
+```dockerfile
+FROM ./phi-3-mini-4k-instruct.Q4_K_M.gguf
 
-## Available Model files:
-- `phi-3-mini-4k-instruct.Q4_K_M.gguf`
+TEMPLATE """<|system|>
+You are a helpful assistant that writes SQL queries. Given a user question and a table schema, output only the SQL code.<|end|>
+<|user|>
+{{ .Prompt }}<|end|>
+<|assistant|>
+"""
 
-## Ollama
-An Ollama Modelfile is included for easy deployment.
-This was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth)
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+PARAMETER stop "<|end|>"
+PARAMETER temperature 0.1
+PARAMETER num_ctx 2048