ftdoctor 0.1.0__tar.gz

ftdoctor-0.1.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

ftdoctor-0.1.0/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,21 @@
+name: Bug
+description: Something crashed, or did not run.
+labels: [bug]
+body:
+  - type: textarea
+    id: what
+    attributes:
+      label: What happened
+      description: The command you ran and what it printed. Tracebacks are welcome.
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      placeholder: output of `--version`
+  - type: input
+    id: env
+    attributes:
+      label: Python and OS
+      placeholder: Python 3.11, Ubuntu 22.04

ftdoctor-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

ftdoctor-0.1.0/.github/ISSUE_TEMPLATE/wrong_verdict.yml

@@ -0,0 +1,32 @@
+name: Wrong verdict
+description: ftdoctor said something about your run that is not true -- or missed something that is.
+labels: [wrong-verdict]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        The most valuable issue you can file. Every threshold in ftdoctor was set against
+        public runs, and several were changed because one of them proved it wrong.
+  - type: dropdown
+    id: kind
+    attributes:
+      label: Which way was it wrong?
+      options:
+        - It flagged a run that was fine
+        - It missed a real problem
+        - It recommended the wrong checkpoint
+        - The finding was right but the advice was wrong
+    validations:
+      required: true
+  - type: input
+    id: run
+    attributes:
+      label: The run
+      description: A public Hub model id, or attach the trainer_state.json.
+      placeholder: owner/model
+  - type: textarea
+    id: truth
+    attributes:
+      label: What was actually going on
+    validations:
+      required: true

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

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: py${{ matrix.python }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        include:
+          # The terminal report has an ASCII fallback specifically for Windows
+          # consoles on a legacy code page, so it needs to actually run there.
+          - os: windows-latest
+            python: "3.12"
+          - os: macos-latest
+            python: "3.12"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+          cache: pip
+      - run: python -m pip install --upgrade pip
+      - run: pip install -e ".[dev]"
+      - name: Tests
+        run: pytest -q --cov=ftdoctor --cov-report=term-missing
+      - name: CLI smoke test
+        run: |
+          ftdoctor --version
+          ftdoctor --help
+        shell: bash
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install ruff mypy
+      - run: ruff check src tests validation tools
+      - run: ruff format --check src tests
+        continue-on-error: true
+      - run: mypy src/ftdoctor
+        continue-on-error: true
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*
+      - name: Install the wheel in a clean environment
+        run: |
+          python -m venv /tmp/clean
+          /tmp/clean/bin/pip install dist/*.whl
+          /tmp/clean/bin/ftdoctor --version

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

@@ -0,0 +1,68 @@
+name: Release
+
+# Publishes to PyPI when a version tag is pushed, using PyPI trusted publishing:
+# no API token is stored anywhere. One-time setup on pypi.org, under
+# "Your projects -> Publishing -> Add a new pending publisher":
+#   PyPI project name: ftdoctor
+#   Owner:             junglezke
+#   Repository:        ftdoctor
+#   Workflow:          release.yml
+#   Environment:       pypi
+# Then:  git tag v0.1.0 && git push origin v0.1.0
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Check the tag matches the package version
+        run: |
+          version=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          test "v$version" = "${GITHUB_REF_NAME}" || { echo "tag ${GITHUB_REF_NAME} != version v$version"; exit 1; }
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/ftdoctor/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Create the GitHub release from the changelog
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          notes=$(awk '/^## \[/{n++} n==1' CHANGELOG.md | tail -n +2)
+          gh release create "${GITHUB_REF_NAME}" dist/* --title "${GITHUB_REF_NAME}" --notes "$notes"

ftdoctor-0.1.0/.github/workflows/validation.yml

@@ -0,0 +1,36 @@
+name: Real-run validation
+
+# Re-diagnoses the public training logs in validation/runs.json and fails if any
+# verdict changed. Runs when the code that decides verdicts changes, and weekly
+# so an upstream log disappearing is noticed.
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "src/ftdoctor/**"
+      - "validation/**"
+  pull_request:
+    paths:
+      - "src/ftdoctor/**"
+      - "validation/**"
+  schedule:
+    - cron: "0 6 * * 1"
+  workflow_dispatch:
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install -e .
+      - uses: actions/cache@v4
+        with:
+          path: validation/.cache
+          key: validation-${{ hashFiles('validation/runs.json') }}
+      - run: python validation/fetch.py
+      - run: python validation/run.py --check

ftdoctor-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.pytest_cache/
+.ruff_cache/
+.coverage
+.venv/
+*.html
+# Public training logs used for validation: other people's data, fetched on demand.
+validation/.cache/

ftdoctor-0.1.0/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## [0.1.0] — 2026-10-04
+
+First release.
+
+### Added
+
+- `ftdoctor <target>` for a training output directory, a single checkpoint, a
+  `trainer_state.json`, or a model on the HuggingFace Hub (`owner/model`).
+- Noise-aware checkpoint selection: a band of 2x the eval's own step-to-step
+  noise (or 1%), restricted to checkpoints that actually exist on disk or on
+  the Hub.
+- Selection metric recovered from the Trainer's `best_metric`, so runs selected
+  on accuracy, WER or BLEU are ranked on that, not on eval loss.
+- Checks: overfitting, stopped improving, loss vs selection metric
+  disagreement, no eval, NaN / zero loss, loss flat or rising, loss spikes
+  (including periodic and epoch-boundary jumps), gradient spikes, zero
+  gradients and fp16 overflow, zero-learning-rate tails, eval below train,
+  unfinished runs. RL runs are recognised and handed to rldoctor.
+- `ftdoctor prune`: strip resume-only state or delete whole checkpoints, dry
+  run by default, every path re-checked before deletion.
+- Terminal, Markdown and JSON reports; `--fail-on` for CI.
+- `validation/`: ten public runs with pinned verdicts, chosen from a sweep of 89.

ftdoctor-0.1.0/CITATION.cff

@@ -0,0 +1,16 @@
+cff-version: 1.2.0
+title: "ftdoctor: checkpoint selection and failure diagnosis for fine-tuning runs"
+message: "If you use this software, please cite it as below."
+type: software
+authors:
+  - alias: junglezke
+repository-code: "https://github.com/junglezke/ftdoctor"
+abstract: >-
+  ftdoctor reads the training history a HuggingFace Trainer leaves in
+  trainer_state.json -- locally or from a model repository on the Hub -- and
+  reports whether the run overfit, which existing checkpoint to keep under a
+  noise-aware criterion, and which documented failure modes the run shows.
+  Thresholds were calibrated on 89 public fine-tuning logs.
+keywords: [fine-tuning, large language models, overfitting, checkpoint selection, huggingface]
+license: Apache-2.0
+version: 0.1.0

ftdoctor-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to ftdoctor
+
+## The most valuable thing you can send
+
+**A run where ftdoctor is wrong.** It flagged a fine run, missed a real problem,
+or recommended the wrong checkpoint. A public Hub model id is enough -- or attach
+the `trainer_state.json`. There is an issue template for it.
+
+Every threshold here was set against public runs, and several were changed
+because one of them proved the first version wrong. That is the process
+working, and it only works with more runs.
+
+## Changing a threshold
+
+Run the real-run validation before and after:
+
+```bash
+python validation/fetch.py
+python validation/run.py --check
+```
+
+Unit tests show a check *can* fire. The public runs in `validation/runs.json`
+show whether it fires on fine-tunes that exist, and -- as importantly -- that it
+stays quiet on the ones that are fine. If a verdict moves, either the new verdict
+is right (update `runs.json` and say why in the commit) or the change broke
+something real.
+
+## Adding a check
+
+A function in `src/ftdoctor/checks.py` that returns a `Finding` or `None`, and an
+entry in `run_all`. Return `None` when there is nothing to say: a report full of
+green ticks buries the line that matters. Put the numbers you fired on in
+`evidence` and a concrete change in `fix`.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+ruff check src tests validation tools
+```
+
+Keep the only dependency `numpy`. This runs on login nodes and in training
+images, next to whatever they already pin.

ftdoctor-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 text 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 format. We also 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 [yyyy] [name of copyright owner]
+
+   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.