Upload README.md with huggingface_hub

README.md

@@ -1,62 +1,78 @@
 ---
-base_model: mistralai/Mistral-7B-Instruct-v0.2
 library_name: peft
-model_name: lora-output
+base_model: mistralai/Mistral-7B-Instruct-v0.2
+license: apache-2.0
 tags:
-- base_model:adapter:mistralai/Mistral-7B-Instruct-v0.2
-- lora
-- sft
-- transformers
-- trl
-licence: license
-pipeline_tag: text-generation
+  - nixpkgs
+  - security
+  - lora
+  - nix
+  - patch-generation
+datasets:
+  - odoom/nixpkgs-security-patches
 ---
 
-# Model Card for lora-output
+# nixpkgs-security-lora
 
-This model is a fine-tuned version of [mistralai/Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2).
-It has been trained using [TRL](https://github.com/huggingface/trl).
+LoRA adapter for generating nixpkgs security patches. Fine-tuned on [odoom/nixpkgs-security-patches](https://huggingface.co/datasets/odoom/nixpkgs-security-patches) — 1,273 real security fixes from the NixOS/nixpkgs repository.
 
-## Quick start
+## Model Details
 
-```python
-from transformers import pipeline
+- **Base model**: [Mistral 7B Instruct v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2)
+- **Method**: QLoRA (4-bit NF4 quantization + LoRA rank 32)
+- **Target**: Cloudflare Workers AI `@cf/mistral/mistral-7b-instruct-v0.2-lora`
+- **Adapter size**: 161 MB
 
-question = "If you had a time machine, but could only go to the past or the future once and never return, which would you choose and why?"
-generator = pipeline("text-generation", model="None", device="cuda")
-output = generator([{"role": "user", "content": question}], max_new_tokens=128, return_full_text=False)[0]
-print(output["generated_text"])
-```
+## Training
 
-## Training procedure
+- **LoRA rank**: 32, alpha: 64, dropout: 0.05
+- **Target modules**: q_proj, k_proj, v_proj, o_proj, gate_proj, up_proj, down_proj
+- **Epochs**: 3
+- **Effective batch size**: 16 (batch 1 × gradient accumulation 16)
+- **Learning rate**: 2e-4, cosine schedule
+- **Max sequence length**: 4,096 tokens
+- **Hardware**: NVIDIA L4 GPU (HuggingFace Jobs)
 
- 
+## Training Data
 
+1,273 training examples and 142 eval examples derived from merged security PRs in [NixOS/nixpkgs](https://github.com/NixOS/nixpkgs). Each example pairs a CVE description with the actual nix patch diff that fixed it.
 
+Quality filters applied:
+- Only merged PRs with security-related titles (CVE, vulnerability, security fix)
+- Removed examples using deprecated `sha256` hash format (modern nixpkgs uses SRI hashes)
+- Removed trivially small diffs (< 3 changed lines)
 
-This model was trained with SFT.
+## Intended Use
 
-### Framework versions
+This adapter is designed for the [Vulnpatch](https://github.com/Vulnpatch) automated security patch agent. Given a CVE description and affected package info, it generates candidate nix package patches.
 
-- PEFT 0.18.1
-- TRL: 0.29.0
-- Transformers: 5.2.0
-- Pytorch: 2.10.0
-- Datasets: 4.6.1
-- Tokenizers: 0.22.2
+## Usage with Cloudflare Workers AI
 
-## Citations
+```javascript
+const response = await env.AI.run(
+  "@cf/mistral/mistral-7b-instruct-v0.2-lora",
+  {
+    messages: [
+      { role: "user", content: "Fix CVE-2024-1234 in package foo..." }
+    ],
+    lora: "nixpkgs-security-lora"
+  }
+);
+```
 
+## Usage with Transformers + PEFT
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+from peft import PeftModel
+
+model = AutoModelForCausalLM.from_pretrained("mistralai/Mistral-7B-Instruct-v0.2")
+model = PeftModel.from_pretrained(model, "odoom/nixpkgs-security-lora")
+tokenizer = AutoTokenizer.from_pretrained("mistralai/Mistral-7B-Instruct-v0.2")
+```
 
+## Limitations
 
-Cite TRL as:
-    
-```bibtex
-@software{vonwerra2020trl,
-  title   = {{TRL: Transformers Reinforcement Learning}},
-  author  = {von Werra, Leandro and Belkada, Younes and Tunstall, Lewis and Beeching, Edward and Thrush, Tristan and Lambert, Nathan and Huang, Shengyi and Rasul, Kashif and Gallouédec, Quentin},
-  license = {Apache-2.0},
-  url     = {https://github.com/huggingface/trl},
-  year    = {2020}
-}
-```
+- Specialized for nixpkgs package expressions — not a general code model
+- Training data is Nix-specific; won't generalize to other package managers
+- May produce patches that need manual review for correctness