nyxspecter4 commited on
Commit
7be4e35
·
verified ·
1 Parent(s): 5d41a6b

docs: model card matches reality — Q4_K_M GGUF now in-repo (1.93 GB) for Ollama llama.cpp one-liners, honest quant matrix with status, record counts corrected (1,637 DPO), limitations section added

Browse files
Files changed (1) hide show
  1. README.md +27 -24
README.md CHANGED
@@ -24,6 +24,7 @@ tags:
24
  - conversational
25
  - llama-cpp
26
  - gguf
 
27
  ---
28
 
29
  # KIN — Cybersecurity Verification Translator (3B)
@@ -35,7 +36,7 @@ KIN is an authoritative, fine-tuned cybersecurity model built on **Qwen2.5-3B-In
35
  ## Evaluation & Leaderboard Status
36
 
37
  * **Hugging Face Open LLM Leaderboard:** [Job PENDING Evaluation](https://huggingface.co/datasets/open-llm-leaderboard/requests/blob/main/nyxspecter4/kin-sft-lora_eval_request_False_bfloat16_Original.json)
38
- * **Downloads:** **1,080+** and climbing
39
 
40
  ---
41
 
@@ -91,16 +92,17 @@ print(output[0]["generated_text"])
91
 
92
  ---
93
 
94
- ## Quickstart: Ollama & Local GGUF
95
 
96
- KIN is available in both full Safetensors weights and **GGUF** quantization (`Q4_K_M`):
97
 
98
  ```bash
99
- # Run directly with Ollama from Hugging Face
100
  ollama run hf.co/nyxspecter4/kin-sft-lora
101
  ```
102
 
103
- Or using the included `Modelfile`:
 
104
  ```bash
105
  git clone https://huggingface.co/nyxspecter4/kin-sft-lora
106
  cd kin-sft-lora
@@ -108,6 +110,21 @@ ollama create kin -f Modelfile
108
  ollama run kin
109
  ```
110
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
111
  ---
112
 
113
  ## Training Details
@@ -118,26 +135,12 @@ ollama run kin
118
  | Method | LoRA SFT + DPO Alignment |
119
  | LoRA Rank / Alpha | 8 / 16 |
120
  | Target Modules | `q_proj`, `k_proj`, `v_proj`, `o_proj` |
121
- | Training Dataset | [`nyxspecter4/kin-cyber-dpo-v2`](https://huggingface.co/datasets/nyxspecter4/kin-cyber-dpo-v2) (1,635 curated pairs) |
122
- | Frameworks | TRL 0.14.0, Transformers 4.48.0, Unsloth, PyTorch 2.6.0+cu124 |
123
- | Weights | **Full Merged Safetensors** + Standalone GGUF |
124
 
125
  ---
126
 
127
- ## Public Ecosystem
128
-
129
- | Artifact | Location | Description |
130
- |---|---|---|
131
- | **Training Dataset** | [`nyxspecter4/kin-cyber-dpo-v2`](https://huggingface.co/datasets/nyxspecter4/kin-cyber-dpo-v2) | 1,635 sanitized cybersecurity DPO pairs |
132
- | **Interactive Demo** | [`nyxspecter4/kin-cybersec`](https://huggingface.co/spaces/nyxspecter4/kin-cybersec) | Live Gradio threat evaluation Space |
133
-
134
- ---
135
-
136
- ## Limitations & Scope
137
-
138
- - **Model Scale (3B)**: Optimized for fast inference, local edge auditing, and triage workflows. For complex multi-step kernel exploitation, pair with human verification.
139
- - **Always Verify**: KIN provides bold, actionable takes. Use the included verification commands to validate all technical claims before execution.
140
-
141
- ## License
142
 
143
- Apache 2.0
 
 
 
24
  - conversational
25
  - llama-cpp
26
  - gguf
27
+ - qwen
28
  ---
29
 
30
  # KIN — Cybersecurity Verification Translator (3B)
 
36
  ## Evaluation & Leaderboard Status
37
 
38
  * **Hugging Face Open LLM Leaderboard:** [Job PENDING Evaluation](https://huggingface.co/datasets/open-llm-leaderboard/requests/blob/main/nyxspecter4/kin-sft-lora_eval_request_False_bfloat16_Original.json)
39
+ * **Downloads:** **1,000+** and climbing
40
 
41
  ---
42
 
 
92
 
93
  ---
94
 
95
+ ## Quickstart: Ollama, GGUF & llama.cpp
96
 
97
+ This repo ships the **Q4_K_M GGUF (1.93 GB)** next to the full Safetensors weights, so local CPU/GPU inference is one command:
98
 
99
  ```bash
100
+ # Direct from Hugging Face with Ollama (pulls Q4_K_M from this repo)
101
  ollama run hf.co/nyxspecter4/kin-sft-lora
102
  ```
103
 
104
+ Or build from the included `Modelfile` (LoRA-adapter path):
105
+
106
  ```bash
107
  git clone https://huggingface.co/nyxspecter4/kin-sft-lora
108
  cd kin-sft-lora
 
110
  ollama run kin
111
  ```
112
 
113
+ With llama.cpp:
114
+
115
+ ```bash
116
+ llama-cli -hf nyxspecter4/kin-sft-lora -p "How do I detect credential-dump lateral movement?"
117
+ ```
118
+
119
+ ### Quantization Matrix
120
+
121
+ | Quant Format | Precision | File Size | Recommended Hardware | Status |
122
+ |---|---|---|---|---|
123
+ | **Q4_K_M** | 4-bit Medium | **1.93 GB** | Laptops & M1/M2/M3 Macs (fastest) | ✅ In this repo |
124
+ | Q5_K_M | 5-bit Medium | ~2.5 GB | Standard desktops (balanced) | Planned |
125
+ | Q8_0 | 8-bit High | ~3.8 GB | Workstations / servers (max fidelity) | Planned |
126
+ | FP16 | 16-bit Full | ~6.2 GB | GPU VRAM >= 8 GB (uncompressed) | Planned |
127
+
128
  ---
129
 
130
  ## Training Details
 
135
  | Method | LoRA SFT + DPO Alignment |
136
  | LoRA Rank / Alpha | 8 / 16 |
137
  | Target Modules | `q_proj`, `k_proj`, `v_proj`, `o_proj` |
138
+ | Alignment Data | `nyxspecter4/kin-cyber-dpo-v2` (1,637 DPO pairs) |
 
 
139
 
140
  ---
141
 
142
+ ## Limitations
 
 
 
 
 
 
 
 
 
 
 
 
 
 
143
 
144
+ - 3B-class model: strong at triage, brief-writing, and checklist enforcement — always validate critical findings with a replayable check or scanner before acting.
145
+ - The five-field brief is a reasoning aid, not a formal audit artifact.
146
+ - Long-context codebases should be pre-filtered (diff/relevant file chunks) before prompting.