nanbeige-mlx 0.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Jishnu Venugopal
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,104 @@
1
+ Metadata-Version: 2.4
2
+ Name: nanbeige-mlx
3
+ Version: 0.2.0
4
+ Summary: MLX port of the Nanbeige4.2-3B Looped Transformer for Apple Silicon — model definition, HF->MLX conversion, and publish helpers.
5
+ Author: Jishnu Venugopal
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/jishnuvenugopal/nanbeige-mlx
8
+ Project-URL: Repository, https://github.com/jishnuvenugopal/nanbeige-mlx
9
+ Project-URL: Issues, https://github.com/jishnuvenugopal/nanbeige-mlx/issues
10
+ Project-URL: Changelog, https://github.com/jishnuvenugopal/nanbeige-mlx/blob/main/CHANGELOG.md
11
+ Project-URL: Evaluation harness, https://github.com/jishnuvenugopal/nanbeige-mlx-eval
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: License :: OSI Approved :: MIT License
16
+ Classifier: Operating System :: MacOS
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
22
+ Requires-Python: >=3.10
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ License-File: LICENSE.apache
26
+ Requires-Dist: mlx<0.34,>=0.32
27
+ Requires-Dist: mlx-lm<0.33,>=0.31
28
+ Requires-Dist: huggingface_hub>=1.20
29
+ Requires-Dist: transformers>=4.40
30
+ Provides-Extra: dev
31
+ Requires-Dist: pytest>=8; extra == "dev"
32
+ Dynamic: license-file
33
+
34
+ # nanbeige-mlx
35
+
36
+ An MLX port of the **Nanbeige4.2-3B *Looped Transformer*** for Apple Silicon,
37
+ plus the HF→MLX conversion and publishing helpers. The model definition in
38
+ [`nanbeige_mlx/model.py`](nanbeige_mlx/model.py) is the **single source of truth**
39
+ for the port — it is also copied verbatim into each converted weight directory
40
+ as the `model_file` mlx-lm loads.
41
+
42
+ This is an independent project; it is not affiliated with or endorsed by the
43
+ Nanbeige team.
44
+
45
+ ## What's here
46
+
47
+ | module | purpose |
48
+ |---|---|
49
+ | `nanbeige_mlx/model.py` | the port — also the shipped `model_file` |
50
+ | `nanbeige_mlx/convert.py` | HF → MLX quant (non-mutating staging, tokenizer verify) |
51
+ | `nanbeige_mlx/upload.py` | model-card + LICENSE + NOTICE + (opt-in) HF upload |
52
+ | `nanbeige_mlx/pull.py` | `pull("4bit")` → local path for `mlx_lm.load` |
53
+
54
+ ## Load a published quant (one line)
55
+
56
+ ```python
57
+ from nanbeige_mlx import pull
58
+ import mlx_lm
59
+ model, tok = mlx_lm.load(pull("4bit"))
60
+ ```
61
+
62
+ ## Convert from the BF16 checkpoint yourself
63
+
64
+ ```bash
65
+ nanbeige-mlx-convert --src /path/to/Nanbeige4.2-3B --out ./nanbeige-mlx-4bit --bits 4
66
+ ```
67
+
68
+ The source directory is never mutated; the tokenizer round-trip is asserted.
69
+
70
+ ## The 44-slot KV cache (a real cost of the looped design)
71
+
72
+ The looped architecture needs `num_loops * num_hidden_layers = 44` KV slots.
73
+ At full context that is 44 × 8 KV-heads × 128 dim × 2 (K+V) × 262 144 positions
74
+ × 2 bytes ≈ **47 GB** — unreachable on a 16 GB machine. Because this model
75
+ supplies `make_cache`, mlx-lm's `--max-kv-size` knob is inert; use `--kv-bits`
76
+ to reduce KV precision instead. This is a quantifiable cost of the looped
77
+ design, not a bug — see `make_cache()`'s docstring.
78
+
79
+ ## Dependencies
80
+
81
+ Upper-bounded to `mlx>=0.32,<0.34` and `mlx-lm>=0.31,<0.33`. The bounds are
82
+ deliberate: `model.py` uses `mlx_lm.models.base` / `.cache` internals and is
83
+ copied verbatim into every published weight repo as the `model_file`, where it
84
+ is frozen — a user who already downloaded a quant cannot receive a patch.
85
+ Relaxing the bound is a decision to make after testing against a new mlx-lm.
86
+
87
+ ## Fidelity status
88
+
89
+ This port is validated by behaviour, not bit-parity: per-layer arithmetic
90
+ agrees with the reference's own `NanbeigeDecoderLayer` to fp32 precision, the
91
+ 44-slot loop-aware KV cache passes a prefill-vs-incremental-decode equality
92
+ test, and the port's two code paths are bit-identical. End-to-end next-token
93
+ logit cosine against the HF reference is 0.847 (top-1 agreement 83%), lower
94
+ than a faithful port should give; six candidate causes have been eliminated by
95
+ measurement. The full record — including every falsified hypothesis — is in
96
+ the evaluation harness repo's
97
+ [`docs/investigation-log.md`](https://github.com/jishnuvenugopal/nanbeige-mlx-eval/blob/main/docs/investigation-log.md).
98
+ Behaviour on the bilingual agentic suite is unaffected (26–28/30 across
99
+ 4/6/8-bit).
100
+
101
+ ## License
102
+
103
+ MIT for the code in this package. The Nanbeige model weights are governed by
104
+ the upstream Apache-2.0 license; convert and redistribute them per that license.
@@ -0,0 +1,71 @@
1
+ # nanbeige-mlx
2
+
3
+ An MLX port of the **Nanbeige4.2-3B *Looped Transformer*** for Apple Silicon,
4
+ plus the HF→MLX conversion and publishing helpers. The model definition in
5
+ [`nanbeige_mlx/model.py`](nanbeige_mlx/model.py) is the **single source of truth**
6
+ for the port — it is also copied verbatim into each converted weight directory
7
+ as the `model_file` mlx-lm loads.
8
+
9
+ This is an independent project; it is not affiliated with or endorsed by the
10
+ Nanbeige team.
11
+
12
+ ## What's here
13
+
14
+ | module | purpose |
15
+ |---|---|
16
+ | `nanbeige_mlx/model.py` | the port — also the shipped `model_file` |
17
+ | `nanbeige_mlx/convert.py` | HF → MLX quant (non-mutating staging, tokenizer verify) |
18
+ | `nanbeige_mlx/upload.py` | model-card + LICENSE + NOTICE + (opt-in) HF upload |
19
+ | `nanbeige_mlx/pull.py` | `pull("4bit")` → local path for `mlx_lm.load` |
20
+
21
+ ## Load a published quant (one line)
22
+
23
+ ```python
24
+ from nanbeige_mlx import pull
25
+ import mlx_lm
26
+ model, tok = mlx_lm.load(pull("4bit"))
27
+ ```
28
+
29
+ ## Convert from the BF16 checkpoint yourself
30
+
31
+ ```bash
32
+ nanbeige-mlx-convert --src /path/to/Nanbeige4.2-3B --out ./nanbeige-mlx-4bit --bits 4
33
+ ```
34
+
35
+ The source directory is never mutated; the tokenizer round-trip is asserted.
36
+
37
+ ## The 44-slot KV cache (a real cost of the looped design)
38
+
39
+ The looped architecture needs `num_loops * num_hidden_layers = 44` KV slots.
40
+ At full context that is 44 × 8 KV-heads × 128 dim × 2 (K+V) × 262 144 positions
41
+ × 2 bytes ≈ **47 GB** — unreachable on a 16 GB machine. Because this model
42
+ supplies `make_cache`, mlx-lm's `--max-kv-size` knob is inert; use `--kv-bits`
43
+ to reduce KV precision instead. This is a quantifiable cost of the looped
44
+ design, not a bug — see `make_cache()`'s docstring.
45
+
46
+ ## Dependencies
47
+
48
+ Upper-bounded to `mlx>=0.32,<0.34` and `mlx-lm>=0.31,<0.33`. The bounds are
49
+ deliberate: `model.py` uses `mlx_lm.models.base` / `.cache` internals and is
50
+ copied verbatim into every published weight repo as the `model_file`, where it
51
+ is frozen — a user who already downloaded a quant cannot receive a patch.
52
+ Relaxing the bound is a decision to make after testing against a new mlx-lm.
53
+
54
+ ## Fidelity status
55
+
56
+ This port is validated by behaviour, not bit-parity: per-layer arithmetic
57
+ agrees with the reference's own `NanbeigeDecoderLayer` to fp32 precision, the
58
+ 44-slot loop-aware KV cache passes a prefill-vs-incremental-decode equality
59
+ test, and the port's two code paths are bit-identical. End-to-end next-token
60
+ logit cosine against the HF reference is 0.847 (top-1 agreement 83%), lower
61
+ than a faithful port should give; six candidate causes have been eliminated by
62
+ measurement. The full record — including every falsified hypothesis — is in
63
+ the evaluation harness repo's
64
+ [`docs/investigation-log.md`](https://github.com/jishnuvenugopal/nanbeige-mlx-eval/blob/main/docs/investigation-log.md).
65
+ Behaviour on the bilingual agentic suite is unaffected (26–28/30 across
66
+ 4/6/8-bit).
67
+
68
+ ## License
69
+
70
+ MIT for the code in this package. The Nanbeige model weights are governed by
71
+ the upstream Apache-2.0 license; convert and redistribute them per that license.
@@ -0,0 +1,22 @@
1
+ """nanbeige-mlx: an MLX port of the Nanbeige4.2-3B Looped Transformer.
2
+
3
+ The model definition lives in :mod:`nanbeige_mlx.model` and is the single
4
+ source of truth — it is also copied verbatim into each converted weight
5
+ directory as the ``model_file`` mlx-lm loads. Conversion (HF -> MLX quant) is
6
+ in :mod:`nanbeige_mlx.convert`; publishing helpers in
7
+ :mod:`nanbeige_mlx.upload` and :mod:`nanbeige_mlx.pull`.
8
+ """
9
+
10
+ from __future__ import annotations
11
+
12
+ __version__ = "0.2.0"
13
+
14
+
15
+ def __getattr__(name: str): # pragma: no cover - thin convenience export
16
+ # Lazy re-export so ``from nanbeige_mlx import pull`` works without importing
17
+ # huggingface_hub at package-import time.
18
+ if name == "pull":
19
+ from .pull import pull
20
+
21
+ return pull
22
+ raise AttributeError(f"module 'nanbeige_mlx' has no attribute {name!r}")
@@ -0,0 +1,235 @@
1
+ """Convert Nanbeige4.2-3B HF weights into MLX quants.
2
+
3
+ Uses mlx-lm's ``model_file`` hook: the MLX port (``model.py``) is dropped into a
4
+ *staged copy* of the HF repo and referenced from that copy's ``config.json``, so
5
+ the standard ``mlx_lm.convert`` pipeline (load -> quantize -> save) works without
6
+ a registry entry. ``auto_map`` is stripped from the *output* config because the
7
+ MLX side loads via ``model_file``; it is left intact in the source so the HF
8
+ parity reference can still load the remote modeling code.
9
+
10
+ Two correctness properties (P3.3, P3.4 in docs/investigation-log.md):
11
+
12
+ * **Never mutate the source.** ``prepare_source`` stages a conversion-ready copy
13
+ in a temp dir, symlinks the (large) safetensors shards instead of duplicating
14
+ them, and writes the ``model_file`` config into the *copy*. Pointing ``--src``
15
+ at an HF cache snapshot is therefore safe — the snapshot's hashes are
16
+ untouched. ``to_mlx`` calls ``prepare_source`` itself and cleans up the stage,
17
+ so ``convert`` is one step and idempotent from a pristine HF download.
18
+ * **Preserve tokenizer files and verify them.** mlx-lm's convert writes a
19
+ trimmed ``tokenizer_config.json`` and drops ``added_tokens.json`` /
20
+ ``special_tokens_map.json`` / ``tokenizer.model``. We copy those through,
21
+ drop transient init keys, restore ``model_max_length``, and assert the
22
+ tokenizer round-trips the EOS token before declaring success.
23
+ """
24
+
25
+ from __future__ import annotations
26
+
27
+ import json
28
+ import shutil
29
+ import tempfile
30
+ from pathlib import Path
31
+
32
+ from mlx_lm.convert import convert
33
+
34
+ # The single source of truth for the port. Copied verbatim into each staged
35
+ # (and therefore each converted) weight repo as the shipped ``model_file``.
36
+ PORT_FILE = Path(__file__).resolve().parent / "model.py"
37
+
38
+ # Tokenizer / template files mlx-lm's convert trims that we must carry through.
39
+ CARRY = [
40
+ "added_tokens.json",
41
+ "special_tokens_map.json",
42
+ "tokenizer.model",
43
+ "chat_template.jinja",
44
+ ]
45
+
46
+ # Transient keys mlx-lm leaks into tokenizer_config.json from
47
+ # tokenizer.init_kwargs; they don't belong in a published config.
48
+ _TRANSIENT_TOKENIZER_KEYS = ("is_local", "local_files_only", "backend")
49
+
50
+ # HF ``trust_remote_code`` files that the source repo carries for the PyTorch
51
+ # reference path. They must NOT ship in an MLX repo (which loads via
52
+ # ``model_file``), so remove them from the output after convert.
53
+ _STRIP_FROM_OUTPUT = {
54
+ "configuration_nanbeige.py",
55
+ "modeling_nanbeige.py",
56
+ }
57
+
58
+ # Nanbeige4.2-3B supports 256K context; mlx-lm's convert writes the int64
59
+ # sentinel instead of this concrete value. Restore it.
60
+ MODEL_MAX_LENGTH = 262144
61
+
62
+ # EOS token the model must be able to emit to ever stop generating.
63
+ EOS_TOKEN = "<|im_end|>"
64
+ EOS_TOKEN_ID = 166101
65
+
66
+
67
+ def prepare_source(
68
+ src_dir: str | Path,
69
+ model_file: str | Path = PORT_FILE,
70
+ workdir: str | Path | None = None,
71
+ ) -> Path:
72
+ """Stage a conversion-ready copy of ``src_dir``. **Never writes into ``src_dir``**.
73
+
74
+ Non-safetensor files are copied; ``*.safetensors`` shards are *symlinked*
75
+ (not duplicated — the BF16 checkpoint is ~8 GB). The port is copied in as
76
+ ``nanbeige.py`` and ``config.json["model_file"]`` is set on the *copy*.
77
+
78
+ Returns the stage directory. The caller is responsible for cleanup if they
79
+ don't go through :func:`to_mlx` (which handles it).
80
+ """
81
+ src = Path(src_dir)
82
+ if not src.is_dir():
83
+ raise FileNotFoundError(f"source repo not found: {src}")
84
+
85
+ stage = Path(workdir) if workdir else Path(
86
+ tempfile.mkdtemp(prefix="nanbeige-stage-")
87
+ )
88
+ stage.mkdir(parents=True, exist_ok=True)
89
+
90
+ # Copy small files verbatim.
91
+ for f in src.iterdir():
92
+ if f.is_file() and f.suffix != ".safetensors":
93
+ shutil.copy2(f, stage / f.name)
94
+
95
+ # Symlink the weight shards — don't duplicate ~8 GB.
96
+ for f in src.glob("*.safetensors"):
97
+ (stage / f.name).symlink_to(f.resolve())
98
+
99
+ # Drop in the port and wire up model_file on the staged config copy.
100
+ shutil.copy2(model_file, stage / "nanbeige.py")
101
+ cfg_path = stage / "config.json"
102
+ cfg = json.loads(cfg_path.read_text(encoding="utf-8"))
103
+ cfg["model_file"] = "nanbeige.py"
104
+ cfg_path.write_text(json.dumps(cfg, indent=2, ensure_ascii=False), encoding="utf-8")
105
+
106
+ return stage
107
+
108
+
109
+ def _finalize(src: Path, out: Path) -> None:
110
+ """Carry tokenizer files through, scrub transient keys, restore max length.
111
+
112
+ Idempotent: only copies a CARRY file when the output is missing it.
113
+ """
114
+ for name in CARRY:
115
+ if (src / name).exists() and not (out / name).exists():
116
+ shutil.copy2(src / name, out / name)
117
+
118
+ tc = out / "tokenizer_config.json"
119
+ if tc.exists():
120
+ cfg = json.loads(tc.read_text(encoding="utf-8"))
121
+ for k in _TRANSIENT_TOKENIZER_KEYS:
122
+ cfg.pop(k, None)
123
+ cfg["model_max_length"] = MODEL_MAX_LENGTH
124
+ tc.write_text(json.dumps(cfg, indent=2, ensure_ascii=False), encoding="utf-8")
125
+
126
+ # Strip HF trust_remote_code files the convert step may have copied through;
127
+ # the MLX repo loads via model_file and shouldn't ship the PyTorch reference.
128
+ for name in _STRIP_FROM_OUTPUT:
129
+ p = out / name
130
+ if p.exists():
131
+ p.unlink()
132
+
133
+
134
+ def verify(out_dir: str | Path) -> None:
135
+ """Assert the converted repo's tokenizer round-trips the EOS token.
136
+
137
+ A conversion that silently loses ``<|im_end|>`` produces a model that never
138
+ stops generating — cheap to assert, expensive to debug.
139
+ """
140
+ from transformers import AutoTokenizer # type: ignore
141
+
142
+ out = Path(out_dir)
143
+ tok = AutoTokenizer.from_pretrained(str(out), trust_remote_code=False)
144
+ got = tok.convert_tokens_to_ids(EOS_TOKEN)
145
+ assert got == EOS_TOKEN_ID, (
146
+ f"EOS token lost in conversion: {EOS_TOKEN!r} -> {got} (expected {EOS_TOKEN_ID})"
147
+ )
148
+ # ``eos_token_id`` may be stored as a string in some tokenizer configs.
149
+ assert int(tok.eos_token_id) == EOS_TOKEN_ID, (
150
+ f"tokenizer.eos_token_id={tok.eos_token_id} != {EOS_TOKEN_ID}"
151
+ )
152
+ rendered = tok.apply_chat_template(
153
+ [{"role": "user", "content": "hi"}],
154
+ tokenize=False,
155
+ add_generation_prompt=True,
156
+ )
157
+ assert "<|im_start|>assistant" in rendered, "chat template missing assistant marker"
158
+ assert "<think>" in rendered, "chat template missing the reasoning (<think>) block"
159
+
160
+
161
+ def to_mlx(
162
+ src_dir: str | Path,
163
+ out_dir: str | Path,
164
+ bits: int,
165
+ group_size: int = 64,
166
+ *,
167
+ skip_verify: bool = False,
168
+ ) -> Path:
169
+ """Convert ``src_dir`` to a quantized MLX repo at ``out_dir`` (``bits`` per weight).
170
+
171
+ Stages a non-mutating copy (P3.3), runs mlx-lm's convert, strips
172
+ ``auto_map`` from the output config, carries tokenizer files through and
173
+ verifies the round-trip (P3.4). The stage dir is always cleaned up.
174
+ """
175
+ src = Path(src_dir)
176
+ out = Path(out_dir)
177
+
178
+ stage = prepare_source(src)
179
+ try:
180
+ convert(
181
+ hf_path=str(stage),
182
+ mlx_path=str(out),
183
+ quantize=True,
184
+ q_group_size=group_size,
185
+ q_bits=bits,
186
+ )
187
+ finally:
188
+ shutil.rmtree(stage, ignore_errors=True)
189
+
190
+ # Strip auto_map from the output config: MLX loads via model_file, and
191
+ # leaving auto_map triggers an irrelevant trust_remote_code prompt on load.
192
+ cfg_path = out / "config.json"
193
+ cfg = json.loads(cfg_path.read_text(encoding="utf-8"))
194
+ cfg.pop("auto_map", None)
195
+ cfg_path.write_text(json.dumps(cfg, indent=2, ensure_ascii=False), encoding="utf-8")
196
+
197
+ _finalize(src, out)
198
+
199
+ if not skip_verify:
200
+ try:
201
+ verify(out)
202
+ print(
203
+ f"PASS: tokenizer round-trips {EOS_TOKEN!r} -> {EOS_TOKEN_ID}; "
204
+ f"chat template intact."
205
+ )
206
+ except Exception as exc: # pragma: no cover - surfaces as a hard error
207
+ print(f"VERIFY FAILED: {exc}")
208
+ raise
209
+
210
+ return out
211
+
212
+
213
+ def main(argv: list[str] | None = None) -> None: # pragma: no cover
214
+ import argparse
215
+
216
+ ap = argparse.ArgumentParser(
217
+ prog="nanbeige-mlx-convert",
218
+ description="Convert Nanbeige4.2-3B HF weights to a quantized MLX repo.",
219
+ )
220
+ ap.add_argument("--src", required=True, help="local Nanbeige HF repo (left untouched)")
221
+ ap.add_argument("--out", required=True, help="output MLX repo path")
222
+ ap.add_argument("--bits", type=int, required=True, help="quantization bits (4, 6, 8)")
223
+ ap.add_argument("--group-size", type=int, default=64)
224
+ ap.add_argument(
225
+ "--skip-verify",
226
+ action="store_true",
227
+ help="skip the post-convert tokenizer round-trip assertion",
228
+ )
229
+ a = ap.parse_args(argv)
230
+ to_mlx(a.src, a.out, a.bits, a.group_size, skip_verify=a.skip_verify)
231
+ print(a.out)
232
+
233
+
234
+ if __name__ == "__main__": # pragma: no cover
235
+ main()