mudler commited on
Commit
c3dc0c0
·
verified ·
1 Parent(s): 4b45946

Add/update model card for nano

Browse files
Files changed (1) hide show
  1. README.md +74 -0
README.md ADDED
@@ -0,0 +1,74 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ library_name: rfdetr.cpp
4
+ tags:
5
+ - object-detection
6
+ - rfdetr
7
+ - gguf
8
+ - ggml
9
+ - cpp-inference
10
+ pipeline_tag: object-detection
11
+ base_model: roboflow/rfdetr
12
+ ---
13
+
14
+ # RF-DETR Nano — GGUF for rfdetr.cpp
15
+
16
+ GGUF-format weights of [Roboflow RF-DETR Nano](https://github.com/roboflow/rf-detr) (detection variant) for use with [rfdetr.cpp](https://github.com/mudler/rf-detr.cpp), a C++/ggml implementation that matches the upstream PyTorch model on CPU.
17
+
18
+ This repo contains all four standard quantizations of this variant. **F16 is the recommended default** — same accuracy as F32, 1.85× smaller, and typically the fastest on modern CPUs thanks to ggml's F32×F16 matmul fast path.
19
+
20
+ ## Available files
21
+
22
+ | File | Quant | Size (MB) | Recall @ IoU 0.5 | Recall @ IoU 0.95 | Mean \|Δscore\| | Latency (median ms, T=8) |
23
+ |---|---|---:|---:|---:|---:|---:|
24
+ | `rfdetr-nano-f32.gguf` | F32 | 112.7 | 0.9890 | 0.9890 | 0.0068 | 55.8 |
25
+ | `rfdetr-nano-f16.gguf` ← **recommended** | F16 | 60.5 | 0.9890 | 0.9890 | 0.0070 | 49.6 |
26
+ | `rfdetr-nano-q8_0.gguf` | Q8_0 | 36.0 | 0.9890 | 0.9890 | 0.0084 | 59.3 |
27
+ | `rfdetr-nano-q4_K.gguf` | Q4_K | 29.7 | 0.9162 | 0.7585 | 0.0303 | 60.6 |
28
+
29
+ All accuracy numbers are computed against the upstream PyTorch reference (`rfdetr 1.7.0`) on 7 COCO val2017 images at threshold 0.5. Latency is measured with `rfdetr-cli bench` (8 iters + 3 warmup) at T=8 threads on a single AMD Ryzen 9 9950X3D image (`coco_kitchen.jpg`, 640x427).
30
+
31
+ ## Architecture
32
+
33
+ - Backbone: DINOv2-small
34
+ - Input resolution: 384×384
35
+ - Patch size: 14
36
+ - Decoder layers: 2
37
+ - Object queries: 300
38
+ - Task: object detection (boxes only)
39
+
40
+ ## Quantization notes
41
+
42
+ - **F32** — full-precision reference, ~120 MB. Bit-exact PyTorch parity.
43
+ - **F16** — matmul-multiplicand weights only; LayerNorms, conv kernels, embeddings, biases, and layer-scale gammas stay F32. Lossless on this model and consistently the fastest variant on CPU.
44
+ - **Q8_0** — best size/accuracy tradeoff under F16; ~3× smaller than F32 with effectively identical detections.
45
+ - **Q4_K** — smallest practical quant. Rows with `ne[0] % 256 != 0` (the decoder's 128-dim MLP halves, 60 tensors) silently fall back to Q8_0 per ggml's quantizer logic — net compression is still ~3.8× over F32. Use only when the size budget is tight; expect a measurable Recall@0.95 drop relative to F16/Q8_0 (see file table above).
46
+
47
+ ## Usage
48
+
49
+ ```bash
50
+ # 1. Clone + build rfdetr.cpp
51
+ git clone https://github.com/mudler/rf-detr.cpp
52
+ cd rt-detr.cpp
53
+ cmake -B build -DRFDETR_BUILD_CLI=ON && cmake --build build -j
54
+
55
+ # 2. Download a quant (F16 recommended)
56
+ hf download mudler/rfdetr-cpp-nano rfdetr-nano-f16.gguf --local-dir models/
57
+
58
+ # 3. Run detection
59
+ build/bin/rfdetr-cli detect \
60
+ --model models/rfdetr-nano-f16.gguf \
61
+ --input my_image.jpg \
62
+ --threshold 0.5 --threads 8 \
63
+ --output detections.json
64
+ ```
65
+
66
+ ## Accuracy methodology
67
+
68
+ All accuracy metrics are computed against the upstream PyTorch reference (rfdetr 1.7.0) on 7 COCO val2017 images at threshold 0.5. Each detection match uses greedy Hungarian-style assignment by IoU (≥ 0.5 lenient, ≥ 0.95 strict) with class equality required.
69
+
70
+ See [BENCHMARK.md](https://github.com/mudler/rf-detr.cpp/blob/main/BENCHMARK.md) and [`benchmarks/results/accuracy_sweep.json`](https://github.com/mudler/rf-detr.cpp/blob/main/benchmarks/results/accuracy_sweep.json) for the full sweep across all 32 (variant × quant) cells.
71
+
72
+ ## License
73
+
74
+ Apache-2.0 — matches the upstream [rfdetr](https://github.com/roboflow/rf-detr) license.