fib-quant 0.1.0-beta.2

Experimental Rust implementation of the FibQuant radial-angular vector quantization core
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
//! Compressed-domain attention: approximate logits on compressed keys,
//! top-K value decode only.
//!
//! This module implements the core insight of compressed attention: you
//! don't need to decompress every key vector to compute attention logits.
//! The [`FibScorer`] can estimate `<query, key>` directly from the packed
//! codeword indices via the Gram table, avoiding full decompression of the
//! rotation-inverse + norm-scaling pipeline. Only the top-K value vectors
//! (selected by approximate probability) need to be decompressed.
//!
//! This trades a small amount of logit accuracy for a large reduction in
//! decode work: instead of `N` decompressions, only `top_k` are needed.

use crate::{
    codec::{FibCodeV1, FibQuantizer},
    scoring::FibScorer,
    FibQuantError, Result,
};

/// Output of compressed-domain attention with top-K value decode.
#[derive(Debug, Clone)]
pub struct CompressedAttentionOutput {
    /// Approximate attention logits (pre-softmax), one per key.
    pub logits: Vec<f32>,
    /// Softmax probabilities derived from the approximate logits.
    pub probabilities: Vec<f32>,
    /// Weighted-aggregated output vector (length = head_dim).
    pub output: Vec<f32>,
    /// Indices of the top-K positions selected by probability (descending).
    pub top_k_indices: Vec<usize>,
    /// Number of value vectors actually decompressed (should be ≤ top_k).
    pub decompression_count: usize,
}

/// Compute approximate attention logits on compressed keys WITHOUT full
/// decompression.
///
/// Uses [`FibScorer::prepare_query`] + [`FibScorer::score_prepared`] for
/// efficient batch scoring: the query is rotated and quantized once, then
/// each compressed key is scored via Gram-table lookup only — no
/// rotation-inverse or codeword reconstruction is needed.
///
/// The logits are scaled by `1/sqrt(head_dim)` as in standard scaled
/// dot-product attention, where `head_dim = query.len()`.
///
/// # Arguments
/// * `query` — Query vector, length = ambient_dim (= head_dim).
/// * `compressed_keys` — Compressed key codes (`FibCodeV1`).
/// * `scorer` — [`FibScorer`] wrapping the quantizer and Gram table.
///
/// # Errors
/// Returns [`FibQuantError::ZeroDimension`] if the query is empty,
/// [`FibQuantError::CorruptPayload`] if any input is non-finite.
pub fn compressed_attention_logits(
    query: &[f32],
    compressed_keys: &[FibCodeV1],
    scorer: &FibScorer,
) -> Result<Vec<f32>> {
    if query.is_empty() {
        return Err(FibQuantError::ZeroDimension);
    }
    if compressed_keys.is_empty() {
        return Ok(Vec::new());
    }
    check_finite(query)?;

    let head_dim = query.len();
    let scale = (head_dim as f64).sqrt() as f32;

    // Prepare the query once for batch scoring (rotation + argmin).
    let prepared = scorer.prepare_query(query)?;

    let mut logits = Vec::with_capacity(compressed_keys.len());
    for code in compressed_keys {
        let ip = scorer.score_prepared(&prepared, code)?;
        logits.push(ip / scale);
    }
    Ok(logits)
}

/// Compute compressed-domain attention with top-K value decode.
///
/// Pipeline:
/// 1. Compute approximate logits on compressed keys (no decompression).
/// 2. Softmax the logits to get attention probabilities.
/// 3. Select top-K positions by probability (descending).
/// 4. Decode ONLY the top-K value vectors via [`FibQuantizer::decode`].
/// 5. Weighted-aggregate the top-K decoded values by their probabilities.
///
/// The `decompression_count` in the output will be `min(top_k, len)` — NOT
/// the total number of values. This is the key efficiency win: with `N`
/// stored positions and `top_k << N`, only `top_k` decode operations are
/// performed instead of `N`.
///
/// # Arguments
/// * `query` — Query vector, length = ambient_dim (= head_dim).
/// * `compressed_keys` — Compressed key codes.
/// * `compressed_values` — Compressed value codes (same length as keys).
/// * `scorer` — [`FibScorer`] for approximate inner product scoring.
/// * `quantizer` — [`FibQuantizer`] for decoding value vectors.
/// * `top_k` — Number of top-probability positions to decompress and aggregate.
///
/// # Errors
/// Returns [`FibQuantError::ZeroDimension`] if the query is empty,
/// [`FibQuantError::CorruptPayload`] if keys/values length mismatch or
/// any input is non-finite.
pub fn compressed_attention_topk(
    query: &[f32],
    compressed_keys: &[FibCodeV1],
    compressed_values: &[FibCodeV1],
    scorer: &FibScorer,
    quantizer: &FibQuantizer,
    top_k: usize,
) -> Result<CompressedAttentionOutput> {
    if query.is_empty() {
        return Err(FibQuantError::ZeroDimension);
    }
    if compressed_keys.is_empty() {
        return Err(FibQuantError::CorruptPayload(
            "compressed_attention_topk: empty keys".into(),
        ));
    }
    if compressed_keys.len() != compressed_values.len() {
        return Err(FibQuantError::CorruptPayload(format!(
            "compressed_attention_topk: {} keys but {} values",
            compressed_keys.len(),
            compressed_values.len()
        )));
    }
    check_finite(query)?;

    // 1. Compute approximate logits on compressed keys (no decompression).
    let logits = compressed_attention_logits(query, compressed_keys, scorer)?;

    // 2. Softmax → attention probabilities.
    let probabilities = softmax(&logits)?;

    // 3. Select top-K positions by descending probability.
    let n = compressed_keys.len();
    let k = top_k.min(n).max(1);
    let top_k_indices = topk_indices_by_probability(&probabilities, k);

    // 4. Decode ONLY the top-K value vectors and weighted-aggregate.
    let head_dim = query.len();
    let mut output = vec![0.0f64; head_dim];
    let mut decompression_count = 0usize;

    for &idx in &top_k_indices {
        let decoded = quantizer.decode(&compressed_values[idx])?;
        decompression_count += 1;
        let prob = f64::from(probabilities[idx]);
        for (channel, acc) in decoded.iter().zip(output.iter_mut()) {
            *acc += prob * f64::from(*channel);
        }
    }

    let output: Vec<f32> = output.into_iter().map(|v| v as f32).collect();

    Ok(CompressedAttentionOutput {
        logits,
        probabilities,
        output,
        top_k_indices,
        decompression_count,
    })
}

// ──────────────────────────────────────────────────────────────────────
//  Internal helpers
// ──────────────────────────────────────────────────────────────────────

/// Numerically stable softmax with max-subtraction (f64 accumulator).
fn softmax(logits: &[f32]) -> Result<Vec<f32>> {
    if logits.is_empty() {
        return Err(FibQuantError::ZeroDimension);
    }
    check_finite(logits)?;
    let max = logits
        .iter()
        .copied()
        .fold(f32::NEG_INFINITY, |acc, v| acc.max(v));
    let mut sum = 0.0f64;
    let mut exps = Vec::with_capacity(logits.len());
    for &v in logits {
        let exp = f64::from(v - max).exp();
        sum += exp;
        exps.push(exp);
    }
    if !sum.is_finite() || sum <= 0.0 {
        return Err(FibQuantError::NumericalFailure(
            "compressed attention softmax underflow".into(),
        ));
    }
    Ok(exps.into_iter().map(|e| (e / sum) as f32).collect())
}

/// Select top-K indices by descending probability.
/// Ties are broken by ascending index for determinism.
fn topk_indices_by_probability(probabilities: &[f32], k: usize) -> Vec<usize> {
    let mut indexed: Vec<(usize, f32)> = probabilities.iter().copied().enumerate().collect();
    // Sort by descending probability, ties broken by ascending index.
    indexed.sort_by(|a, b| b.1.total_cmp(&a.1).then_with(|| a.0.cmp(&b.0)));
    indexed.into_iter().take(k).map(|(idx, _)| idx).collect()
}

/// Check that all values are finite.
fn check_finite(values: &[f32]) -> Result<()> {
    if values.iter().any(|v| !v.is_finite()) {
        return Err(FibQuantError::CorruptPayload(
            "compressed attention input contains non-finite value".into(),
        ));
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::profile::FibQuantProfileV1;

    /// Build a test quantizer: ambient_dim=8, block_dim=2, codebook_size=32.
    fn build_test_quantizer() -> Result<FibQuantizer> {
        let profile = FibQuantProfileV1::paper_default(8, 2, 32, 7)?;
        FibQuantizer::new(profile)
    }

    /// Simple MSE between two slices (for test assertions only).
    fn mse(a: &[f32], b: &[f32]) -> f64 {
        assert_eq!(a.len(), b.len(), "mse length mismatch");
        if a.is_empty() {
            return 0.0;
        }
        let sum: f64 = a
            .iter()
            .zip(b)
            .map(|(x, y)| {
                let d = f64::from(*x) - f64::from(*y);
                d * d
            })
            .sum();
        sum / a.len() as f64
    }

    #[test]
    fn test_compressed_attention_vs_reference() -> Result<()> {
        let quantizer = build_test_quantizer()?;
        let scorer = FibScorer::new(quantizer.clone())?;
        let head_dim = 8usize;

        // Synthetic query
        let query: Vec<f32> = vec![0.1, -0.2, 0.3, 0.4, -0.5, 0.6, -0.7, 0.8];

        // 6 synthetic key/value positions
        let raw_keys: Vec<Vec<f32>> = vec![
            vec![0.8, -0.1, 0.2, 0.3, -0.4, 0.5, -0.6, 0.7],
            vec![-0.3, 0.4, -0.5, 0.6, 0.7, -0.8, 0.1, -0.2],
            vec![0.5, 0.5, -0.5, 0.1, 0.2, -0.3, 0.4, 0.5],
            vec![-0.2, 0.3, 0.4, -0.6, 0.5, -0.1, 0.2, -0.7],
            vec![0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.1],
            vec![0.6, -0.5, 0.4, -0.3, 0.2, -0.1, 0.8, -0.6],
        ];
        let raw_values: Vec<Vec<f32>> = vec![
            vec![0.2, 0.3, -0.1, 0.5, 0.4, -0.2, 0.6, 0.1],
            vec![-0.5, 0.4, 0.3, -0.2, 0.6, 0.1, -0.3, 0.5],
            vec![0.7, -0.3, 0.2, 0.4, -0.1, 0.5, 0.3, -0.4],
            vec![0.1, -0.6, 0.3, 0.2, -0.4, 0.7, -0.1, 0.3],
            vec![0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3],
            vec![-0.2, 0.5, -0.4, 0.6, -0.3, 0.2, 0.7, -0.5],
        ];

        // Encode keys and values
        let compressed_keys: Vec<FibCodeV1> = raw_keys
            .iter()
            .map(|k| quantizer.encode(k))
            .collect::<Result<Vec<_>>>()?;
        let compressed_values: Vec<FibCodeV1> = raw_values
            .iter()
            .map(|v| quantizer.encode(v))
            .collect::<Result<Vec<_>>>()?;

        // --- Compressed attention (top-K = 4) ---
        let top_k = 4usize;
        let compressed_out = compressed_attention_topk(
            &query,
            &compressed_keys,
            &compressed_values,
            &scorer,
            &quantizer,
            top_k,
        )?;

        // Verify structural properties
        assert_eq!(
            compressed_out.decompression_count, top_k,
            "decompression_count should be {}, got {}",
            top_k, compressed_out.decompression_count
        );
        assert_eq!(compressed_out.top_k_indices.len(), top_k);
        assert_eq!(compressed_out.output.len(), head_dim);
        assert_eq!(compressed_out.logits.len(), raw_keys.len());
        assert_eq!(compressed_out.probabilities.len(), raw_keys.len());

        // Probabilities should sum to ~1.0
        let prob_sum: f64 = compressed_out
            .probabilities
            .iter()
            .map(|p| f64::from(*p))
            .sum();
        assert!(
            (prob_sum - 1.0).abs() < 1e-5,
            "probabilities should sum to 1.0, got {}",
            prob_sum
        );

        // --- Reference: decode ALL keys and values, compute exact attention ---
        let decoded_keys: Vec<Vec<f32>> = compressed_keys
            .iter()
            .map(|c| quantizer.decode(c))
            .collect::<Result<Vec<_>>>()?;
        let decoded_values: Vec<Vec<f32>> = compressed_values
            .iter()
            .map(|c| quantizer.decode(c))
            .collect::<Result<Vec<_>>>()?;

        let flat_decoded_keys: Vec<f32> = decoded_keys.iter().flatten().copied().collect();
        let flat_decoded_values: Vec<f32> = decoded_values.iter().flatten().copied().collect();

        let ref_logits = super::super::attention_ref::reference_attention_logits(
            &query,
            &flat_decoded_keys,
            head_dim,
        )?;
        let ref_probs = softmax_local(&ref_logits)?;
        let ref_output = super::super::attention_ref::reference_value_aggregation(
            &ref_probs,
            &flat_decoded_values,
            head_dim,
        )?;

        // Logits should be in the same ballpark (approximate scoring).
        let logit_mse = mse(&compressed_out.logits, &ref_logits);
        assert!(logit_mse < 2.0, "logit MSE too large: {}", logit_mse);

        // Output should be in the same ballpark.
        // The compressed path uses top-K (4 of 6) with approximate probabilities,
        // while the reference uses all 6 with exact probabilities on decoded keys.
        let output_mse = mse(&compressed_out.output, &ref_output);
        assert!(output_mse < 0.5, "output MSE too large: {}", output_mse);

        // Top-K indices should have meaningful overlap with reference top-K.
        let ref_topk = topk_indices_by_probability(&ref_probs, top_k);
        let overlap = compressed_out
            .top_k_indices
            .iter()
            .filter(|idx| ref_topk.contains(idx))
            .count();
        let agreement = overlap as f64 / top_k as f64;
        assert!(
            agreement >= 0.5,
            "top-K agreement too low: {}/{} (compressed={:?}, ref={:?})",
            overlap,
            top_k,
            compressed_out.top_k_indices,
            ref_topk
        );

        Ok(())
    }

    #[test]
    fn test_empty_keys_returns_empty_logits() -> Result<()> {
        let quantizer = build_test_quantizer()?;
        let scorer = FibScorer::new(quantizer.clone())?;
        let query: Vec<f32> = vec![0.1, -0.2, 0.3, 0.4, -0.5, 0.6, -0.7, 0.8];

        let logits = compressed_attention_logits(&query, &[], &scorer)?;
        assert!(logits.is_empty());
        Ok(())
    }

    #[test]
    fn test_single_key_logit_finite() -> Result<()> {
        let quantizer = build_test_quantizer()?;
        let scorer = FibScorer::new(quantizer.clone())?;

        let query: Vec<f32> = vec![0.1, -0.2, 0.3, 0.4, -0.5, 0.6, -0.7, 0.8];
        let key: Vec<f32> = vec![0.5, 0.5, -0.5, 0.1, 0.2, -0.3, 0.4, 0.5];
        let compressed_key = quantizer.encode(&key)?;

        let logits = compressed_attention_logits(&query, &[compressed_key], &scorer)?;
        assert_eq!(logits.len(), 1);
        assert!(logits[0].is_finite());
        Ok(())
    }

    #[test]
    fn test_topk_exceeds_n_clamps() -> Result<()> {
        let quantizer = build_test_quantizer()?;
        let scorer = FibScorer::new(quantizer.clone())?;
        let head_dim = 8usize;

        let query: Vec<f32> = vec![0.1, -0.2, 0.3, 0.4, -0.5, 0.6, -0.7, 0.8];
        let keys: Vec<Vec<f32>> = vec![
            vec![0.8, -0.1, 0.2, 0.3, -0.4, 0.5, -0.6, 0.7],
            vec![-0.3, 0.4, -0.5, 0.6, 0.7, -0.8, 0.1, -0.2],
            vec![0.5, 0.5, -0.5, 0.1, 0.2, -0.3, 0.4, 0.5],
        ];
        let compressed_keys: Vec<FibCodeV1> = keys
            .iter()
            .map(|k| quantizer.encode(k))
            .collect::<Result<Vec<_>>>()?;
        let compressed_values: Vec<FibCodeV1> = compressed_keys.clone();

        // top_k=10 but only 3 keys — should clamp to 3
        let out = compressed_attention_topk(
            &query,
            &compressed_keys,
            &compressed_values,
            &scorer,
            &quantizer,
            10,
        )?;
        assert_eq!(out.decompression_count, 3);
        assert_eq!(out.top_k_indices.len(), 3);
        assert_eq!(out.output.len(), head_dim);
        Ok(())
    }

    /// Local softmax for test comparisons (avoids importing private fns).
    fn softmax_local(logits: &[f32]) -> Result<Vec<f32>> {
        use crate::FibQuantError;
        if logits.is_empty() {
            return Err(FibQuantError::ZeroDimension);
        }
        let max = logits
            .iter()
            .copied()
            .fold(f32::NEG_INFINITY, |acc, v| acc.max(v));
        let mut sum = 0.0f64;
        let mut exps = Vec::with_capacity(logits.len());
        for &v in logits {
            let exp = f64::from(v - max).exp();
            sum += exp;
            exps.push(exp);
        }
        Ok(exps.into_iter().map(|e| (e / sum) as f32).collect())
    }
}