tnadmin commited on
Commit
4514268
·
verified ·
1 Parent(s): 7c884c7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +78 -0
README.md CHANGED
@@ -2,4 +2,82 @@
2
  license: other
3
  license_name: qwen-research
4
  license_link: https://huggingface.co/Qwen/Qwen2.5-Coder-3B-Instruct/blob/main/LICENSE
 
 
 
 
 
 
 
 
 
 
5
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  license: other
3
  license_name: qwen-research
4
  license_link: https://huggingface.co/Qwen/Qwen2.5-Coder-3B-Instruct/blob/main/LICENSE
5
+ base_model: Qwen/Qwen2.5-Coder-3B-Instruct
6
+ tags:
7
+ - cisco
8
+ - ios-xe
9
+ - network-automation
10
+ - gguf
11
+ - qwen2.5-coder
12
+ - non-commercial
13
+ library_name: llama.cpp
14
+ pipeline_tag: text-generation
15
  ---
16
+
17
+ # Sentinel-NX — Cisco IOS-XE Config Assistant (V3.1, GGUF)
18
+
19
+ A small, edge-deployable Cisco **IOS-XE configuration assistant**: a QLoRA fine-tune of
20
+ Qwen2.5-Coder-3B-Instruct, merged and quantized to GGUF. It emits **strict, syntactically
21
+ valid** IOS-XE for exactly what's requested — no invented interfaces, IPs, loopbacks,
22
+ route-maps, `no shutdown`s, descriptions, or unrequested best-practice config.
23
+
24
+ Built with Qwen. **Non-commercial only** (see License).
25
+
26
+ Project / code / methodology: https://github.com/tnadmin1/Sentinel-NX
27
+
28
+ ## Files
29
+
30
+ | File | Quant | Size | Use |
31
+ |---|---|---|---|
32
+ | `sentinel-nx-q8_0.gguf` | Q8_0 | ~3.1 GB | Primary — highest fidelity |
33
+ | `sentinel-nx-q6_k.gguf` | Q6_K | ~2.4 GB | Faster, near-lossless |
34
+
35
+ ## Results
36
+
37
+ Manually-scored benchmarks; the hidden set uses entirely new interfaces, VLANs, ASNs,
38
+ IPs, and object names not seen in training (a generalization test).
39
+
40
+ **Hidden 20-prompt benchmark** (5 pts each):
41
+
42
+ | Model | Score |
43
+ |---|---|
44
+ | Base Qwen2.5-Coder-3B-Instruct | 58 / 100 |
45
+ | V2 | 71 / 100 |
46
+ | **V3.1** | **97 / 100** |
47
+
48
+ **Original 25-prompt benchmark** (4 pts each): Base 58 → V2 70 → V3 69 → **V3.1 93**.
49
+
50
+ ## Usage
51
+
52
+ ```bash
53
+ # Ollama (pull directly from this repo)
54
+ ollama run hf.co/tnadmin/Sentinel-NX:Q8_0
55
+ ```
56
+
57
+ ```bash
58
+ # llama.cpp
59
+ ./llama-cli -m sentinel-nx-q8_0.gguf --temp 0 -c 4096 -cnv \
60
+ -sys "You are a Cisco IOS-XE configuration assistant. Output only strict, valid configuration for exactly what is requested. Do not invent values."
61
+ ```
62
+
63
+ **Strict behavior is prompt-conditioned.** The model suppresses over-completion when the
64
+ system prompt and request instruct it to (e.g. "Do not add descriptions, no shutdown,
65
+ spanning-tree, or anything not explicitly requested"). Use a strict prompt for best results.
66
+
67
+ ## Known limitations
68
+
69
+ - OSPF router-id is occasionally emitted as `ip ospf <process> router-id <id>` under an
70
+ interface instead of `router-id` under `router ospf <process>`. Targeted corrective data
71
+ is the next iteration.
72
+
73
+ ## Training
74
+
75
+ QLoRA (LoRA rank 16) on Qwen2.5-Coder-3B-Instruct, RTX 4070 12 GB. ~5,200 curated +
76
+ failure-driven remedial IOS-XE instruction pairs, built through three corrective rounds
77
+ (V2 → V3 → V3.1). See the GitHub repo for the full methodology.
78
+
79
+ ## License & attribution
80
+
81
+ This model is a derivative of **Qwen2.5-Coder-3B-Instruct** and is distributed under the
82
+ **Qwen Research License — non-commercial use only**. Built with Qwen.
83
+ Copyright (c) Alibaba Cloud. All Rights Reserved.