mlx-model-doctor 0.1.0__tar.gz

mlx_model_doctor-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,68 @@
+name: CI
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install uv
+        run: pip install uv
+      - name: Sync
+        run: uv sync --group lint
+      - name: Ruff check
+        run: uv run ruff check .
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install uv
+        run: pip install uv
+      - name: Sync
+        run: uv sync --group typecheck
+      - name: Mypy
+        run: uv run mypy
+
+  test:
+    # The default suite is pure Python — static repo checks + fakes. The MLX /
+    # smoke / gpu / network tests are gated out below, so it runs on Linux.
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install uv
+        run: pip install uv
+      - name: Sync (test group only — keep CI light)
+        run: uv sync --group test
+      - name: Run tests
+        run: |
+          uv run pytest \
+            --cov=mlx_model_doctor \
+            --cov-report=term-missing \
+            --cov-fail-under=85 \
+            -m "not benchmark and not network and not gpu and not smoke"

mlx_model_doctor-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+# .github/workflows/release.yml
+name: Release
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: hynek/build-and-inspect-python-package@v2
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v3
+        with:
+          files: dist/*
+          generate_release_notes: true
+          draft: false
+          # Tags containing a hyphen (e.g. v0.1.0-alpha) are marked prerelease.
+          prerelease: ${{ contains(github.ref_name, '-') }}

mlx_model_doctor-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+.codegraph/
+.hypothesis/
+
+# Workspace working-state must never live inside the repo (mac/ convention) —
+# specs/plans/reviews and the granular backlog live at the workspace root.
+docs/superpowers/
+docs/backlog/
+
+.coverage
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.venv/
+__pycache__/
+build/
+dist/
+*.egg-info/
+src/mlx_model_doctor/_version.py

mlx_model_doctor-0.1.0/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] — 2026-06-04
+
+Initial public release.
+
+### Added
+- Static validation for local model repositories (`check local <path>` /
+  `check_local_model`): config presence and consistency, tokenizer files and
+  special tokens, safetensors-index integrity, quantization metadata, and a
+  context-length-aware memory-budget estimate. The static checks read repository
+  metadata only — no MLX or GPU, and no weight download.
+- Hugging Face target (`check hf <repo_id>` / `check_hf_model`): the same checks
+  against a Hub repository, reading metadata over `huggingface-hub`. Auth,
+  not-found, and rate-limit failures surface as a clear tool error.
+- `sample hf`: survey an author's likely-MLX repositories and validate a
+  deterministic sample as a batch report. A per-model error is recorded as a
+  batch item and the run continues; a listing failure is a tool error.
+- Optional memory-safe `mlx-lm` smoke check (`--smoke`, `mlx-lm` extra): loads
+  the model under an MLX wired-memory cap and refuses to load if the cap cannot
+  be installed, so a smoke run can't push the machine into a memory panic.
+- Reports render to text, JSON, and Markdown; results are frozen dataclasses, so
+  output is stable to diff. Exit codes: `0` pass, `1` fail-under-policy,
+  `2` tool error or zero checks — tunable with `--fail-on`.
+- `version`, `man`, and `plugins` commands; the built-in `text` plugin; a
+  `py.typed` marker.

mlx_model_doctor-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file type. We recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Denis Ineshin
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mlx_model_doctor-0.1.0/NOTICE

@@ -0,0 +1,8 @@
+mlx-model-doctor
+Copyright 2026 Denis Ineshin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0

mlx_model_doctor-0.1.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: mlx-model-doctor
+Version: 0.1.0
+Summary: Validate MLX model repositories before loading them.
+Project-URL: Homepage, https://github.com/IonDen/mlx-model-doctor
+Project-URL: Source, https://github.com/IonDen/mlx-model-doctor
+Project-URL: Issues, https://github.com/IonDen/mlx-model-doctor/issues
+Project-URL: Changelog, https://github.com/IonDen/mlx-model-doctor/blob/master/CHANGELOG.md
+Project-URL: Roadmap, https://github.com/IonDen/mlx-model-doctor/blob/master/ROADMAP.md
+Author-email: Denis Ineshin <denis.ineshin@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: apple-silicon,huggingface,mlx,mlx-lm,model-validation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: huggingface-hub>=0.24
+Requires-Dist: safetensors>=0.4
+Provides-Extra: mlx-lm
+Requires-Dist: mlx-lm>=0.31.3; extra == 'mlx-lm'
+Description-Content-Type: text/markdown
+
+# mlx-model-doctor
+
+[![PyPI version](https://img.shields.io/pypi/v/mlx-model-doctor.svg)](https://pypi.org/project/mlx-model-doctor/)
+[![Python versions](https://img.shields.io/pypi/pyversions/mlx-model-doctor.svg)](https://pypi.org/project/mlx-model-doctor/)
+[![License: Apache 2.0](https://img.shields.io/pypi/l/mlx-model-doctor.svg)](https://github.com/IonDen/mlx-model-doctor/blob/master/LICENSE)
+
+Validate an MLX / Hugging Face model repository before you load it.
+
+A model repo can be broken in ways you only discover halfway through `load()`: a `config.json` that disagrees with the weights, a missing tokenizer file, a `model.safetensors.index.json` that points at shards that aren't there, quantization metadata that doesn't match the tensors, or a model that simply won't fit in the memory you have. `mlx-model-doctor` checks those up front and prints a report, so a bad repo fails fast with a clear reason instead of a confusing crash.
+
+The static checks read repository metadata only — `config.json`, the tokenizer files, the safetensors index, quantization fields. They need no GPU or MLX and don't download the weights, so they're cheap to run anywhere. An optional `--smoke` check loads the model through `mlx-lm` (Apple Silicon) under a memory cap, to confirm it loads and generates.
+
+```bash
+mlx-model-doctor check local ./my-model
+mlx-model-doctor check hf mlx-community/Llama-3.2-3B-Instruct-4bit
+```
+
+## Install
+
+```bash
+pip install mlx-model-doctor
+# With the optional mlx-lm smoke check (Apple Silicon):
+pip install "mlx-model-doctor[mlx-lm]"
+```
+
+Or with `uv`:
+
+```bash
+uv add mlx-model-doctor
+uv add "mlx-model-doctor[mlx-lm]"
+```
+
+Verify the install:
+
+```bash
+mlx-model-doctor version
+mlx-model-doctor --help
+```
+
+Requires Python ≥ 3.11. The static checks are pure Python (`huggingface-hub` + `safetensors`); only the optional `--smoke` runtime check needs `mlx-lm` and Apple Silicon.
+
+## What it checks
+
+The built-in `text` plugin runs these against a model repository, in order:
+
+- **Required files** — `config.json` is present and readable.
+- **Config consistency** — `config.json` parses, and its `model_type` is set.
+- **Tokenizer** — the tokenizer files a text model needs are present, and the special-token configuration is coherent.
+- **Safetensors index** — when the weights are sharded, `model.safetensors.index.json` is valid and every shard it references exists.
+- **Quantization metadata** — quantization fields in the config are consistent with what the weights actually carry.
+- **Memory budget** — an estimate of the memory the model needs at your context length, compared against a budget you pass with `--max-memory`.
+
+Each check returns a result with a status (`pass` / `warn` / `fail` / `skip`), a message, and — when something is wrong — a remediation hint. The report aggregates them, and the process exit code reflects the worst result under your fail policy.
+
+## Python API
+
+```python
+from mlx_model_doctor import check_local_model, check_hf_model
+
+report = check_local_model("./my-model")
+print(report.summary)            # {"pass": 6, "warn": 1, "fail": 0, "skip": 1}
+for result in report.results:
+    print(result.status, result.check_id, result.message)
+
+# Hugging Face repos (hits the Hub):
+report = check_hf_model("mlx-community/Llama-3.2-3B-Instruct-4bit")
+```
+
+`DoctorReport` renders to text, JSON, or Markdown (`render_text` / `render_json` / `render_markdown`), and the result objects are frozen dataclasses, so the output is stable to diff in CI.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `version` | Print the version plus the active Python, virtualenv, and dependency status. |
+| `man` | Print usage examples and the exit-code table. |
+| `plugins` | List registered check plugins (`text` today). |
+| `check local <path>` | Validate a model directory on disk. |
+| `check hf <repo_id>` | Validate a model repository on the Hugging Face Hub (network). |
+| `sample hf` | Survey likely-MLX repos for an author and validate a deterministic sample. |
+
+`check` accepts `--format {text,json,markdown}`, `--output <file>`, `--max-memory <e.g. 32gb>`, `--context-length <n>`, `--fail-on {error,warn,never}`, `--include-weights`, and `--smoke`.
+
+Exit codes: `0` checks passed (under the fail policy), `1` checks found failures, `2` tool error — a bad target, a missing dependency, or zero checks run.
+
+## The Hugging Face path
+
+`check hf` and `sample hf` talk to the Hub through `huggingface-hub`. They read repository metadata (the file list, sizes, and the small text files) rather than downloading the weights, but they do need network access, and an auth or rate-limit problem surfaces as a clear tool error rather than a stack trace. `sample hf` is a survey: it lists an author's repos, keeps the ones that look like MLX models, validates a deterministic sample of them, and reports each as its own batch item — a per-model failure is recorded and the run continues.
+
+## Status
+
+**Alpha (0.1.0).** The static `check local` path and the report/CLI surface are solid and well tested. The Hugging Face path (`check hf`, `sample hf`) is implemented and tested offline against fakes; its live behavior is exercised by opt-in network tests. The API may still shift before 1.0 — pin a version if you depend on it.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). Validating a model repository does not touch the model's own weights or license; those belong to their respective authors.
+
+## Acknowledgements
+
+- [Apple ML Explore](https://github.com/ml-explore/mlx) for MLX and [`mlx-lm`](https://github.com/ml-explore/mlx-lm).
+- [Hugging Face](https://github.com/huggingface/huggingface_hub) for the Hub client and `safetensors`.
+
+---
+
+By Denis Ineshin · [ineshin.space](https://ineshin.space)

mlx_model_doctor-0.1.0/README.md

@@ -0,0 +1,105 @@
+# mlx-model-doctor
+
+[![PyPI version](https://img.shields.io/pypi/v/mlx-model-doctor.svg)](https://pypi.org/project/mlx-model-doctor/)
+[![Python versions](https://img.shields.io/pypi/pyversions/mlx-model-doctor.svg)](https://pypi.org/project/mlx-model-doctor/)
+[![License: Apache 2.0](https://img.shields.io/pypi/l/mlx-model-doctor.svg)](https://github.com/IonDen/mlx-model-doctor/blob/master/LICENSE)
+
+Validate an MLX / Hugging Face model repository before you load it.
+
+A model repo can be broken in ways you only discover halfway through `load()`: a `config.json` that disagrees with the weights, a missing tokenizer file, a `model.safetensors.index.json` that points at shards that aren't there, quantization metadata that doesn't match the tensors, or a model that simply won't fit in the memory you have. `mlx-model-doctor` checks those up front and prints a report, so a bad repo fails fast with a clear reason instead of a confusing crash.
+
+The static checks read repository metadata only — `config.json`, the tokenizer files, the safetensors index, quantization fields. They need no GPU or MLX and don't download the weights, so they're cheap to run anywhere. An optional `--smoke` check loads the model through `mlx-lm` (Apple Silicon) under a memory cap, to confirm it loads and generates.
+
+```bash
+mlx-model-doctor check local ./my-model
+mlx-model-doctor check hf mlx-community/Llama-3.2-3B-Instruct-4bit
+```
+
+## Install
+
+```bash
+pip install mlx-model-doctor
+# With the optional mlx-lm smoke check (Apple Silicon):
+pip install "mlx-model-doctor[mlx-lm]"
+```
+
+Or with `uv`:
+
+```bash
+uv add mlx-model-doctor
+uv add "mlx-model-doctor[mlx-lm]"
+```
+
+Verify the install:
+
+```bash
+mlx-model-doctor version
+mlx-model-doctor --help
+```
+
+Requires Python ≥ 3.11. The static checks are pure Python (`huggingface-hub` + `safetensors`); only the optional `--smoke` runtime check needs `mlx-lm` and Apple Silicon.
+
+## What it checks
+
+The built-in `text` plugin runs these against a model repository, in order:
+
+- **Required files** — `config.json` is present and readable.
+- **Config consistency** — `config.json` parses, and its `model_type` is set.
+- **Tokenizer** — the tokenizer files a text model needs are present, and the special-token configuration is coherent.
+- **Safetensors index** — when the weights are sharded, `model.safetensors.index.json` is valid and every shard it references exists.
+- **Quantization metadata** — quantization fields in the config are consistent with what the weights actually carry.
+- **Memory budget** — an estimate of the memory the model needs at your context length, compared against a budget you pass with `--max-memory`.
+
+Each check returns a result with a status (`pass` / `warn` / `fail` / `skip`), a message, and — when something is wrong — a remediation hint. The report aggregates them, and the process exit code reflects the worst result under your fail policy.
+
+## Python API
+
+```python
+from mlx_model_doctor import check_local_model, check_hf_model
+
+report = check_local_model("./my-model")
+print(report.summary)            # {"pass": 6, "warn": 1, "fail": 0, "skip": 1}
+for result in report.results:
+    print(result.status, result.check_id, result.message)
+
+# Hugging Face repos (hits the Hub):
+report = check_hf_model("mlx-community/Llama-3.2-3B-Instruct-4bit")
+```
+
+`DoctorReport` renders to text, JSON, or Markdown (`render_text` / `render_json` / `render_markdown`), and the result objects are frozen dataclasses, so the output is stable to diff in CI.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `version` | Print the version plus the active Python, virtualenv, and dependency status. |
+| `man` | Print usage examples and the exit-code table. |
+| `plugins` | List registered check plugins (`text` today). |
+| `check local <path>` | Validate a model directory on disk. |
+| `check hf <repo_id>` | Validate a model repository on the Hugging Face Hub (network). |
+| `sample hf` | Survey likely-MLX repos for an author and validate a deterministic sample. |
+
+`check` accepts `--format {text,json,markdown}`, `--output <file>`, `--max-memory <e.g. 32gb>`, `--context-length <n>`, `--fail-on {error,warn,never}`, `--include-weights`, and `--smoke`.
+
+Exit codes: `0` checks passed (under the fail policy), `1` checks found failures, `2` tool error — a bad target, a missing dependency, or zero checks run.
+
+## The Hugging Face path
+
+`check hf` and `sample hf` talk to the Hub through `huggingface-hub`. They read repository metadata (the file list, sizes, and the small text files) rather than downloading the weights, but they do need network access, and an auth or rate-limit problem surfaces as a clear tool error rather than a stack trace. `sample hf` is a survey: it lists an author's repos, keeps the ones that look like MLX models, validates a deterministic sample of them, and reports each as its own batch item — a per-model failure is recorded and the run continues.
+
+## Status
+
+**Alpha (0.1.0).** The static `check local` path and the report/CLI surface are solid and well tested. The Hugging Face path (`check hf`, `sample hf`) is implemented and tested offline against fakes; its live behavior is exercised by opt-in network tests. The API may still shift before 1.0 — pin a version if you depend on it.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). Validating a model repository does not touch the model's own weights or license; those belong to their respective authors.
+
+## Acknowledgements
+
+- [Apple ML Explore](https://github.com/ml-explore/mlx) for MLX and [`mlx-lm`](https://github.com/ml-explore/mlx-lm).
+- [Hugging Face](https://github.com/huggingface/huggingface_hub) for the Hub client and `safetensors`.
+
+---
+
+By Denis Ineshin · [ineshin.space](https://ineshin.space)

mlx_model_doctor-0.1.0/ROADMAP.md

@@ -0,0 +1,39 @@
+# mlx-model-doctor Roadmap
+
+A non-binding sketch of where the library is headed. Items move between sections
+as priorities change.
+
+## Released
+
+- **v0.1.0** (2026-06-04) — initial public release. Static validation for local
+  model repositories; the Hugging Face target (`check hf`, `sample hf`); the
+  optional memory-safe `mlx-lm` smoke check; text / JSON / Markdown reports; the
+  `text` check plugin.
+
+## Active
+
+(Empty.)
+
+## Future (no fixed release target)
+
+- **More check plugins beyond `text`.** The plugin protocol is in place; vision
+  and embedding model families would each get their own ordered check list.
+- **Richer Hugging Face surveying.** Caching, broader candidate signals, and
+  pagination so `sample hf` can cover more of an author's catalog.
+- **A docs site.** The `mkdocs-material` dependency group is wired, but there is
+  no published site yet.
+
+## Out of scope (deliberate non-goals)
+
+- **Running or serving models.** `mlx-model-doctor` validates a repository;
+  `mlx-lm` and `mflux` run it. The optional `--smoke` check is a minimal
+  load-and-generate probe, not a runtime or a server.
+- **Repairing repositories.** It reports problems and suggests fixes; it does not
+  rewrite `config.json`, re-shard weights, or edit the repo.
+
+Re-opening an out-of-scope item requires evidence that the original reasoning no
+longer holds.
+
+---
+
+By Denis Ineshin · [ineshin.space](https://ineshin.space)