mrcmilo commited on
Commit
4936ab3
·
verified ·
1 Parent(s): 0e1f473

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +30 -11
README.md CHANGED
@@ -1,22 +1,41 @@
1
  ---
 
2
  base_model: unsloth/Phi-3-mini-4k-instruct-bnb-4bit
3
  tags:
4
- - text-generation-inference
5
- - transformers
 
6
  - unsloth
7
- - mistral
8
- - trl
9
- license: apache-2.0
 
10
  language:
11
  - en
12
  ---
13
 
14
- # Uploaded model
15
 
16
- - **Developed by:** mrcmilo
17
- - **License:** apache-2.0
18
- - **Finetuned from model :** unsloth/Phi-3-mini-4k-instruct-bnb-4bit
19
 
20
- This mistral model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth)
 
 
 
 
21
 
22
- [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: mit
3
  base_model: unsloth/Phi-3-mini-4k-instruct-bnb-4bit
4
  tags:
5
+ - text-to-sql
6
+ - sql
7
+ - phi-3
8
  - unsloth
9
+ - gguf
10
+ - ollama
11
+ datasets:
12
+ - b-mc2/sql-create-context
13
  language:
14
  - en
15
  ---
16
 
17
+ # Phi-3-SQL-Expert (GGUF)
18
 
19
+ 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.
 
 
20
 
21
+ ## Model Details
22
+ - **Architecture:** Phi-3-mini (3.8B parameters)
23
+ - **Quantization:** Q4_K_M GGUF (Optimised for balance of speed/accuracy)
24
+ - **Fine-tuning Technique:** LoRA (Low-Rank Adaptation) via Unsloth
25
+ - **Primary Task:** Natural Language to SQL Query generation
26
 
27
+ ## Usage (Ollama)
28
+ To run this model locally, create a `Modelfile` with the following content:
29
+
30
+ ```dockerfile
31
+ FROM ./phi3-sql-expert.Q4_K_M.gguf
32
+
33
+ TEMPLATE """<|system|>
34
+ You are a helpful assistant that writes SQL queries. Given a user question and a table schema, output only the SQL code.<|end|>
35
+ <|user|>
36
+ {{ .Prompt }}<|end|>
37
+ <|assistant|>
38
+ """
39
+
40
+ PARAMETER stop "<|end|>"
41
+ PARAMETER temperature 0.1