Text Generation
PEFT
Safetensors
GGUF
commit-message
conventional-commits
lora
code
on-device
conversational
Instructions to use pointbreaklab/knot-scribe with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- PEFT
How to use pointbreaklab/knot-scribe with PEFT:
from peft import PeftModel from transformers import AutoModelForCausalLM base_model = AutoModelForCausalLM.from_pretrained("unsloth/qwen2.5-coder-7b-instruct-bnb-4bit") model = PeftModel.from_pretrained(base_model, "pointbreaklab/knot-scribe") - Notebooks
- Google Colab
- Kaggle
docs: replace em-dashes with hyphens in model card
Browse files
README.md
CHANGED
|
@@ -15,11 +15,11 @@ language:
|
|
| 15 |
pipeline_tag: text-generation
|
| 16 |
---
|
| 17 |
|
| 18 |
-
# Knot AI
|
| 19 |
|
| 20 |
**A task-specific model that reads a code diff and writes the commit message.**
|
| 21 |
Fine-tuned from [`Qwen/Qwen2.5-Coder-7B-Instruct`](https://huggingface.co/Qwen/Qwen2.5-Coder-7B-Instruct).
|
| 22 |
-
Runs **100% locally**
|
| 23 |
auto-commit in [**Knot**](https://pointbreaklab.com/knot), a peer-to-peer version
|
| 24 |
control system by PointBreakLab.
|
| 25 |
|
|
@@ -33,7 +33,7 @@ control system by PointBreakLab.
|
|
| 33 |
|
| 34 |
Knot AI does **one** thing well: turn a diff into a clear, correctly-typed
|
| 35 |
Conventional-Commit message. It is **not** a chat assistant or a general coding
|
| 36 |
-
model
|
| 37 |
*owned* specialist you run on your own hardware.
|
| 38 |
|
| 39 |
## How it works
|
|
@@ -46,8 +46,7 @@ model — feed it a diff, get a message. That focus is the point: a small, priva
|
|
| 46 |
|
| 47 |
- **Method:** QLoRA (4-bit), completion-only supervised fine-tuning (loss on the
|
| 48 |
commit message only), 2 epochs, ~6h on a single **NVIDIA RTX 3060 (12 GB)**.
|
| 49 |
-
- **Data:** 3,227 examples mined from real histories of permissively-licensed OSS
|
| 50 |
-
**JavaScript/TypeScript** (vite, vitest, nx, pnpm, rollup, angular, changesets,
|
| 51 |
husky, vitepress), **Python** (poetry, pydantic), **Rust** (starship, tauri),
|
| 52 |
and **Go** (goreleaser). Type-balanced (fix 27% / feat 19% / refactor 11% /
|
| 53 |
chore 8% / …).
|
|
@@ -68,11 +67,10 @@ Python/Rust/Go diversity.
|
|
| 68 |
| Generation errors | 6 | **0** |
|
| 69 |
|
| 70 |
**Cross-language generalization:** on a separate held-out set of **60 Python/Rust/Go
|
| 71 |
-
commits** (languages this version added), Knot AI holds **56.7% type accuracy**
|
| 72 |
-
matching its JS/TS score, evidence the diversity generalized rather than
|
| 73 |
memorized.
|
| 74 |
|
| 75 |
-
> Note: these are *single-reference* metrics
|
| 76 |
> though a commit has many valid messages and a change can honestly be `fix` *or*
|
| 77 |
> `refactor`. So the scores understate real usefulness; sample outputs below are
|
| 78 |
> representative.
|
|
@@ -108,14 +106,14 @@ Coming with the Ollama release: `ollama run pointbreaklab/knot-ai`
|
|
| 108 |
|
| 109 |
## Limitations
|
| 110 |
|
| 111 |
-
- Pattern completion over ~3k examples
|
| 112 |
type accuracy means it is wrong sometimes.
|
| 113 |
- Binary-only changes (images, PDFs) have no textual diff to read.
|
| 114 |
- English commit conventions; not a general assistant.
|
| 115 |
|
| 116 |
## Roadmap
|
| 117 |
|
| 118 |
-
This is **v1** (built on Knot AI's v4 adapter). A **v5** is planned
|
| 119 |
higher-quality corpus for better accuracy and closer matching. Knot AI improves
|
| 120 |
in the open.
|
| 121 |
|
|
|
|
| 15 |
pipeline_tag: text-generation
|
| 16 |
---
|
| 17 |
|
| 18 |
+
# Knot AI - Commit Message Model
|
| 19 |
|
| 20 |
**A task-specific model that reads a code diff and writes the commit message.**
|
| 21 |
Fine-tuned from [`Qwen/Qwen2.5-Coder-7B-Instruct`](https://huggingface.co/Qwen/Qwen2.5-Coder-7B-Instruct).
|
| 22 |
+
Runs **100% locally** - no API, no data leaves your machine. It powers hands-free
|
| 23 |
auto-commit in [**Knot**](https://pointbreaklab.com/knot), a peer-to-peer version
|
| 24 |
control system by PointBreakLab.
|
| 25 |
|
|
|
|
| 33 |
|
| 34 |
Knot AI does **one** thing well: turn a diff into a clear, correctly-typed
|
| 35 |
Conventional-Commit message. It is **not** a chat assistant or a general coding
|
| 36 |
+
model - feed it a diff, get a message. That focus is the point: a small, private,
|
| 37 |
*owned* specialist you run on your own hardware.
|
| 38 |
|
| 39 |
## How it works
|
|
|
|
| 46 |
|
| 47 |
- **Method:** QLoRA (4-bit), completion-only supervised fine-tuning (loss on the
|
| 48 |
commit message only), 2 epochs, ~6h on a single **NVIDIA RTX 3060 (12 GB)**.
|
| 49 |
+
- **Data:** 3,227 examples mined from real histories of permissively-licensed OSS - **JavaScript/TypeScript** (vite, vitest, nx, pnpm, rollup, angular, changesets,
|
|
|
|
| 50 |
husky, vitepress), **Python** (poetry, pydantic), **Rust** (starship, tauri),
|
| 51 |
and **Go** (goreleaser). Type-balanced (fix 27% / feat 19% / refactor 11% /
|
| 52 |
chore 8% / …).
|
|
|
|
| 67 |
| Generation errors | 6 | **0** |
|
| 68 |
|
| 69 |
**Cross-language generalization:** on a separate held-out set of **60 Python/Rust/Go
|
| 70 |
+
commits** (languages this version added), Knot AI holds **56.7% type accuracy** - matching its JS/TS score, evidence the diversity generalized rather than
|
|
|
|
| 71 |
memorized.
|
| 72 |
|
| 73 |
+
> Note: these are *single-reference* metrics - they compare to one human label,
|
| 74 |
> though a commit has many valid messages and a change can honestly be `fix` *or*
|
| 75 |
> `refactor`. So the scores understate real usefulness; sample outputs below are
|
| 76 |
> representative.
|
|
|
|
| 106 |
|
| 107 |
## Limitations
|
| 108 |
|
| 109 |
+
- Pattern completion over ~3k examples - it will miss on unusual diffs, and ~57%
|
| 110 |
type accuracy means it is wrong sometimes.
|
| 111 |
- Binary-only changes (images, PDFs) have no textual diff to read.
|
| 112 |
- English commit conventions; not a general assistant.
|
| 113 |
|
| 114 |
## Roadmap
|
| 115 |
|
| 116 |
+
This is **v1** (built on Knot AI's v4 adapter). A **v5** is planned - a larger,
|
| 117 |
higher-quality corpus for better accuracy and closer matching. Knot AI improves
|
| 118 |
in the open.
|
| 119 |
|