Mmxa commited on
Commit
7d29255
·
verified ·
1 Parent(s): 5ae93aa

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +63 -14
README.md CHANGED
@@ -1,23 +1,72 @@
1
  ---
 
 
 
 
2
  tags:
3
- - gguf
4
- - llama.cpp
 
 
 
 
5
  - unsloth
6
-
 
 
 
 
 
 
 
 
 
7
  ---
8
 
9
- # LaboAI-0.3.3-1.5B : GGUF
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
 
11
- This model was finetuned and converted to GGUF format using [Unsloth](https://github.com/unslothai/unsloth).
 
 
 
12
 
13
- **Example usage**:
14
- - For text only LLMs: `llama-cli -hf LaboAI/LaboAI-0.3.3-1.5B --jinja`
15
- - For multimodal models: `llama-mtmd-cli -hf LaboAI/LaboAI-0.3.3-1.5B --jinja`
16
 
17
- ## Available Model files:
18
- - `Qwen2.5-1.5B-Instruct.Q4_K_M.gguf`
19
 
20
- ## Ollama
21
- An Ollama Modelfile is included for easy deployment.
22
- This was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth)
23
- [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
 
 
 
 
1
  ---
2
+ language:
3
+ - en
4
+ - es
5
+ - code
6
  tags:
7
+ - code-generation
8
+ - android
9
+ - kotlin
10
+ - java
11
+ - jetpack-compose
12
+ - qwen2.5
13
  - unsloth
14
+ - gguf
15
+ - ollama
16
+ - 1.5b
17
+ license: apache-2.0
18
+ base_model: Qwen/Qwen2.5-1.5B-Instruct
19
+ datasets:
20
+ - giggiovpg/ornith-android-instruct
21
+ - giggiovpg/android-kotlin-compose-compiler-verified
22
+ - microsoft/NextCoderDataset
23
+ - glaiveai/glaive-code-assistant-v3
24
  ---
25
 
26
+ # LaboAI-0.3.3-1.5B
27
+
28
+ This is a lightweight language model (1.5B 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) is the result of an optimized, multi-dataset training regimen designed for extreme efficiency. It is optimized using **QLoRA (4-bit)** to run locally on GPUs with limited VRAM (such as the NVIDIA Quadro M2000 with 4GB) without sacrificing code quality.
31
+
32
+ ## 📋 Model Details
33
+
34
+ - **Developed by:** Mmxa
35
+ - **Organization:** LaboAI
36
+ - **Model type:** Causal Language Model (Code Generation)
37
+ - **Languages:** Kotlin, Java, English, Spanish (instructions)
38
+ - **License:** Apache 2.0 (inherited from Qwen2.5)
39
+ - **Base model:** [Qwen/Qwen2.5-1.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-1.5B-Instruct)
40
+
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
+
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 ultra-low latency.
51
+
52
+ ### Out-of-Scope Uses
53
+ - It is not optimized for general chat, creative writing, or complex mathematical reasoning.
54
+ - It should not be used to generate malicious code or exploits.
55
+ - All generated code must be reviewed by a human developer before being merged into a main branch.
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-2048 tokens. 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). To use it on your PC with a 4GB VRAM GPU:
 
65
 
66
+ 1. Install [Ollama](https://ollama.com/).
67
+ 2. Download the `.gguf` file from this repository (e.g., `LaboAI-0.3.3-1.5B-Q4_K_M.gguf`).
68
+ 3. Create a file named `Modelfile` in the same folder with the following content:
69
+ ```text
70
+ FROM ./LaboAI-0.3.3-1.5B-Q4_K_M.gguf
71
+ PARAMETER stop "### Instruction:"
72
+ PARAMETER stop "### Response:"