apr-cli 0.64.0

CLI tool for APR model inspection, debugging, and operations
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490

    // ========================================================================
    // infer_layers_from_tensor_names: comprehensive
    // ========================================================================

    #[test]
    fn test_infer_layers_empty() {
        let layers = infer_layers_from_tensor_names(&[], None);
        assert!(layers.is_empty());
    }

    #[test]
    fn test_infer_layers_with_embedding() {
        let names = vec!["model.embed_tokens.weight"];
        let layers = infer_layers_from_tensor_names(&names, None);
        assert_eq!(layers.len(), 1);
        assert_eq!(layers[0].name, "embedding");
    }

    #[test]
    fn test_infer_layers_with_wte() {
        let names = vec!["wte.weight"];
        let layers = infer_layers_from_tensor_names(&names, None);
        assert_eq!(layers.len(), 1);
        assert_eq!(layers[0].name, "embedding");
    }

    #[test]
    fn test_infer_layers_with_lm_head() {
        let names = vec!["lm_head.weight"];
        let layers = infer_layers_from_tensor_names(&names, None);
        assert_eq!(layers.len(), 1);
        assert_eq!(layers[0].name, "lm_head");
    }

    #[test]
    fn test_infer_layers_with_output_tensor() {
        let names = vec!["output.weight"];
        let layers = infer_layers_from_tensor_names(&names, None);
        assert_eq!(layers.len(), 1);
        assert_eq!(layers[0].name, "lm_head");
    }

    #[test]
    fn test_infer_layers_full_model() {
        let names = vec![
            "model.embed_tokens.weight",
            "model.layers.0.self_attn.q_proj.weight",
            "model.layers.0.self_attn.k_proj.weight",
            "model.layers.1.self_attn.q_proj.weight",
            "model.layers.2.mlp.gate_proj.weight",
            "lm_head.weight",
        ];
        let layers = infer_layers_from_tensor_names(&names, None);
        // Should have: embedding + 3 transformer blocks + lm_head = 5
        assert_eq!(layers.len(), 5);
        assert_eq!(layers[0].name, "embedding");
        assert_eq!(layers[1].name, "transformer_block_0");
        assert_eq!(layers[2].name, "transformer_block_1");
        assert_eq!(layers[3].name, "transformer_block_2");
        assert_eq!(layers[4].name, "lm_head");
    }

    #[test]
    fn test_infer_layers_with_filter_matching() {
        let names = vec![
            "model.embed_tokens.weight",
            "model.layers.0.self_attn.weight",
            "model.layers.1.self_attn.weight",
            "lm_head.weight",
        ];
        let layers = infer_layers_from_tensor_names(&names, Some("block_1"));
        // Filter should only include block_1
        assert!(layers.iter().any(|l| l.name == "transformer_block_1"));
        // Should not include block_0
        assert!(!layers.iter().any(|l| l.name == "transformer_block_0"));
    }

    #[test]
    fn test_infer_layers_with_filter_embedding() {
        let names = vec!["model.embed_tokens.weight", "model.layers.0.weight"];
        let layers = infer_layers_from_tensor_names(&names, Some("embedding"));
        assert!(layers.iter().any(|l| l.name == "embedding"));
    }

    #[test]
    fn test_infer_layers_with_filter_no_match() {
        let names = vec!["model.layers.0.weight", "model.layers.1.weight"];
        let layers = infer_layers_from_tensor_names(&names, Some("nonexistent"));
        assert!(layers.is_empty());
    }

    #[test]
    fn test_infer_layers_sorted_indices() {
        let names = vec![
            "model.layers.5.weight",
            "model.layers.0.weight",
            "model.layers.3.weight",
        ];
        let layers = infer_layers_from_tensor_names(&names, None);
        // BTreeMap ensures sorted order
        assert_eq!(layers[0].name, "transformer_block_0");
        assert_eq!(layers[1].name, "transformer_block_3");
        assert_eq!(layers[2].name, "transformer_block_5");
    }

    // ========================================================================
    // create_* helper function tests
    // ========================================================================

    /// #2407: this test used to assert `output_stats.expect(...)` with
    /// `count == 768` — i.e. it required the fabricated statistics block to be
    /// present. Nothing is measured on this path: no tensor is read, so mean,
    /// std, l2_norm, min, max and max_abs were all hard-coded 0.0 and a client
    /// checking `l2_norm == 0.0` saw a dead embedding on a healthy model. The
    /// declared width is now reported as `hidden_dim`, which is what it is.
    #[test]
    fn test_create_embedding_layer_reports_width_not_fabricated_stats() {
        let layer = create_embedding_layer(768);
        assert_eq!(layer.name, "embedding");
        assert_eq!(layer.index, None);
        assert!(layer.anomalies.is_empty());
        assert!(
            layer.output_stats.is_none(),
            "no forward pass ran, so no output statistics may be reported"
        );
        assert_eq!(layer.hidden_dim, Some(768));
    }

    #[test]
    fn test_create_embedding_layer_zero_dim() {
        let layer = create_embedding_layer(0);
        assert!(layer.output_stats.is_none());
        assert_eq!(
            layer.hidden_dim, None,
            "an unknown width is absent, not reported as 0"
        );
    }

    #[test]
    fn test_create_final_layer_norm() {
        let layer = create_final_layer_norm();
        assert_eq!(layer.name, "final_layer_norm");
        assert_eq!(layer.index, None);
        assert!(layer.input_stats.is_none());
        assert!(layer.output_stats.is_none());
        assert!(layer.weight_stats.is_none());
        assert!(layer.anomalies.is_empty());
    }

    #[test]
    fn test_create_default_layer() {
        let layer = create_default_layer();
        assert!(layer.name.contains("not available"));
        assert_eq!(layer.index, None);
        assert_eq!(layer.anomalies.len(), 1);
        assert!(layer.anomalies[0].contains("No layer information"));
    }

    // ========================================================================
    // create_transformer_layers tests
    // ========================================================================

    #[test]
    fn test_create_transformer_layers_zero() {
        let layers = create_transformer_layers(0);
        assert!(layers.is_empty());
    }

    #[test]
    fn test_create_transformer_layers_basic() {
        let layers = create_transformer_layers(3);
        assert_eq!(layers.len(), 3);
        assert_eq!(layers[0].name, "transformer_block_0");
        assert_eq!(layers[0].index, Some(0));
        assert_eq!(layers[1].name, "transformer_block_1");
        assert_eq!(layers[1].index, Some(1));
        assert_eq!(layers[2].name, "transformer_block_2");
        assert_eq!(layers[2].index, Some(2));
    }

    // #2407: filtering moved out of the constructors into apply_layer_filter,
    // which is applied once to a fully-built skeleton. These tests follow it.

    #[test]
    fn test_apply_layer_filter_with_filter() {
        let (layers, notes) = apply_layer_filter(create_transformer_layers(10), Some("block_5"));
        assert_eq!(layers.len(), 1);
        assert_eq!(layers[0].name, "transformer_block_5");
        assert!(notes.is_empty(), "a filter that matched needs no note");
    }

    #[test]
    fn test_apply_layer_filter_no_match_returns_empty_and_says_so() {
        // The old behaviour: an empty result here let the caller's
        // `if layers.is_empty()` fallback fabricate a
        // "(layer trace metadata not available)" layer carrying the anomaly
        // "No layer information in metadata" — on a model with 3 real layers.
        let (layers, notes) = apply_layer_filter(create_transformer_layers(3), Some("nonexistent"));
        assert!(layers.is_empty(), "nothing matched, so nothing is returned");
        assert_eq!(notes, vec![r#"layer filter "nonexistent" matched 0 of 3 layers"#]);
    }

    #[test]
    fn test_apply_layer_filter_multiple_match() {
        // Filter "block_1" matches "transformer_block_1" and "transformer_block_10" etc.
        let (layers, notes) = apply_layer_filter(create_transformer_layers(15), Some("block_1"));
        // Matches: block_1, block_10, block_11, block_12, block_13, block_14
        assert!(!layers.is_empty());
        assert!(layers.iter().any(|l| l.name == "transformer_block_1"));
        assert!(notes.is_empty());
    }

    #[test]
    fn test_apply_layer_filter_none_is_a_passthrough() {
        let (layers, notes) = apply_layer_filter(create_transformer_layers(4), None);
        assert_eq!(layers.len(), 4);
        assert!(notes.is_empty());
    }

    // ========================================================================
    // compute_trace_summary tests
    // ========================================================================

    #[test]
    fn test_compute_trace_summary_empty() {
        let summary = compute_trace_summary(&[], 0);
        assert_eq!(summary.total_layers, 0);
        assert_eq!(summary.total_parameters, 0);
        assert_eq!(summary.anomaly_count, 0);
        assert!(summary.anomalies.is_empty());
    }

    #[test]
    fn test_compute_trace_summary_no_anomalies() {
        let layers = vec![
            LayerTrace {
                name: "layer_0".to_string(),
                index: Some(0),
                hidden_dim: None,
                input_stats: None,
                output_stats: None,
                weight_stats: None,
                anomalies: vec![],
            },
            LayerTrace {
                name: "layer_1".to_string(),
                index: Some(1),
                hidden_dim: None,
                input_stats: None,
                output_stats: None,
                weight_stats: None,
                anomalies: vec![],
            },
        ];
        let summary = compute_trace_summary(&layers, 1000);
        assert_eq!(summary.total_layers, 2);
        assert_eq!(summary.total_parameters, 1000);
        assert_eq!(summary.anomaly_count, 0);
    }

    #[test]
    fn test_compute_trace_summary_with_anomalies() {
        let layers = vec![
            LayerTrace {
                name: "layer_0".to_string(),
                index: Some(0),
                hidden_dim: None,
                input_stats: None,
                output_stats: None,
                weight_stats: None,
                anomalies: vec!["NaN detected".to_string()],
            },
            LayerTrace {
                name: "layer_1".to_string(),
                index: Some(1),
                hidden_dim: None,
                input_stats: None,
                output_stats: None,
                weight_stats: None,
                anomalies: vec!["Inf detected".to_string(), "Large mean".to_string()],
            },
        ];
        let summary = compute_trace_summary(&layers, 5000);
        assert_eq!(summary.total_layers, 2);
        assert_eq!(summary.total_parameters, 5000);
        assert_eq!(summary.anomaly_count, 3);
        assert_eq!(summary.anomalies.len(), 3);
    }

    // ========================================================================
    // extract_layer_count / extract_model_dimension tests
    // ========================================================================

    #[test]
    fn test_extract_layer_count_n_layer() {
        let mut hp = serde_json::Map::new();
        hp.insert("n_layer".to_string(), serde_json::json!(32));
        assert_eq!(extract_layer_count(&hp), 32);
    }

    #[test]
    fn test_extract_layer_count_n_layers() {
        let mut hp = serde_json::Map::new();
        hp.insert("n_layers".to_string(), serde_json::json!(24));
        assert_eq!(extract_layer_count(&hp), 24);
    }

    #[test]
    fn test_extract_layer_count_missing() {
        let hp = serde_json::Map::new();
        assert_eq!(extract_layer_count(&hp), 0);
    }

    #[test]
    fn test_extract_layer_count_prefers_n_layer() {
        let mut hp = serde_json::Map::new();
        hp.insert("n_layer".to_string(), serde_json::json!(32));
        hp.insert("n_layers".to_string(), serde_json::json!(24));
        // n_layer is checked first
        assert_eq!(extract_layer_count(&hp), 32);
    }

    #[test]
    fn test_extract_model_dimension_n_embd() {
        let mut hp = serde_json::Map::new();
        hp.insert("n_embd".to_string(), serde_json::json!(768));
        assert_eq!(extract_model_dimension(&hp), 768);
    }

    #[test]
    fn test_extract_model_dimension_d_model() {
        let mut hp = serde_json::Map::new();
        hp.insert("d_model".to_string(), serde_json::json!(512));
        assert_eq!(extract_model_dimension(&hp), 512);
    }

    #[test]
    fn test_extract_model_dimension_missing() {
        let hp = serde_json::Map::new();
        assert_eq!(extract_model_dimension(&hp), 0);
    }

    #[test]
    fn test_extract_model_dimension_prefers_n_embd() {
        let mut hp = serde_json::Map::new();
        hp.insert("n_embd".to_string(), serde_json::json!(768));
        hp.insert("d_model".to_string(), serde_json::json!(512));
        assert_eq!(extract_model_dimension(&hp), 768);
    }

    // ========================================================================
    // extract_layers_from_hyperparameters tests
    // ========================================================================

    #[test]
    fn test_extract_layers_from_hyperparameters_basic() {
        let mut hp = serde_json::Map::new();
        hp.insert("n_layer".to_string(), serde_json::json!(3));
        hp.insert("n_embd".to_string(), serde_json::json!(256));

        let layers = extract_layers_from_hyperparameters(&hp);
        // embedding + 3 transformer blocks + final_layer_norm = 5
        assert_eq!(layers.len(), 5);
        assert_eq!(layers[0].name, "embedding");
        assert_eq!(layers[1].name, "transformer_block_0");
        assert_eq!(layers[2].name, "transformer_block_1");
        assert_eq!(layers[3].name, "transformer_block_2");
        assert_eq!(layers[4].name, "final_layer_norm");
    }

    #[test]
    fn test_extract_layers_from_hyperparameters_zero_layers() {
        let mut hp = serde_json::Map::new();
        hp.insert("n_embd".to_string(), serde_json::json!(256));
        // no n_layer key → 0 layers

        let layers = extract_layers_from_hyperparameters(&hp);
        // embedding + 0 transformer + final_layer_norm = 2
        assert_eq!(layers.len(), 2);
        assert_eq!(layers[0].name, "embedding");
        assert_eq!(layers[1].name, "final_layer_norm");
    }

    #[test]
    fn test_extract_layers_from_hyperparameters_with_filter() {
        let mut hp = serde_json::Map::new();
        hp.insert("n_layer".to_string(), serde_json::json!(5));
        hp.insert("n_embd".to_string(), serde_json::json!(256));

        let (layers, notes) =
            apply_layer_filter(extract_layers_from_hyperparameters(&hp), Some("block_3"));
        // Only transformer_block_3 matches the filter
        assert!(layers.iter().any(|l| l.name == "transformer_block_3"));
        assert!(notes.is_empty());
    }

    // ========================================================================
    // handle_special_modes tests
    // ========================================================================

    #[test]
    fn test_handle_special_modes_interactive() {
        let path = Path::new("/tmp/model.apr");
        let result = handle_special_modes(path, None, false, false, true);
        assert!(result.is_some());
        assert!(result.expect("should be Some").is_ok());
    }

    /// FALSIFIER (#2394 finding 6): `--diff` without `--reference` must stop.
    ///
    /// `apr trace model.gguf --diff` printed "Diff mode requires --reference"
    /// and then ran an ordinary single-model trace and exited 0 — the tool
    /// stated its own requirement and ignored it, so a scripted diff came back
    /// looking successful. This test used to assert exactly that behaviour
    /// (`result.is_none()`, i.e. "fall through and trace anyway"), which is
    /// why the defect survived: it was the bug's alibi.
    #[test]
    fn test_handle_special_modes_diff_without_reference() {
        let path = Path::new("/tmp/model.apr");
        let result = handle_special_modes(path, None, false, true, false)
            .expect("--diff without --reference must be handled, not fall through to a trace");
        let err = result.expect_err("--diff without --reference must be an error");
        assert!(
            err.to_string().contains("--reference"),
            "the refusal must name the missing flag, got: {err}"
        );
    }

    #[test]
    fn test_handle_special_modes_diff_with_reference() {
        let path = Path::new("/tmp/model.apr");
        let ref_path = Path::new("/tmp/ref.apr");
        // With a reference the combination is valid: diff mode announces the
        // pair and falls through to the trace path (returns None).
        let result = handle_special_modes(path, Some(ref_path), false, true, false);
        assert!(result.is_none());
    }

    #[test]
    fn test_handle_special_modes_none() {
        let path = Path::new("/tmp/model.apr");
        let result = handle_special_modes(path, None, false, false, false);
        assert!(result.is_none());
    }

    // ========================================================================
    // gguf_meta_u32 tests
    // ========================================================================

    #[test]
    fn test_gguf_meta_u32_uint32() {
        use aprender::format::gguf::GgufValue;
        let mut metadata = BTreeMap::new();
        metadata.insert("test.count".to_string(), GgufValue::Uint32(42));
        assert_eq!(gguf_meta_u32(&metadata, "test.count"), Some(42));
    }

    #[test]
    fn test_gguf_meta_u32_uint64() {
        use aprender::format::gguf::GgufValue;
        let mut metadata = BTreeMap::new();
        metadata.insert("test.count".to_string(), GgufValue::Uint64(100));
        assert_eq!(gguf_meta_u32(&metadata, "test.count"), Some(100));
    }

    #[test]
    fn test_gguf_meta_u32_int32() {
        use aprender::format::gguf::GgufValue;
        let mut metadata = BTreeMap::new();
        metadata.insert("test.count".to_string(), GgufValue::Int32(55));
        assert_eq!(gguf_meta_u32(&metadata, "test.count"), Some(55));
    }

    #[test]
    fn test_gguf_meta_u32_string_returns_none() {
        use aprender::format::gguf::GgufValue;
        let mut metadata = BTreeMap::new();
        metadata.insert(
            "test.name".to_string(),
            GgufValue::String("hello".to_string()),
        );
        assert_eq!(gguf_meta_u32(&metadata, "test.name"), None);
    }

    #[test]
    fn test_gguf_meta_u32_missing_key() {
        let metadata: BTreeMap<String, aprender::format::gguf::GgufValue> = BTreeMap::new();
        assert_eq!(gguf_meta_u32(&metadata, "nonexistent"), None);
    }