Update README.md

README.md

@@ -3,21 +3,72 @@ tags:
 - gguf
 - llama.cpp
 - unsloth
-
+license: mit
+datasets:
+- b-mc2/sql-create-context
+language:
+- en
+metrics:
+- accuracy
+base_model:
+- microsoft/Phi-3-mini-4k-instruct
 ---
+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 & Q5_K_M
+- **Training Technique:** Fine-tuned using Lora with [Unsloth](https://github.com/unslothai/unsloth).
+- **Format:** GGUF (Ready for Ollama, LM Studio, and llama.cpp)
+  - **phi-3-mini-4k-instruct.Q4_K_M.gguf** 
+  - **phi-3-mini-4k-instruct.Q5_K_M.gguf**
+
+## Usage Instructions
+
+### Ollama (Recommended)
+To deploy locally:
+
+1. Download the `.gguf` file.
+
+2. Create the Modelfile with the following instructions
+
+```Dockerfile
+FROM ./phi-3-mini-4k-instruct.Q4_K_M.gguf
+
+SYSTEM """You are a specialized SQL assistant. Your goal is to produce valid SQL queries based on the provided schema and question. Output only the SQL code and nothing else."""
+
+TEMPLATE """<|system|>
+{{ .System }}<|end|>
+<|user|>
+{{ .Prompt }}<|end|>
+<|assistant|>
+"""
+
+PARAMETER stop "<|end|>"
+PARAMETER temperature 0.1
+PARAMETER num_ctx 2048
+PARAMETER repeat_penalty 1.2
+```
+
+3. Run ```ollama create phi3-sql-expert -f Modelfile```
+
+5. Run ```ollama run phi3-sql-expert```
+
+
+## Evaluation Data
+The model was fine-tuned on the sql-create-context dataset, focusing on:
+
+- Mapping natural language to complex SELECT, WHERE, and JOIN statements.
+- Understanding table schemas provided in the prompt.
+- Maintaining strict SQL syntax.
 
-# phi3-text2sql-lora : GGUF
+## Recommended Settings
+Temperature: 0.0 or 0.1 (SQL requires deterministic output).
 
-This model was finetuned and converted to GGUF format using [Unsloth](https://github.com/unslothai/unsloth).
+Stop Tokens: Ensure <|end|> is set as a stop sequence to prevent "infinite looping" generation.
 
-**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`
+Context Window: 2048 tokens.
 
-## Available Model files:
-- `phi-3-mini-4k-instruct.Q5_K.gguf`
+**Model Developer**: [msquared](https://github.com/mrcmilano)
 
-## 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)
+Base Model: [Phi-3-mini-4k-instruct](https://huggingface.co/microsoft/Phi-3-mini-4k-instruct)