mrcmilo commited on
Commit
66d2627
·
verified ·
1 Parent(s): 06259cd

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +30 -4
README.md CHANGED
@@ -21,15 +21,15 @@ pipeline_tag: text-generation
21
 
22
  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.
23
 
24
- ## 🚀 Key Features
25
  - **Architecture:** Phi-3-mini (3.8B parameters)
26
  - **Quantization:** Q4_K_M GGUF (Optimized balance of speed and logic)
27
  - **Training Technique:** Fine-tuned using Lora with [Unsloth](https://github.com/unslothai/unsloth).
28
  - **Format:** GGUF (Ready for Ollama, LM Studio, and llama.cpp)
29
 
30
- ## 🛠 Usage Instructions
31
 
32
- ### 1. Ollama (Recommended)
33
  To deploy locally:
34
 
35
  1. Download the `.gguf` file.
@@ -46,4 +46,30 @@ You are a helpful assistant that writes SQL queries. Given a user question and a
46
 
47
  PARAMETER stop "<|end|>"
48
  PARAMETER temperature 0.1
49
- PARAMETER num_ctx 2048
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
 
22
  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.
23
 
24
+ ## Key Features
25
  - **Architecture:** Phi-3-mini (3.8B parameters)
26
  - **Quantization:** Q4_K_M GGUF (Optimized balance of speed and logic)
27
  - **Training Technique:** Fine-tuned using Lora with [Unsloth](https://github.com/unslothai/unsloth).
28
  - **Format:** GGUF (Ready for Ollama, LM Studio, and llama.cpp)
29
 
30
+ ## Usage Instructions
31
 
32
+ ### Ollama (Recommended)
33
  To deploy locally:
34
 
35
  1. Download the `.gguf` file.
 
46
 
47
  PARAMETER stop "<|end|>"
48
  PARAMETER temperature 0.1
49
+ PARAMETER num_ctx 2048
50
+ ```
51
+
52
+ 3. Run ollama create sql-expert -f Modelfile
53
+
54
+ 4. Run ollama run sql-expert
55
+
56
+
57
+ ## Evaluation Data
58
+ The model was fine-tuned on the sql-create-context dataset, focusing on:
59
+
60
+ Mapping natural language to complex SELECT, WHERE, and JOIN statements.
61
+
62
+ Understanding table schemas provided in the prompt.
63
+
64
+ Maintaining strict SQL syntax.
65
+
66
+ ## Recommended Settings
67
+ Temperature: 0.0 or 0.1 (SQL requires deterministic output).
68
+
69
+ Stop Tokens: Ensure <|end|> is set as a stop sequence to prevent "infinite looping" generation.
70
+
71
+ Context Window: 2048 or 4096 tokens.
72
+
73
+ Model Developer: mrcmilo
74
+
75
+ Base Model: Phi-3-mini-4k-instruct