tenseleyflow/sway / 34278d3

+# Consumer-side pre-commit config — plug this into your repo's

+# ``.pre-commit-config.yaml`` to gate the adapter on every commit.

+#

+# Rev pinning: sway hasn't tagged a release yet (pre-v0.1.0). Pin to a

+# specific commit SHA rather than ``HEAD`` so the gate's behavior

+# doesn't drift under you on upstream changes. Bump the SHA

+# deliberately when you want to pick up new probes. After v0.1.0

+# ships you'll switch to ``rev: v0.1.0`` and forget about it.

+

+repos:

+  - repo: https://github.com/tenseleyFlow/sway

+    # Pin to a specific commit — update deliberately when you want

+    # upstream changes. Replace with a tag like ``v0.1.0`` once sway

+    # publishes its first release.

+    rev: 2ecd9a0c9d65a9b9576a185597c88f41444f9646

+    hooks:

+      # Recommended: ``sway-gate`` uses the sway install on your PATH.

+      # Fastest path; assumes you've ``pip install 'dlm-sway[hf]'``.

+      - id: sway-gate

+        args: ["examples/precommit-example/sway.yaml", "--threshold=0.0"]

+

+      # Alternative — uncomment if you don't have sway installed

+      # system-wide. Pre-commit will build a fresh venv and install

+      # sway + torch + transformers (~5 GB) on first run.

+      #

+      # - id: sway-gate-isolated

+      #   args: ["examples/precommit-example/sway.yaml", "--threshold=0.0"]

+# Pre-commit gate example

+

+A copy-paste recipe for plugging `sway gate` into any repo's `git

+commit` flow via [pre-commit.com](https://pre-commit.com).

+

+## What this gives you

+

+On every `git commit` that touches `sway.yaml`, a `.dlm` document, or

+an `adapter/` directory, pre-commit runs `sway gate` against your

+spec. A FAIL verdict aborts the commit with the terminal banner

+you'd see from `sway gate` directly. No more "oops, I broke the

+adapter and didn't notice until the next manual `sway run`."

+

+## Which variant

+

+sway ships two hooks. Pick whichever matches your install posture:

+

+| Hook | When to use | Cost |

+|---|---|---|

+| `sway-gate` | sway is already on your `PATH` (`pip install 'dlm-sway[hf]'`) | Milliseconds of hook overhead + the actual gate runtime |

+| `sway-gate-isolated` | fresh venv, no existing sway install | First run installs sway + torch + transformers (~5 GB, ~2 min). Subsequent runs reuse the cached venv. |

+

+This example shows `sway-gate` as the default and `sway-gate-isolated`

+commented out. Swap them in `.pre-commit-config.yaml` if you want the

+isolated variant.

+

+## Setup (4 steps)

+

+1. Install pre-commit: `pipx install pre-commit` (or `pip install

+   pre-commit` if you don't use pipx).

+2. Copy this directory's `.pre-commit-config.yaml` into your repo

+   root. If you already have one, merge the `- repo:` block.

+3. Edit `sway.yaml` in your repo to point at your real base model

+   and adapter paths.

+4. Install the hook: `pre-commit install`.

+

+That's it. The next `git commit` that matches the hook's file filter

+will run `sway gate` before the commit finalizes.

+

+## Rev pinning

+

+The example's `.pre-commit-config.yaml` pins to a specific commit

+SHA because sway hasn't tagged a v0.1.0 release yet. Pinning to

+`HEAD` would silently drift your gate's behavior on every `pre-commit

+autoupdate`; pinning to a SHA is the honest pre-release pattern.

+

+Bump the SHA deliberately when you want to pick up new probes or

+bug fixes. After sway publishes v0.1.0 you'll switch to

+`rev: v0.1.0` and forget about SHAs.

+

+## Scope discipline

+

+The hook **only gates** — exits non-zero on FAIL, zero on PASS. It

+does not emit JSON / markdown reports; those are for `sway run`

+(called ad-hoc or in a separate CI job). Keeping the hook focused

+means `git commit` stays fast and the gate's verdict stays the

+headline signal.

+

+## Trying it locally before committing

+

+If you want to see the hook fire before integrating it into a real

+repo:

+

+```bash

+# From your repo's root, after copying the config in and editing

+# the spec paths:

+pre-commit run sway-gate --all-files

+```

+

+That runs the hook against every tracked file and surfaces the

+full terminal report. A subsequent `git commit` will run the hook

+only against staged files — same logic, narrower scope.

+# Minimal sway spec — template for the pre-commit-gate recipe.

+#

+# Replace the ``base`` and ``adapter`` paths below with your own. The

+# default values are placeholders documenting the shape the hook

+# expects. Running ``sway gate`` against this verbatim will fail

+# because the paths don't resolve — that's by design; the user

+# customizes before plugging the hook in.

+#

+# See README "Pre-commit" section for the full walk-through.

+

+version: 1

+models:

+  base:

+    base: HuggingFaceTB/SmolLM2-135M-Instruct

+    kind: hf

+    adapter: path/to/your/adapter

+    dtype: fp32

+    device: cpu

+  ft:

+    base: HuggingFaceTB/SmolLM2-135M-Instruct

+    kind: hf

+    adapter: path/to/your/adapter

+    dtype: fp32

+    device: cpu

+defaults:

+  seed: 0

+  differential: true

+  # The gate's exit-code threshold. 0.0 means "any pass is acceptable";

+  # real specs raise this to 0.6 or 0.8 for a meaningful quality bar.

+  coverage_threshold: 0.0

+suite:

+  # One cheap probe keeps the pre-commit hook fast. Add more probes as

+  # the adapter gets more surface area worth gating.

+  - name: dk

+    kind: delta_kl

+    prompts:

+      - The capital of France is

+      - Python decorators are

+      - Water boils at

+      - Mitochondria are

+    divergence: js

+    assert_mean_gte: 0.0