Add README

README.md

@@ -1,41 +1,23 @@
 ---
-license: mit
-base_model: unsloth/Phi-3-mini-4k-instruct-bnb-4bit
 tags:
-- text-to-sql
-- sql
-- phi-3
-- unsloth
 - gguf
-- ollama
-datasets:
-- b-mc2/sql-create-context
-language:
-- en
----
-
-# Phi-3-SQL-Expert (GGUF)
+- llama.cpp
+- unsloth
 
-This model is a fine-tuned version of **Microsoft Phi-3-mini-4k-instruct**, specialized for **Text-to-SQL** conversion. It was trained using the `b-mc2/sql-create-context` dataset and is optimized for local inference on consumer hardware.
+---
 
-## Model Details
-- **Architecture:** Phi-3-mini (3.8B parameters)
-- **Quantization:** Q4_K_M GGUF (Optimised for balance of speed/accuracy)
-- **Fine-tuning Technique:** LoRA (Low-Rank Adaptation) via Unsloth
-- **Primary Task:** Natural Language to SQL Query generation
+# phi3-text2sql-lora : GGUF
 
-## Usage (Ollama)
-To run this model locally, create a `Modelfile` with the following content:
+This model was finetuned and converted to GGUF format using [Unsloth](https://github.com/unslothai/unsloth).
 
-```dockerfile
-FROM ./phi3-sql-expert.Q4_K_M.gguf
+**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`
 
-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|>
-"""
+## Available Model files:
+- `phi-3-mini-4k-instruct.Q4_K_M.gguf`
 
-PARAMETER stop "<|end|>"
-PARAMETER temperature 0.1
+## 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)