Mmxa commited on
Commit
1f56567
Β·
verified Β·
1 Parent(s): dc33219

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -62
README.md CHANGED
@@ -25,9 +25,9 @@ datasets:
25
 
26
  # πŸ€– LaboAI-0.3.3-3B
27
 
28
- This is a mid-sized language model (3B parameters) fine-tuned specifically for generating, understanding, and debugging **Kotlin** code and **Android** development (with a strong emphasis on Jetpack Compose, Coroutines, and modern architectures).
29
 
30
- This version (0.3.3) shares the same training recipe as the 1.5B variant but leverages the increased capacity of the 3B base model for superior reasoning, better handling of complex code structures, and improved generalization across diverse Android development scenarios. It is optimized using **QLoRA (4-bit)** to run efficiently on consumer GPUs with 6-8GB VRAM.
31
 
32
  ## πŸ“‹ Model Details
33
 
@@ -41,11 +41,10 @@ This version (0.3.3) shares the same training recipe as the 1.5B variant but lev
41
  ## πŸš€ Uses
42
 
43
  ### Direct Use
44
- - Generating boilerplate for Activities, Fragments, ViewModels, and Repositories in Kotlin.
45
- - Creating modern UI components with **Jetpack Compose**.
46
  - Debugging compilation errors or logic flaws in Android code snippets.
47
  - Translating legacy Java logic into modern, idiomatic Kotlin.
48
- - Understanding and explaining complex Android architecture patterns (MVVM, MVI, Clean Architecture).
49
 
50
  ### Ecosystem Use (Recommended)
51
  This model shines when used as a local coding assistant via **Ollama** and the **Continue** extension in VS Code. This guarantees complete privacy (your code never leaves your machine) and low latency.
@@ -57,66 +56,14 @@ This model shines when used as a local coding assistant via **Ollama** and the *
57
 
58
  ## ⚠️ Limitations and Risks
59
  - **API Hallucinations:** In rare cases, it might suggest deprecated Android APIs instead of modern alternatives.
60
- - **Context Window:** Optimized for 2048 tokens. It is not suitable for analyzing massive, multi-thousand-line codebase files all at once.
61
  - **Dependencies:** It does not have real-time knowledge of the latest Android library updates.
62
 
63
  ## πŸ’» How to Get Started (Local Setup)
64
 
65
- This repository includes both the original format (`safetensors`) and the quantized format (`GGUF` Q4_K_M). To use it on your PC with a 6-8GB VRAM GPU:
66
 
67
  1. Install [Ollama](https://ollama.com/).
68
- 2. Download the `.gguf` file from this repository (e.g., `LaboAI-0.3.3-3B-Q4_K_M.gguf`).
69
- 3. Create a file named `Modelfile` in the same folder with the following content:
70
- ```text
71
- FROM ./LaboAI-0.3.3-3B-Q4_K_M.gguf
72
- TEMPLATE """{{- if .Messages }}
73
- {{- if or .System .Tools }}<|im_start|>system
74
- {{- if .System }}
75
- {{ .System }}
76
- {{- end }}
77
- {{- if .Tools }}
78
-
79
- # Tools
80
-
81
- You may call one or more functions to assist with the user query.
82
-
83
- You are provided with function signatures within <tools></tools> XML tags:
84
- <tools>
85
- {{- range .Tools }}
86
- {"type": "function", "function": {{ .Function }}}
87
- {{- end }}
88
- </tools>
89
-
90
- For each function call, return a json object with function name and arguments within XML tags:
91
-
92
- {{- end }}<|im_end|>
93
- {{ end }}
94
- {{- range $i, $_ := .Messages }}
95
- {{- $last := eq (len (slice $.Messages $i)) 1 -}}
96
- {{- if eq .Role "user" }}<|im_start|>user
97
- {{ .Content }}<|im_end|>
98
- {{ else if eq .Role "assistant" }}<|im_start|>assistant
99
- {{ if .Content }}{{ .Content }}
100
- {{- else if .ToolCalls }}
101
- {{- end }}{{ if not $last }}<|im_end|>
102
- {{ end }}
103
- {{- else if eq .Role "tool" }}<|im_start|>user
104
- <tool_response>
105
- {{ .Content }}
106
- </tool_response><|im_end|>
107
- {{ end }}
108
- {{- if and (ne .Role "assistant") $last }}<|im_start|>assistant
109
- {{ end }}
110
- {{- end }}
111
- {{- else }}
112
- {{- if .System }}<|im_start|>system
113
- {{ .System }}<|im_end|>
114
- {{ end }}{{ if .Prompt }}<|im_start|>user
115
- {{ .Prompt }}<|im_end|>
116
- {{ end }}<|im_start|>assistant
117
- {{ end }}{{ .Response }}{{ if .Response }}<|im_end|>{{ end }}"""
118
- PARAMETER stop "<|im_end|>"
119
- PARAMETER stop "<|endoftext|>"
120
- PARAMETER temperature 0.7
121
- PARAMETER min_p 0.1
122
- SYSTEM """You are LaboAI, a helpful assistant specialized in Kotlin and Android development."""
 
25
 
26
  # πŸ€– LaboAI-0.3.3-3B
27
 
28
+ This is a lightweight yet capable language model (3B parameters) fine-tuned specifically for generating, understanding, and debugging **Kotlin** code and **Android** development (with a strong emphasis on Jetpack Compose, Coroutines, and modern architectures).
29
 
30
+ This version (0.3.3) applies the same proven, multi-dataset training recipe as the 1.5B version, but scaled up to the 3B architecture for improved reasoning, better context understanding, and more reliable code generation. It is optimized using **QLoRA (4-bit)** to run efficiently on consumer hardware (e.g., NVIDIA RTX 3060 12GB, or RTX 4060).
31
 
32
  ## πŸ“‹ Model Details
33
 
 
41
  ## πŸš€ Uses
42
 
43
  ### Direct Use
44
+ - Generating robust boilerplate for Activities, Fragments, ViewModels, and Repositories in Kotlin.
45
+ - Creating complex modern UI components with **Jetpack Compose**.
46
  - Debugging compilation errors or logic flaws in Android code snippets.
47
  - Translating legacy Java logic into modern, idiomatic Kotlin.
 
48
 
49
  ### Ecosystem Use (Recommended)
50
  This model shines when used as a local coding assistant via **Ollama** and the **Continue** extension in VS Code. This guarantees complete privacy (your code never leaves your machine) and low latency.
 
56
 
57
  ## ⚠️ Limitations and Risks
58
  - **API Hallucinations:** In rare cases, it might suggest deprecated Android APIs instead of modern alternatives.
59
+ - **Context Window:** Optimized for 1024 tokens during training. It is not suitable for analyzing massive, multi-thousand-line codebase files all at once.
60
  - **Dependencies:** It does not have real-time knowledge of the latest Android library updates.
61
 
62
  ## πŸ’» How to Get Started (Local Setup)
63
 
64
+ This repository includes both the original format (`safetensors`) and the quantized format (`GGUF` Q4_K_M).
65
 
66
  1. Install [Ollama](https://ollama.com/).
67
+ 2. Run the model directly from Hugging Face:
68
+ ```bash
69
+ ollama run hf.co/LaboAI/LaboAI-0.3.3-3B:Q4_K_M