Azrqai commited on
Commit
d3cc7fd
·
verified ·
1 Parent(s): c8a3e04

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -11
README.md CHANGED
@@ -35,9 +35,9 @@ Q4_K_M offers near-full-quality output while staying small enough to run comfort
35
 
36
  ## Quick Start
37
 
38
- ### Ollama (easiest)
39
 
40
- **Option A — run directly from the Ollama library:**
41
 
42
  ```bash
43
  ollama run mikalabs/Vector-L1-4B-GGUF
@@ -45,30 +45,38 @@ ollama run mikalabs/Vector-L1-4B-GGUF
45
 
46
  Library page: https://ollama.com/mikalabs/Vector-L1-4B-GGUF
47
 
48
- **Option B pull the GGUF straight from Hugging Face:**
49
 
50
- ```bash
51
- ollama run hf.co/MikaLabs/Vector-L1-4B-GGUF:Q4_K_M
52
- ```
53
-
54
- **Option C — build it yourself from the downloaded file.** Create a file named `Modelfile`:
55
 
56
  ```
57
  FROM ./Vector-L1-4B-Q4_K_M.gguf
58
 
59
  PARAMETER temperature 0.7
60
  PARAMETER top_p 0.8
61
-
62
- SYSTEM "You are Vector, a teaching assistant made by MikaLabs that helps educators create classroom materials such as worksheets, lesson plans, quizzes, and mark schemes."
 
 
 
 
 
 
 
 
 
 
63
  ```
64
 
65
- Then:
66
 
67
  ```bash
68
  ollama create vector-l1 -f Modelfile
69
  ollama run vector-l1
70
  ```
71
 
 
 
72
  ### LM Studio
73
 
74
  Download the `.gguf` file, place it in your LM Studio models folder (or use the in-app downloader), select it, and chat. Set temperature to 0.7 and top_p to 0.8.
 
35
 
36
  ## Quick Start
37
 
38
+ ### Ollama
39
 
40
+ **Option A — run directly from the Ollama library (recommended):**
41
 
42
  ```bash
43
  ollama run mikalabs/Vector-L1-4B-GGUF
 
45
 
46
  Library page: https://ollama.com/mikalabs/Vector-L1-4B-GGUF
47
 
48
+ This is the easiest way to use Vector. The model comes pre-configured with the correct chat template, stop tokens, recommended settings, and system prompt — nothing else to set up.
49
 
50
+ **Option B — build from the GGUF file yourself.** Download `Vector-L1-4B-Q4_K_M.gguf` from this repository, then create a file named `Modelfile` next to it:
 
 
 
 
51
 
52
  ```
53
  FROM ./Vector-L1-4B-Q4_K_M.gguf
54
 
55
  PARAMETER temperature 0.7
56
  PARAMETER top_p 0.8
57
+ PARAMETER stop "<|im_end|>"
58
+ PARAMETER stop "<|im_start|>"
59
+
60
+ TEMPLATE """{{ if .System }}<|im_start|>system
61
+ {{ .System }}<|im_end|>
62
+ {{ end }}{{ if .Prompt }}<|im_start|>user
63
+ {{ .Prompt }}<|im_end|>
64
+ {{ end }}<|im_start|>assistant
65
+ {{ .Response }}<|im_end|>
66
+ """
67
+
68
+ SYSTEM "You are Vector, a teaching assistant made by MikaLabs that helps educators create worksheets, lesson plans, quizzes, mark schemes, and explanations. You focus on teaching and education."
69
  ```
70
 
71
+ Then build and run:
72
 
73
  ```bash
74
  ollama create vector-l1 -f Modelfile
75
  ollama run vector-l1
76
  ```
77
 
78
+ > **Note:** The Modelfile's explicit template and stop tokens are what ensure clean, single-turn responses. Use Option A or B rather than pulling the raw `.gguf` without a Modelfile.
79
+
80
  ### LM Studio
81
 
82
  Download the `.gguf` file, place it in your LM Studio models folder (or use the in-app downloader), select it, and chat. Set temperature to 0.7 and top_p to 0.8.