mlx-chronos 0.1.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.
- mlx_chronos-0.1.0/LICENSE +201 -0
- mlx_chronos-0.1.0/PKG-INFO +193 -0
- mlx_chronos-0.1.0/README.md +164 -0
- mlx_chronos-0.1.0/mlx_chronos/__init__.py +18 -0
- mlx_chronos-0.1.0/mlx_chronos/benchmark.py +423 -0
- mlx_chronos-0.1.0/mlx_chronos/cli.py +240 -0
- mlx_chronos-0.1.0/mlx_chronos/constants.py +30 -0
- mlx_chronos-0.1.0/mlx_chronos/detect.py +153 -0
- mlx_chronos-0.1.0/mlx_chronos/engines.py +645 -0
- mlx_chronos-0.1.0/mlx_chronos/reporters.py +131 -0
- mlx_chronos-0.1.0/mlx_chronos/schema.py +285 -0
- mlx_chronos-0.1.0/mlx_chronos.egg-info/PKG-INFO +193 -0
- mlx_chronos-0.1.0/mlx_chronos.egg-info/SOURCES.txt +23 -0
- mlx_chronos-0.1.0/mlx_chronos.egg-info/dependency_links.txt +1 -0
- mlx_chronos-0.1.0/mlx_chronos.egg-info/entry_points.txt +2 -0
- mlx_chronos-0.1.0/mlx_chronos.egg-info/requires.txt +6 -0
- mlx_chronos-0.1.0/mlx_chronos.egg-info/top_level.txt +1 -0
- mlx_chronos-0.1.0/pyproject.toml +58 -0
- mlx_chronos-0.1.0/setup.cfg +4 -0
- mlx_chronos-0.1.0/tests/test_benchmark.py +155 -0
- mlx_chronos-0.1.0/tests/test_cli.py +168 -0
- mlx_chronos-0.1.0/tests/test_detect.py +60 -0
- mlx_chronos-0.1.0/tests/test_engines.py +314 -0
- mlx_chronos-0.1.0/tests/test_reporters.py +62 -0
- mlx_chronos-0.1.0/tests/test_schema.py +152 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [2026] [Igor Pastore]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mlx-chronos
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Benchmark suite and community leaderboard for local LLM inference on Apple Silicon
|
|
5
|
+
Author-email: Igor Pastore <182094468+igurss@users.noreply.github.com>
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://igurss.github.io/mlx-chronos
|
|
8
|
+
Project-URL: Repository, https://github.com/igurss/mlx-chronos
|
|
9
|
+
Project-URL: Issues, https://github.com/igurss/mlx-chronos/issues
|
|
10
|
+
Project-URL: Changelog, https://github.com/igurss/mlx-chronos/blob/main/CHANGELOG.md
|
|
11
|
+
Keywords: apple-silicon,benchmark,inference,llm,mlx
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Operating System :: MacOS
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
20
|
+
Requires-Python: >=3.10
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Requires-Dist: httpx>=0.24.0
|
|
24
|
+
Requires-Dist: psutil>=5.9.0
|
|
25
|
+
Requires-Dist: pydantic>=2.0
|
|
26
|
+
Provides-Extra: test
|
|
27
|
+
Requires-Dist: pytest>=7.0; extra == "test"
|
|
28
|
+
Dynamic: license-file
|
|
29
|
+
|
|
30
|
+
# mlx-Chronos ⏱️
|
|
31
|
+
|
|
32
|
+
> Benchmark suite and community leaderboard for local LLM inference on Apple Silicon.
|
|
33
|
+
> Run it. Share your results. Compare across hardware.
|
|
34
|
+
|
|
35
|
+
[](https://github.com/igurss/mlx-chronos/blob/main/LICENSE)
|
|
36
|
+
[](https://python.org)
|
|
37
|
+
[](https://apple.com)
|
|
38
|
+
[](https://github.com/igurss/mlx-chronos/blob/main/CONTRIBUTING.md)
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## What is mlx-Chronos?
|
|
43
|
+
|
|
44
|
+
mlx-Chronos is a standardized benchmarking tool for local LLM inference engines
|
|
45
|
+
on Apple Silicon. It automatically detects your hardware, runs a consistent set
|
|
46
|
+
of tests across installed engines, and produces a structured JSON result you can
|
|
47
|
+
contribute to the community leaderboard.
|
|
48
|
+
|
|
49
|
+
**Supported engines:**
|
|
50
|
+
- [Ollama](https://github.com/ollama/ollama) (MLX backend)
|
|
51
|
+
- [oMLX](https://github.com/jundot/omlx)
|
|
52
|
+
- [Rapid-MLX](https://github.com/raullenchai/Rapid-MLX)
|
|
53
|
+
- [mlx-lm (Apple MLX)](https://github.com/ml-explore/mlx-lm)
|
|
54
|
+
|
|
55
|
+
**Metrics measured:**
|
|
56
|
+
- **TTFT** — Time to First Token (cold and cached, with statistics)
|
|
57
|
+
- **tok/s** — Generation throughput (mean, stddev, min, max across trials)
|
|
58
|
+
- **Engine RSS** — Peak RSS of the engine server process during the benchmark when available
|
|
59
|
+
- **System RAM peak** — Peak total Mac RAM in use during the benchmark
|
|
60
|
+
- **Tool calling** — Success rate *(coming in v0.2)*
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## How It Works
|
|
65
|
+
|
|
66
|
+
When you run mlx-Chronos, it executes a fixed benchmark protocol against the
|
|
67
|
+
running engine:
|
|
68
|
+
|
|
69
|
+
**Cold TTFT** — sends a prompt to the model and measures the time from request
|
|
70
|
+
to first non-empty streamed token, including whitespace-only text tokens. Each
|
|
71
|
+
trial uses a unique prompt to avoid cache hits.
|
|
72
|
+
|
|
73
|
+
**Cached TTFT** — sends the same fixed prompt on every cached trial. A priming
|
|
74
|
+
call loads it into cache first, then cached trials run consecutively. This
|
|
75
|
+
measures cache performance without interleaving unrelated prompts between
|
|
76
|
+
cached measurements.
|
|
77
|
+
|
|
78
|
+
**Throughput (tok/s)** — measures tokens generated per second using a standard
|
|
79
|
+
fixed prompt, identical across all engines and versions.
|
|
80
|
+
|
|
81
|
+
**Peak engine RSS** — measures the resident memory of the engine server process
|
|
82
|
+
after warmup, through the recorded benchmark phases. This is
|
|
83
|
+
intentionally not the total memory occupied by the loaded model or by
|
|
84
|
+
macOS/Metal unified memory. It is meant to compare how light or heavy each
|
|
85
|
+
engine process is while serving the same model. The default RSS sampling
|
|
86
|
+
interval is 50ms and can be changed with `--ram-sample-interval`.
|
|
87
|
+
|
|
88
|
+
**System RAM peak** — continuously samples total Mac RAM usage from before
|
|
89
|
+
warmup through the recorded benchmark phases and reports the observed peak in
|
|
90
|
+
GB and percent. This is the metric to use when checking whether a run pushed
|
|
91
|
+
the machine into memory pressure or swap while the model was actually loading
|
|
92
|
+
or serving requests.
|
|
93
|
+
|
|
94
|
+
All metrics are run over multiple trials and reported with mean, stddev, min,
|
|
95
|
+
and max. The default is 5 trials, with a maximum of 8 unique cold prompts.
|
|
96
|
+
Results are saved as structured JSON in `results/local/` by default. Copy a
|
|
97
|
+
reviewed JSON into `results/submitted/` only when you want to publish it to the
|
|
98
|
+
community leaderboard.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Community Leaderboard
|
|
103
|
+
|
|
104
|
+
View the full leaderboard with all submitted results:
|
|
105
|
+
|
|
106
|
+
**[→ igurss.github.io/mlx-chronos](https://igurss.github.io/mlx-chronos)**
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## Quick Start
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
# Install
|
|
114
|
+
pip install mlx-chronos
|
|
115
|
+
|
|
116
|
+
# Check available engines
|
|
117
|
+
mlx-chronos engines
|
|
118
|
+
|
|
119
|
+
# Validate setup before a run
|
|
120
|
+
mlx-chronos validate --engine omlx --model "Qwen3.5-4B-OptiQ-4bit"
|
|
121
|
+
|
|
122
|
+
# Run benchmark (JSON by default)
|
|
123
|
+
mlx-chronos run --engine omlx --model "Qwen3.5-4B-OptiQ-4bit"
|
|
124
|
+
|
|
125
|
+
# Optional: write both JSON and Markdown outputs
|
|
126
|
+
mlx-chronos run --engine omlx --model "Qwen3.5-4B-OptiQ-4bit" --format all
|
|
127
|
+
|
|
128
|
+
# Optional: choose a custom output directory
|
|
129
|
+
mlx-chronos run --engine omlx --model "Qwen3.5-4B-OptiQ-4bit" --output-dir ~/Desktop/benchmarks
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
> **Note:** the engine server must be running before you launch mlx-chronos.
|
|
133
|
+
> See [CONTRIBUTING.md](https://github.com/igurss/mlx-chronos/blob/main/CONTRIBUTING.md) for setup instructions.
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## Contributing Your Results
|
|
138
|
+
|
|
139
|
+
1. Run `mlx-chronos run` on your Mac
|
|
140
|
+
2. A JSON file is generated in `results/local/` (use `--format all` for a Markdown summary too)
|
|
141
|
+
3. Fork this repo and copy the JSON you want to publish into `results/submitted/`
|
|
142
|
+
4. GitHub Actions validates your result automatically
|
|
143
|
+
5. Once merged, the leaderboard updates
|
|
144
|
+
|
|
145
|
+
Leaderboard submissions must report throughput using the engine response's
|
|
146
|
+
`usage.completion_tokens`. Local runs can still be saved with a fallback token
|
|
147
|
+
estimate, but those results are not accepted for the public leaderboard.
|
|
148
|
+
|
|
149
|
+
See [CONTRIBUTING.md](https://github.com/igurss/mlx-chronos/blob/main/CONTRIBUTING.md) for detailed instructions.
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## Benchmark Methodology
|
|
154
|
+
|
|
155
|
+
See [docs/methodology.md](https://github.com/igurss/mlx-chronos/blob/main/docs/methodology.md) for a full explanation of what
|
|
156
|
+
is measured, how, and why.
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
## Roadmap
|
|
161
|
+
|
|
162
|
+
### Completed
|
|
163
|
+
- [x] Core benchmark runner with repeated trials, warmup, cache priming, and phase-separated metrics
|
|
164
|
+
- [x] Engine support for oMLX, Rapid-MLX, mlx-lm, and Ollama
|
|
165
|
+
- [x] Hardware detection for chip, machine model, memory, macOS, Python, architecture, and thermal state
|
|
166
|
+
- [x] Strict JSON schema validation with raw-trial consistency checks
|
|
167
|
+
- [x] Continuous engine RSS and system RAM peak sampling
|
|
168
|
+
- [x] Preflight validation for engine, server, and model access
|
|
169
|
+
- [x] GitHub Actions validation for submitted results
|
|
170
|
+
- [x] GitHub Pages leaderboard with engine/chip filters
|
|
171
|
+
- [x] JSON and Markdown result export
|
|
172
|
+
- [x] Published Apple M2 sample results refreshed with the current benchmark protocol
|
|
173
|
+
|
|
174
|
+
### Next
|
|
175
|
+
- [ ] Add `mlx-chronos submit` to help prepare leaderboard submissions
|
|
176
|
+
- [ ] Add warnings for battery mode, low power mode, and non-nominal thermal state
|
|
177
|
+
- [ ] Improve leaderboard filtering by machine model and add broader column tooltips
|
|
178
|
+
- [ ] Add integration tests against mock OpenAI-compatible servers
|
|
179
|
+
|
|
180
|
+
### Future
|
|
181
|
+
- [ ] Support larger trial counts with a bigger cold-prompt pool
|
|
182
|
+
- [ ] Add p95 reporting for larger sample sizes
|
|
183
|
+
- [ ] Evaluate a clearer TTFT naming model without breaking the v0.1 JSON contract
|
|
184
|
+
- [ ] Add tool-calling success-rate benchmarks
|
|
185
|
+
- [ ] Explore anti-spoofing checks for community submissions
|
|
186
|
+
- [ ] Document external contributor branch workflow when community PRs start arriving
|
|
187
|
+
- [ ] Collect more results from M3, M4, and M5 systems
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
191
|
+
## License
|
|
192
|
+
|
|
193
|
+
Apache 2.0 — see [LICENSE](https://github.com/igurss/mlx-chronos/blob/main/LICENSE)
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# mlx-Chronos ⏱️
|
|
2
|
+
|
|
3
|
+
> Benchmark suite and community leaderboard for local LLM inference on Apple Silicon.
|
|
4
|
+
> Run it. Share your results. Compare across hardware.
|
|
5
|
+
|
|
6
|
+
[](https://github.com/igurss/mlx-chronos/blob/main/LICENSE)
|
|
7
|
+
[](https://python.org)
|
|
8
|
+
[](https://apple.com)
|
|
9
|
+
[](https://github.com/igurss/mlx-chronos/blob/main/CONTRIBUTING.md)
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## What is mlx-Chronos?
|
|
14
|
+
|
|
15
|
+
mlx-Chronos is a standardized benchmarking tool for local LLM inference engines
|
|
16
|
+
on Apple Silicon. It automatically detects your hardware, runs a consistent set
|
|
17
|
+
of tests across installed engines, and produces a structured JSON result you can
|
|
18
|
+
contribute to the community leaderboard.
|
|
19
|
+
|
|
20
|
+
**Supported engines:**
|
|
21
|
+
- [Ollama](https://github.com/ollama/ollama) (MLX backend)
|
|
22
|
+
- [oMLX](https://github.com/jundot/omlx)
|
|
23
|
+
- [Rapid-MLX](https://github.com/raullenchai/Rapid-MLX)
|
|
24
|
+
- [mlx-lm (Apple MLX)](https://github.com/ml-explore/mlx-lm)
|
|
25
|
+
|
|
26
|
+
**Metrics measured:**
|
|
27
|
+
- **TTFT** — Time to First Token (cold and cached, with statistics)
|
|
28
|
+
- **tok/s** — Generation throughput (mean, stddev, min, max across trials)
|
|
29
|
+
- **Engine RSS** — Peak RSS of the engine server process during the benchmark when available
|
|
30
|
+
- **System RAM peak** — Peak total Mac RAM in use during the benchmark
|
|
31
|
+
- **Tool calling** — Success rate *(coming in v0.2)*
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## How It Works
|
|
36
|
+
|
|
37
|
+
When you run mlx-Chronos, it executes a fixed benchmark protocol against the
|
|
38
|
+
running engine:
|
|
39
|
+
|
|
40
|
+
**Cold TTFT** — sends a prompt to the model and measures the time from request
|
|
41
|
+
to first non-empty streamed token, including whitespace-only text tokens. Each
|
|
42
|
+
trial uses a unique prompt to avoid cache hits.
|
|
43
|
+
|
|
44
|
+
**Cached TTFT** — sends the same fixed prompt on every cached trial. A priming
|
|
45
|
+
call loads it into cache first, then cached trials run consecutively. This
|
|
46
|
+
measures cache performance without interleaving unrelated prompts between
|
|
47
|
+
cached measurements.
|
|
48
|
+
|
|
49
|
+
**Throughput (tok/s)** — measures tokens generated per second using a standard
|
|
50
|
+
fixed prompt, identical across all engines and versions.
|
|
51
|
+
|
|
52
|
+
**Peak engine RSS** — measures the resident memory of the engine server process
|
|
53
|
+
after warmup, through the recorded benchmark phases. This is
|
|
54
|
+
intentionally not the total memory occupied by the loaded model or by
|
|
55
|
+
macOS/Metal unified memory. It is meant to compare how light or heavy each
|
|
56
|
+
engine process is while serving the same model. The default RSS sampling
|
|
57
|
+
interval is 50ms and can be changed with `--ram-sample-interval`.
|
|
58
|
+
|
|
59
|
+
**System RAM peak** — continuously samples total Mac RAM usage from before
|
|
60
|
+
warmup through the recorded benchmark phases and reports the observed peak in
|
|
61
|
+
GB and percent. This is the metric to use when checking whether a run pushed
|
|
62
|
+
the machine into memory pressure or swap while the model was actually loading
|
|
63
|
+
or serving requests.
|
|
64
|
+
|
|
65
|
+
All metrics are run over multiple trials and reported with mean, stddev, min,
|
|
66
|
+
and max. The default is 5 trials, with a maximum of 8 unique cold prompts.
|
|
67
|
+
Results are saved as structured JSON in `results/local/` by default. Copy a
|
|
68
|
+
reviewed JSON into `results/submitted/` only when you want to publish it to the
|
|
69
|
+
community leaderboard.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Community Leaderboard
|
|
74
|
+
|
|
75
|
+
View the full leaderboard with all submitted results:
|
|
76
|
+
|
|
77
|
+
**[→ igurss.github.io/mlx-chronos](https://igurss.github.io/mlx-chronos)**
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Quick Start
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
# Install
|
|
85
|
+
pip install mlx-chronos
|
|
86
|
+
|
|
87
|
+
# Check available engines
|
|
88
|
+
mlx-chronos engines
|
|
89
|
+
|
|
90
|
+
# Validate setup before a run
|
|
91
|
+
mlx-chronos validate --engine omlx --model "Qwen3.5-4B-OptiQ-4bit"
|
|
92
|
+
|
|
93
|
+
# Run benchmark (JSON by default)
|
|
94
|
+
mlx-chronos run --engine omlx --model "Qwen3.5-4B-OptiQ-4bit"
|
|
95
|
+
|
|
96
|
+
# Optional: write both JSON and Markdown outputs
|
|
97
|
+
mlx-chronos run --engine omlx --model "Qwen3.5-4B-OptiQ-4bit" --format all
|
|
98
|
+
|
|
99
|
+
# Optional: choose a custom output directory
|
|
100
|
+
mlx-chronos run --engine omlx --model "Qwen3.5-4B-OptiQ-4bit" --output-dir ~/Desktop/benchmarks
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
> **Note:** the engine server must be running before you launch mlx-chronos.
|
|
104
|
+
> See [CONTRIBUTING.md](https://github.com/igurss/mlx-chronos/blob/main/CONTRIBUTING.md) for setup instructions.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## Contributing Your Results
|
|
109
|
+
|
|
110
|
+
1. Run `mlx-chronos run` on your Mac
|
|
111
|
+
2. A JSON file is generated in `results/local/` (use `--format all` for a Markdown summary too)
|
|
112
|
+
3. Fork this repo and copy the JSON you want to publish into `results/submitted/`
|
|
113
|
+
4. GitHub Actions validates your result automatically
|
|
114
|
+
5. Once merged, the leaderboard updates
|
|
115
|
+
|
|
116
|
+
Leaderboard submissions must report throughput using the engine response's
|
|
117
|
+
`usage.completion_tokens`. Local runs can still be saved with a fallback token
|
|
118
|
+
estimate, but those results are not accepted for the public leaderboard.
|
|
119
|
+
|
|
120
|
+
See [CONTRIBUTING.md](https://github.com/igurss/mlx-chronos/blob/main/CONTRIBUTING.md) for detailed instructions.
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## Benchmark Methodology
|
|
125
|
+
|
|
126
|
+
See [docs/methodology.md](https://github.com/igurss/mlx-chronos/blob/main/docs/methodology.md) for a full explanation of what
|
|
127
|
+
is measured, how, and why.
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## Roadmap
|
|
132
|
+
|
|
133
|
+
### Completed
|
|
134
|
+
- [x] Core benchmark runner with repeated trials, warmup, cache priming, and phase-separated metrics
|
|
135
|
+
- [x] Engine support for oMLX, Rapid-MLX, mlx-lm, and Ollama
|
|
136
|
+
- [x] Hardware detection for chip, machine model, memory, macOS, Python, architecture, and thermal state
|
|
137
|
+
- [x] Strict JSON schema validation with raw-trial consistency checks
|
|
138
|
+
- [x] Continuous engine RSS and system RAM peak sampling
|
|
139
|
+
- [x] Preflight validation for engine, server, and model access
|
|
140
|
+
- [x] GitHub Actions validation for submitted results
|
|
141
|
+
- [x] GitHub Pages leaderboard with engine/chip filters
|
|
142
|
+
- [x] JSON and Markdown result export
|
|
143
|
+
- [x] Published Apple M2 sample results refreshed with the current benchmark protocol
|
|
144
|
+
|
|
145
|
+
### Next
|
|
146
|
+
- [ ] Add `mlx-chronos submit` to help prepare leaderboard submissions
|
|
147
|
+
- [ ] Add warnings for battery mode, low power mode, and non-nominal thermal state
|
|
148
|
+
- [ ] Improve leaderboard filtering by machine model and add broader column tooltips
|
|
149
|
+
- [ ] Add integration tests against mock OpenAI-compatible servers
|
|
150
|
+
|
|
151
|
+
### Future
|
|
152
|
+
- [ ] Support larger trial counts with a bigger cold-prompt pool
|
|
153
|
+
- [ ] Add p95 reporting for larger sample sizes
|
|
154
|
+
- [ ] Evaluate a clearer TTFT naming model without breaking the v0.1 JSON contract
|
|
155
|
+
- [ ] Add tool-calling success-rate benchmarks
|
|
156
|
+
- [ ] Explore anti-spoofing checks for community submissions
|
|
157
|
+
- [ ] Document external contributor branch workflow when community PRs start arriving
|
|
158
|
+
- [ ] Collect more results from M3, M4, and M5 systems
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## License
|
|
163
|
+
|
|
164
|
+
Apache 2.0 — see [LICENSE](https://github.com/igurss/mlx-chronos/blob/main/LICENSE)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"""mlx-chronos: Benchmark suite and community leaderboard for local LLM inference on Apple Silicon."""
|
|
2
|
+
|
|
3
|
+
from importlib.metadata import PackageNotFoundError, version
|
|
4
|
+
|
|
5
|
+
try:
|
|
6
|
+
__version__ = version("mlx-chronos")
|
|
7
|
+
except PackageNotFoundError:
|
|
8
|
+
__version__ = "0.1.0"
|
|
9
|
+
|
|
10
|
+
__all__ = ["__version__", "run_benchmark"]
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
def __getattr__(name: str):
|
|
14
|
+
if name == "run_benchmark":
|
|
15
|
+
from .benchmark import run_benchmark
|
|
16
|
+
|
|
17
|
+
return run_benchmark
|
|
18
|
+
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|