Mmxa commited on
Commit
8ff68fb
·
verified ·
1 Parent(s): 39b3d48

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +59 -14
README.md CHANGED
@@ -1,23 +1,68 @@
1
  ---
 
 
 
 
2
  tags:
3
- - gguf
4
- - llama.cpp
 
 
 
 
5
  - unsloth
6
-
 
 
 
 
 
 
 
 
 
 
7
  ---
8
 
9
- # LaboAI-0.3.3-3B : 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-3B --jinja`
15
- - For multimodal models: `llama-mtmd-cli -hf LaboAI/LaboAI-0.3.3-3B --jinja`
16
 
17
- ## Available Model files:
18
- - `Qwen2.5-3B-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
+ - 3b
17
+ - function-calling
18
+ license: apache-2.0
19
+ base_model: Qwen/Qwen2.5-3B-Instruct
20
+ datasets:
21
+ - giggiovpg/ornith-android-instruct
22
+ - giggiovpg/android-kotlin-compose-compiler-verified
23
+ - microsoft/NextCoderDataset
24
+ - glaiveai/glaive-code-assistant-v3
25
  ---
26
 
27
+ # 🤖 LaboAI-0.3.3-3B
28
+
29
+ This is a versatile, 3-billion parameter language model heavily fine-tuned for **Kotlin** and **Android** development, while retaining strong general-purpose capabilities.
30
+
31
+ Built on the robust `Qwen2.5-3B-Instruct` architecture, this model underwent a massive, high-quality fine-tuning regimen (v0.3.3). It excels at generating, understanding, and debugging modern Android code (Jetpack Compose, Coroutines, MVVM) but remains highly capable in general chat, reasoning, and tool-calling tasks.
32
+
33
+ ## 📋 Model Details
34
+
35
+ - **Developed by:** Mmxa
36
+ - **Organization:** LaboAI
37
+ - **Model type:** Causal Language Model (Code Generation & General Assistant)
38
+ - **Languages:** Kotlin, Java, English, Spanish
39
+ - **License:** Apache 2.0 (inherited from Qwen2.5)
40
+ - **Base model:** [Qwen/Qwen2.5-3B-Instruct](https://huggingface.co/Qwen/Qwen2.5-3B-Instruct)
41
+
42
+ ## 🚀 Uses
43
+
44
+ ### Direct Use
45
+ - **Android Development:** Generating boilerplate, Jetpack Compose UIs, ViewModels, and debugging Kotlin code.
46
+ - **General Assistant:** Answering questions, summarizing text, and logical reasoning.
47
+ - **Tool Calling:** Capable of structured JSON output for function calling and agentic workflows.
48
+
49
+ ### Ecosystem Use (Recommended)
50
+ This model is optimized for local inference via **Ollama** and integrates seamlessly with the **Continue** extension in VS Code. It strikes the perfect balance between intelligence and local hardware efficiency.
51
+
52
+ ### Out-of-Scope Uses
53
+ - It should not be used to generate malicious code, exploits, or harmful content.
54
+ - All generated code must be reviewed by a human developer before deployment.
55
 
56
+ ## ⚠️ Limitations and Risks
57
+ - **Context Window:** Optimized for 2048-4096 tokens. It may lose coherence in extremely long, multi-file contexts.
58
+ - **API Hallucinations:** In rare cases, it might suggest slightly deprecated Android APIs.
59
+ - **General Knowledge:** While fine-tuned for code, its general world knowledge is bounded by its base model and the fine-tuning data distribution.
60
 
61
+ ## How to Get Started (Local Setup)
 
 
62
 
63
+ This repository includes both the original format (`safetensors`) and the quantized format (`GGUF` Q4_K_M).
 
64
 
65
+ ### Quick Start with Ollama
66
+ The fastest way to run this model is directly from Hugging Face via Ollama:
67
+ ```bash
68
+ ollama run hf.co/LaboAI/LaboAI-0.3.3-3B:Q4_K_M