amitashwini commited on
Commit
5d7804b
·
verified ·
1 Parent(s): ad4d1dc

Repo README: document 3-tier catalog + mirror policy (ADR-245)

Browse files
Files changed (1) hide show
  1. README.md +30 -110
README.md CHANGED
@@ -1,133 +1,53 @@
1
  ---
2
  license: apache-2.0
3
- base_model: Qwen/Qwen3-0.6B-Base
4
  tags:
5
  - text-generation
 
 
6
  - qwen3
7
  - hinglish
8
- - roman-hindi
9
- - gguf
10
- - qlora
11
- datasets:
12
- - Abhishekcr448/Hinglish-Everyday-Conversations-1M
13
- - Roshan32/Hinglish_Dataset_instruction_and_raw
14
- - BhabhaAI/Cross-Hindi-Hinglish-chat
15
- pipeline_tag: text-generation
16
  ---
17
 
18
- # WriteAmp-Qwen3-0.6B-Hinglish-v3
19
-
20
- QLoRA fine-tune of [`Qwen/Qwen3-0.6B-Base`](https://huggingface.co/Qwen/Qwen3-0.6B-Base) (Apache 2.0) for
21
- **Hinglish** (Roman/Latin-script Hindi) short-continuation. Shipped as a single Q4_K_M GGUF and used by
22
- [WriteAmp](https://writeamp.site) as the `max` / multilingual tier of its on-device macOS tab-autocomplete
23
- engine. Replaces the upstream base Qwen3-0.6B for all `max` users and all non-English routing in the
24
- catalog.
25
-
26
- > Base model card, license, and citation: see
27
- > [`Qwen/Qwen3-0.6B-Base`](https://huggingface.co/Qwen/Qwen3-0.6B-Base) (Apache 2.0, © Alibaba Cloud).
28
-
29
- ## Intended use
30
-
31
- Short, cursor-local continuations of Roman-script Hinglish writing — the kind that flows through text
32
- fields in mail, chat, social posts, and notes. Designed to run **on-device** on Apple Silicon via the
33
- [llama.cpp](https://github.com/ggml-org/llama.cpp) runtime vendored by WriteAmp (`b9402`,
34
- `19e92c33ef974661e4b1e43dd48be231d07be5ed`). **Not** an instruct or chat model — pure base-model
35
- continuation.
36
-
37
- The WriteAmp app wraps the model with a Hindi-Roman directive, repetition guards, no-repeat-n-gram
38
- size 2, short output budget, and a Devanagari→Latin safety filter. Bare-bones `llama.cpp` use without
39
- those guards is **not** a supported configuration.
40
-
41
- ## What's in the box
42
-
43
- A single immutable file:
44
-
45
- | File | Size | SHA-256 |
46
- | --- | --- | --- |
47
- | `WriteAmp-Qwen3-0.6B-Hinglish-v3.Q4_K_M.gguf` | 396,704,544 bytes | `98df7dd1daaf65602fa002733d5c5a32527acd174730b591235f0ed170f17185` |
48
-
49
- Architecture: `qwen3`, 28 layers, 1024 hidden dim, 151,936 token vocabulary, BOS/EOS token ID `151643`.
50
- Q4_K_M quantization. Built against the same llama.cpp revision as the WriteAmp vendored runtime,
51
- and loads cleanly through `LlamaModelRuntime` with reported `vocabularySize == 151936`.
52
-
53
- The on-disk ACPF token profile (`qwen3-v151936.acpf.bin`) shipped by the WriteAmp app opens cleanly
54
- against this artifact; no profile rebuild is required.
55
 
56
- ## Reproducibility
 
 
57
 
58
- Exact toolchain and command lines used to produce this artifact live in
59
- [`tools/hinglish-sft/build-release-q4.sh`](../../tools/hinglish-sft/build-release-q4.sh) and the
60
- [WriteAmp decision log](../../docs/05-decisions.md) (ADR-243, ADR-244).
 
 
61
 
62
- Summary of the inputs:
63
-
64
- | Input | Source |
65
- | --- | --- |
66
- | Base model | [`Qwen/Qwen3-0.6B-Base`](https://huggingface.co/Qwen/Qwen3-0.6B-Base) (Apache 2.0) |
67
- | LoRA adapter | `tools/hinglish-sft/adapter/big-v2/0003000_adapters.safetensors` (QLoRA, rank 8, q/v only) |
68
- | Training data | 838K examples built by `build_dataset.py` from the three HF datasets below |
69
- | llama.cpp revision | `b9402` (`19e92c33ef974661e4b1e43dd48be231d07be5ed`) |
70
- | Converter | `llama.cpp/convert_hf_to_gguf.py` (official) |
71
- | Quantizer | `llama-quantize` from the same checkout |
72
-
73
- ## Training data
74
-
75
- Built from three public datasets, mixed in `tools/hinglish-sft/build_dataset.py`. Only the QLoRA
76
- adapter and the merged + converted GGUF are redistributed — the raw training data is **not** in this
77
- repository.
78
-
79
- - [`Abhishekcr448/Hinglish-Everyday-Conversations-1M`](https://huggingface.co/datasets/Abhishekcr448/Hinglish-Everyday-Conversations-1M) — 1M conversational Hinglish exchanges (primary).
80
- - [`Roshan32/Hinglish_Dataset_instruction_and_raw`](https://huggingface.co/datasets/Roshan32/Hinglish_Dataset_instruction_and_raw) — 14K persona chat (style mix).
81
- - [`BhabhaAI/Cross-Hindi-Hinglish-chat`](https://huggingface.co/datasets/BhabhaAI/Cross-Hindi-Hinglish-chat) — 1.7K Hinglish-only (script-filter).
82
-
83
- Each source dataset's own Hugging Face page lists its license; we treat the released fine-tune as a
84
- derivative of the Apache 2.0 base model and the aggregated training-data signals, and we distribute
85
- under Apache 2.0 consistent with the base. Reviewers should consult the three upstream dataset
86
- license fields before any downstream redistribution.
87
-
88
- ## Known limitations
89
-
90
- - **0.6B base-model ceiling.** Quality still trails larger base models. Short outputs (2–3 words)
91
- are the sweet spot; longer outputs are often truncated or repeated.
92
- - **Hindi-script coverage is partial.** Fine-tuned for Roman/Latin Hinglish. Devanagari Hindi
93
- inputs are passed through to the model; WriteAmp's safety filter suppresses Latin-script leakage
94
- in that direction. True Devanagari generation quality is not benchmarked here.
95
- - **Multilingual breadth is narrow.** The base Qwen3 0.6B supports EN/ES/FR/DE/PT/JA/KO/AR with
96
- varying quality; this fine-tune preserves that surface but does not improve it.
97
- - **No safety filter baked in.** The model is a continuation model; WriteAmp's app wraps it with a
98
- directive + repetition guard + script filter. Direct generation use without those guards may
99
- produce prompt echoes or low-quality output on edge prompts.
100
-
101
- ## Quality evidence
102
-
103
- Production-decoder bakeoff (`rep1.15, ngram2, maxTokens=6, branchWidth=3, directive=hinglish`,
104
- through the vendored `LlamaModelRuntime` and the existing `qwen3-v151936.acpf.bin` profile):
105
-
106
- ```
107
- SUMMARY model=hinglish-v3-q4-existing-profile n=8 p50=128ms p90=130ms empty=0 loop=0 echo=0 dev=0 ok=8
108
- ```
109
 
110
- 8/8 prompts produced usable Hinglish, zero Devanagari/CJK leakage, zero prompt echo, zero repetition
111
- loops. Cold-load p50 ≈ 128 ms, p90 ≈ 130 ms at 6 tokens — inside the existing `max` envelope.
112
 
113
- ## License & attribution
 
 
 
 
114
 
115
- This artifact is released under the **Apache License 2.0**, consistent with the base model
116
- [`Qwen/Qwen3-0.6B-Base`](https://huggingface.co/Qwen/Qwen3-0.6B-Base) (© Alibaba Cloud).
117
 
118
- Modifications from the base:
119
- - QLoRA fine-tune on aggregated Hinglish conversational data (see "Training data" above).
120
- - Merged + converted to GGUF F16 via `llama.cpp/convert_hf_to_gguf.py` (revision `b9402`).
121
- - Quantized to Q4_K_M via `llama-quantize` from the same revision.
122
 
123
- The full Apache 2.0 text is reproduced at the head of the base model's `LICENSE` file on Hugging Face
124
- and applies to this derivative work.
 
125
 
126
  ## Citation
127
 
128
  ```
129
- @misc{writeamp_hinglish_v3_2026,
130
- title = {WriteAmp-Qwen3-0.6B-Hinglish-v3: a QLoRA fine-tune of Qwen3-0.6B-Base for on-device Hinglish continuation},
131
  author = {DataDab LLP},
132
  year = {2026},
133
  url = {https://huggingface.co/datadab/writeamp-models}
 
1
  ---
2
  license: apache-2.0
 
3
  tags:
4
  - text-generation
5
+ - gguf
6
+ - smollm2
7
  - qwen3
8
  - hinglish
9
+ - mirror
 
 
 
 
 
 
 
10
  ---
11
 
12
+ # WriteAmp's on-device model catalog
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
+ This repository hosts WriteAmp's downloadable model artifacts. The catalog has three tiers
15
+ (`mini`, `midi`, `max`); two of them are mirrors of upstream Q4_K_M quantizations, one is a
16
+ custom Hinglish fine-tune.
17
 
18
+ | Tier | File | Size | SHA-256 | Source |
19
+ | --- | --- | --- | --- | --- |
20
+ | `mini` | [`mini/SmolLM2-135M.Q4_K_M.gguf`](resolve/main/mini/SmolLM2-135M.Q4_K_M.gguf?download=true) | 105,454,016 B | `127c52bae983b2d0de09c60d6292743e3239e44239bbe8ccb8cf3241513ff5a0` | Mirror of [`mradermacher/SmolLM2-135M-GGUF`](https://huggingface.co/mradermacher/SmolLM2-135M-GGUF) (Apache 2.0) |
21
+ | `midi` | [`midi/SmolLM2-360M.Q4_K_M.gguf`](resolve/main/midi/SmolLM2-360M.Q4_K_M.gguf?download=true) | 270,590,464 B | `4ac7aa712c43fe7d07ed910298b5eaab932292692954abd8e0703307724e4e04` | Mirror of [`mradermacher/SmolLM2-360M-GGUF`](https://huggingface.co/mradermacher/SmolLM2-360M-GGUF) (Apache 2.0) |
22
+ | `max` | [`WriteAmp-Qwen3-0.6B-Hinglish-v3.Q4_K_M.gguf`](resolve/main/WriteAmp-Qwen3-0.6B-Hinglish-v3.Q4_K_M.gguf?download=true) | 396,704,544 B | `98df7dd1daaf65602fa002733d5c5a32527acd174730b591235f0ed170f17185` | Custom QLoRA fine-tune of [`Qwen/Qwen3-0.6B-Base`](https://huggingface.co/Qwen/Qwen3-0.6B-Base) (Apache 2.0) |
23
 
24
+ Each tier's mirror card (under `mini/` and `midi/`) carries provenance and license details. The
25
+ `max` tier's full description, training data, and known limitations are in
26
+ [`WriteAmp-Qwen3-0.6B-Hinglish-v3.Q4_K_M.gguf`](resolve/main/WriteAmp-Qwen3-0.6B-Hinglish-v3.Q4_K_M.gguf?download=true)'s
27
+ card above.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
 
29
+ ## Mirroring policy
 
30
 
31
+ `mini` and `midi` are byte-identical mirrors of `mradermacher`'s community Q4_K_M quantizations.
32
+ The WriteAmp app's catalog keeps `mradermacher`'s URLs as the primary download path (the
33
+ community attribution is preserved), and uses this repo as a cold-start fallback when the primary
34
+ becomes unreachable or returns HTTP 404. See ADR-245 in the WriteAmp decision log for the full
35
+ rationale.
36
 
37
+ The `max` tier is hosted here as the primary (no third-party mirror). It is also the source of
38
+ truth for the `max` catalog slot.
39
 
40
+ ## License
 
 
 
41
 
42
+ All artifacts under this repo are distributed under the **Apache License 2.0**, consistent with
43
+ their upstream base models (`HuggingFaceTB/SmolLM2-135M`, `HuggingFaceTB/SmolLM2-360M`,
44
+ `Qwen/Qwen3-0.6B-Base`) and `mradermacher`'s Q4_K_M quantizations of those bases.
45
 
46
  ## Citation
47
 
48
  ```
49
+ @misc{writeamp_models_2026,
50
+ title = {WriteAmp on-device model catalog: SmolLM2 mirrors + Qwen3-0.6B Hinglish fine-tune},
51
  author = {DataDab LLP},
52
  year = {2026},
53
  url = {https://huggingface.co/datadab/writeamp-models}