Update README.md
Browse files
README.md
CHANGED
|
@@ -28,11 +28,8 @@ It outputs **strict JSON** with a short `title` (≤ 65 chars) and up to 3 `bull
|
|
| 28 |
|
| 29 |
* **Input:** prompt containing the diff (plain text).
|
| 30 |
* **Output:** JSON object: `{"title": "...", "bullets": ["...", "..."]}`.
|
| 31 |
-
* **Developed by:** Ethan (HF: `ethanke`)
|
| 32 |
-
* **Shared by:** Ethan (HF: `ethanke`)
|
| 33 |
* **Model type:** LoRA adapter for causal LM (text generation)
|
| 34 |
* **Language(s):** English (commit message conventions)
|
| 35 |
-
* **License:** Inherits base model’s license; dataset has **non-commercial** terms (see **Training Data**). Review before production/commercial use.
|
| 36 |
* **Finetuned from:** `unsloth/LFM2-350M-unsloth-bnb-4bit` (4-bit quantized base, trained with QLoRA)
|
| 37 |
|
| 38 |
### Model Sources
|
|
@@ -46,23 +43,6 @@ It outputs **strict JSON** with a short `title` (≤ 65 chars) and up to 3 `bull
|
|
| 46 |
* Convert patch diffs into Conventional Commit messages for PR titles, commits, and changelogs.
|
| 47 |
* Provide human-readable summaries in agent UIs with guaranteed JSON structure.
|
| 48 |
|
| 49 |
-
### Downstream Use
|
| 50 |
-
|
| 51 |
-
* Plug into CI to auto-suggest commit titles after tests pass.
|
| 52 |
-
* Use as a **helper** in a larger agent system (router/planner stays in a bigger model).
|
| 53 |
-
|
| 54 |
-
### Out-of-Scope Use
|
| 55 |
-
|
| 56 |
-
* General code generation or deep refactoring explanations.
|
| 57 |
-
* Non-English commit conventions.
|
| 58 |
-
* Knowledge-intensive narrative summaries.
|
| 59 |
-
|
| 60 |
-
## Bias, Risks, and Limitations
|
| 61 |
-
|
| 62 |
-
* Trained on public commits filtered to Conventional Commit titles; may **prefer certain styles/projects**.
|
| 63 |
-
* Long diffs are truncated to `max_length`; summarization may miss edge changes.
|
| 64 |
-
* Dataset license may restrict **commercial** usage; verify for your case.
|
| 65 |
-
|
| 66 |
### Recommendations
|
| 67 |
|
| 68 |
* Enforce JSON validation; if invalid, retry with a JSON-repair prompt.
|
|
@@ -137,21 +117,13 @@ print(obj)
|
|
| 137 |
## Environmental Impact
|
| 138 |
|
| 139 |
* **Hardware:** 1× NVIDIA GTX 3060 12 GB (local)
|
| 140 |
-
* **Hours used:** ~
|
| 141 |
|
| 142 |
## Technical Specifications
|
| 143 |
|
| 144 |
* **Architecture:** LFM2-350M (decoder-only) + LoRA adapter
|
| 145 |
* **Libraries:** `transformers`, `trl`, `peft`, `bitsandbytes`, `datasets`, `unsloth`
|
| 146 |
|
| 147 |
-
## Citation
|
| 148 |
-
|
| 149 |
-
If you use this model, please cite the base model and dataset authors according to their cards.
|
| 150 |
-
|
| 151 |
-
## Model Card Authors
|
| 152 |
-
|
| 153 |
-
* Ethan (`ethanke`) and contributors
|
| 154 |
-
|
| 155 |
## Contact
|
| 156 |
|
| 157 |
* Open an issue on the Hub repo or message `ethanke` on Hugging Face.
|
|
|
|
| 28 |
|
| 29 |
* **Input:** prompt containing the diff (plain text).
|
| 30 |
* **Output:** JSON object: `{"title": "...", "bullets": ["...", "..."]}`.
|
|
|
|
|
|
|
| 31 |
* **Model type:** LoRA adapter for causal LM (text generation)
|
| 32 |
* **Language(s):** English (commit message conventions)
|
|
|
|
| 33 |
* **Finetuned from:** `unsloth/LFM2-350M-unsloth-bnb-4bit` (4-bit quantized base, trained with QLoRA)
|
| 34 |
|
| 35 |
### Model Sources
|
|
|
|
| 43 |
* Convert patch diffs into Conventional Commit messages for PR titles, commits, and changelogs.
|
| 44 |
* Provide human-readable summaries in agent UIs with guaranteed JSON structure.
|
| 45 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 46 |
### Recommendations
|
| 47 |
|
| 48 |
* Enforce JSON validation; if invalid, retry with a JSON-repair prompt.
|
|
|
|
| 117 |
## Environmental Impact
|
| 118 |
|
| 119 |
* **Hardware:** 1× NVIDIA GTX 3060 12 GB (local)
|
| 120 |
+
* **Hours used:** ~2 h (prototype)
|
| 121 |
|
| 122 |
## Technical Specifications
|
| 123 |
|
| 124 |
* **Architecture:** LFM2-350M (decoder-only) + LoRA adapter
|
| 125 |
* **Libraries:** `transformers`, `trl`, `peft`, `bitsandbytes`, `datasets`, `unsloth`
|
| 126 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 127 |
## Contact
|
| 128 |
|
| 129 |
* Open an issue on the Hub repo or message `ethanke` on Hugging Face.
|