cortiq-engine 0.8.51

Portable inference runtime for the CMF model format, with no ML framework underneath: runs on CPU, and on GPU (Vulkan / Metal / DX12) with the `gpu` feature; tokenizer, chat templates and dynamic per-skill weight overlay.
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
//! A non-causal forward over one packed sequence, for d1 (`crate::d1`):
//! the System One decision models read a state and a set of questions in
//! one pass in which the full-attention layers see both ways — the state
//! reads and is read by every position, a question's tokens read the state
//! and their own question — while the sliding-window layers stay causal
//! within their window and the short convolutions causal over the row
//! (d1's `attention.Sees`). A child module of `pipeline` so it runs on the
//! layer geometry the decode paths use; it touches no cache.

use super::{Act, AttnKind, FfnKind, Pipeline, dense_ffn_batch};
use crate::inference;
use crate::linear_core::short_conv_forward_batch;
use crate::qtensor::QTensor;
use cortiq_core::NormStyle;

/// d1's `set` mask: positions `[0, state)` are the state; every later
/// position belongs to the question `group[t]`.
pub struct SetMask<'a> {
    pub state: usize,
    pub group: &'a [i32],
}

impl SetMask<'_> {
    /// Whether query `q` reads key `k` in a full-attention layer.
    fn sees(&self, q: usize, k: usize) -> bool {
        q < self.state || k < self.state || self.group[q] == self.group[k]
    }
}

fn rms_rows(x: &[f32], w: &[f32], eps: f64, style: NormStyle, out: &mut [f32]) {
    let d = w.len();
    for (src, dst) in x.chunks_exact(d).zip(out.chunks_exact_mut(d)) {
        inference::rms_norm_into(src, w, eps, style, dst);
    }
}

impl Pipeline {
    /// The final-normed hidden state of every position of `rows` (prompt
    /// embedding rows `[T, hidden]`) under d1's `mask`. Only plain LFM3
    /// stacks (short convolution, full / sliding GQA, dense FFN) qualify.
    /// With them, the log-probabilities over the vocabulary at the rows
    /// `head_rows` (`[head_rows, vocab]`): on the device in the same
    /// submission where it runs, else through [`Self::log_probs_rows`].
    pub(crate) fn forward_masked_head(
        &self,
        rows: &[f32],
        mask: &SetMask,
        head_rows: &[usize],
    ) -> Result<(Vec<f32>, Vec<f32>), String> {
        let hs = self.hidden_size;
        let t = rows.len() / hs;
        if t == 0 || rows.len() != t * hs || mask.group.len() != t || mask.state > t {
            return Err("masked forward: rows, groups and state length disagree".into());
        }
        if let Some((hidden, mut logits)) = self.forward_masked_device(rows, t, mask, head_rows) {
            let v = self.vocab_size;
            if head_rows.is_empty() {
                return Ok((hidden, Vec::new()));
            }
            if logits.len() >= head_rows.len() * v {
                logits.truncate(head_rows.len() * v);
                self.log_softmax_rows(&mut logits);
                return Ok((hidden, logits));
            }
            let picked: Vec<f32> = head_rows.iter().flat_map(|&r| hidden[r * hs..(r + 1) * hs].to_vec()).collect();
            let lp = self.log_probs_rows(&picked, head_rows.len());
            return Ok((hidden, lp));
        }
        let hidden = self.forward_masked_host(rows, t, mask)?;
        if head_rows.is_empty() {
            return Ok((hidden, Vec::new()));
        }
        let picked: Vec<f32> = head_rows.iter().flat_map(|&r| hidden[r * hs..(r + 1) * hs].to_vec()).collect();
        let lp = self.log_probs_rows(&picked, head_rows.len());
        Ok((hidden, lp))
    }

    fn forward_masked_host(&self, rows: &[f32], t: usize, mask: &SetMask) -> Result<Vec<f32>, String> {
        let hs = self.hidden_size;
        let pool = self.pool.as_deref();
        let (eps, style) = (self.rms_eps, self.norm_style);
        let mut h = rows.to_vec();
        let mut normed = vec![0f32; t * hs];
        // CMF_D1_DEBUG: wall time per stage (conv mixers, attention, FFNs).
        let prof = std::env::var_os("CMF_D1_DEBUG").is_some();
        let mut spent = [0f64; 3];
        for li in 0..self.num_layers {
            let t_mix = std::time::Instant::now();
            let lw = &self.weights.layers[self.phys_layer(li)];
            rms_rows(&h, &lw.input_norm, eps, style, &mut normed);
            let mut mixed = match &lw.attn {
                AttnKind::ShortConv(w) => {
                    let cfg = self
                        .short_conv_cfg
                        .ok_or("short-conv layer without its geometry")?;
                    let mut ring = vec![0f32; cfg.state_len()];
                    short_conv_forward_batch(&normed, t, w, &cfg, &mut ring, pool)
                }
                AttnKind::Full {
                    wq,
                    wk,
                    wv,
                    wo,
                    q_norm,
                    k_norm,
                    output_gate: false,
                    softplus_gate,
                    bias: None,
                } => {
                    let ao = self.masked_attention(li, &normed, t, wq, wk, wv, q_norm, k_norm, softplus_gate, mask)?;
                    let mut out = vec![0f32; t * hs];
                    wo.matmat(&ao, t, &mut out, pool);
                    out
                }
                _ => return Err(format!("layer {li}: the masked forward runs LFM3 layers only")),
            };
            let stage = usize::from(!matches!(lw.attn, AttnKind::ShortConv(_)));
            spent[stage] += t_mix.elapsed().as_secs_f64();
            let t_ffn = std::time::Instant::now();
            if let Some(w) = &lw.attn_out_norm {
                let raw = mixed.clone();
                rms_rows(&raw, w, eps, style, &mut mixed);
            }
            for (a, b) in h.iter_mut().zip(&mixed) {
                *a += *b;
            }
            rms_rows(&h, &lw.post_norm, eps, style, &mut normed);
            let FfnKind::Dense(d) = &lw.ffn else {
                return Err(format!("layer {li}: the masked forward runs dense FFNs only"));
            };
            let mut ffn = dense_ffn_batch(d, &normed, t, pool, None);
            if let Some(w) = &lw.ffn_out_norm {
                let raw = ffn.clone();
                rms_rows(&raw, w, eps, style, &mut ffn);
            }
            for (a, b) in h.iter_mut().zip(&ffn) {
                *a += *b;
            }
            spent[2] += t_ffn.elapsed().as_secs_f64();
        }
        if prof {
            eprintln!(
                "d1: masked forward {t} rows: conv {:.0} ms, attention {:.0} ms, FFN {:.0} ms",
                spent[0] * 1e3,
                spent[1] * 1e3,
                spent[2] * 1e3
            );
        }
        rms_rows(&h, &self.weights.final_norm, eps, style, &mut normed);
        Ok(normed)
    }

    /// The same forward on the device in one submission
    /// (`gpu::lfm_set_forward`), or None: a stack or weight outside its
    /// kernels, no device, or `CMF_D1_DEVICE=0`.
    fn forward_masked_device(
        &self,
        rows: &[f32],
        t: usize,
        mask: &SetMask,
        head_rows: &[usize],
    ) -> Option<(Vec<f32>, Vec<f32>)> {
        use crate::gpu::{SetDims, SetHead, SetLayer, SetMixer};
        if std::env::var("CMF_D1_DEVICE").as_deref() == Ok("0") || !crate::gpu::enabled_here() {
            return None;
        }
        let mapped = |q: &QTensor| match q {
            QTensor::Mapped { model, .. } => Some(model.clone()),
            _ => None,
        };
        let model = self.weights.layers.first().and_then(|lw| match &lw.ffn {
            FfnKind::Dense(d) => mapped(&d.gate_proj),
            _ => None,
        })?;
        let part = |q: &QTensor| -> Option<(usize, usize, usize)> {
            match q {
                QTensor::Mapped { model: m, idx, .. } if std::sync::Arc::ptr_eq(m, &model) => {
                    Some((*idx, q.rows(), q.cols()))
                }
                _ => None,
            }
        };
        let hd = self.head_dim;
        let invs: Vec<_> = (0..self.num_layers).map(|li| self.layer_inv_freq(li)).collect();
        let mut layers = Vec::with_capacity(self.num_layers);
        for li in 0..self.num_layers {
            let lw = &self.weights.layers[self.phys_layer(li)];
            let FfnKind::Dense(f) = &lw.ffn else {
                return None;
            };
            if f.act != Act::Silu || !f.segs.is_empty() {
                return None;
            }
            let mixer = match &lw.attn {
                AttnKind::ShortConv(w) => SetMixer::Conv {
                    in_proj: part(&w.in_proj)?,
                    out_proj: part(&w.out_proj)?,
                    taps: &w.conv,
                    kernel: self.short_conv_cfg?.kernel,
                },
                AttnKind::Full {
                    wq,
                    wk,
                    wv,
                    wo,
                    q_norm,
                    k_norm,
                    output_gate: false,
                    softplus_gate,
                    bias: None,
                } => {
                    let (nkv, lhd, rd) = self.layer_geom(li);
                    if lhd != hd || self.layer_num_heads(li) != self.num_heads {
                        return None;
                    }
                    let head_gate = match softplus_gate {
                        None => None,
                        Some((g, true)) if self.proj_gate_sigmoid => {
                            let (data, r, c) = g.f32_parts()?;
                            (r == self.num_heads && c == self.hidden_size).then_some(data)?;
                            Some(data)
                        }
                        Some(_) => return None,
                    };
                    SetMixer::Attn {
                        wq: part(wq)?,
                        wk: part(wk)?,
                        wv: part(wv)?,
                        wo: part(wo)?,
                        q_norm: q_norm.as_deref(),
                        k_norm: k_norm.as_deref(),
                        head_gate,
                        inv_freq: invs[li].as_slice(),
                        rd,
                        nkv,
                        window: self.layer_window(li),
                    }
                }
                _ => return None,
            };
            layers.push(SetLayer {
                input_norm: &lw.input_norm,
                post_norm: &lw.post_norm,
                mixer,
                attn_out_norm: lw.attn_out_norm.as_deref(),
                ffn_out_norm: lw.ffn_out_norm.as_deref(),
                gate: part(&f.gate_proj)?,
                up: part(&f.up_proj)?,
                down: part(&f.down_proj)?,
            });
        }
        if self.qk_norm_after_rope || self.layer_rope_scale(0) != 1.0 {
            return None;
        }
        let dims = SetDims {
            hidden: self.hidden_size,
            nh: self.num_heads,
            hd,
            eps: self.rms_eps as f32,
            gemma: self.norm_style == cortiq_core::NormStyle::Gemma,
            scale: self.attn_scale,
        };
        // The head rides along when it is a mapped projection of the file
        // as wide as the vocabulary.
        let head = part(&self.weights.lm_head)
            .filter(|w| w.1 == self.vocab_size && !head_rows.is_empty())
            .map(|w| SetHead { w, rows: head_rows });
        crate::gpu::lfm_set_forward(
            &model,
            &layers,
            &dims,
            &self.weights.final_norm,
            rows,
            t,
            mask.state,
            mask.group,
            head.as_ref(),
        )
    }

    /// One full or sliding attention layer over the packed row: Q/K/V, the
    /// per-head norms, RoPE at each row's own position, attention under the
    /// layer's window (causal) or `mask` (both ways), the per-head gate.
    /// Returns `[T, heads·hd]`, ready for O.
    #[allow(clippy::too_many_arguments)]
    fn masked_attention(
        &self,
        li: usize,
        x: &[f32],
        t: usize,
        wq: &QTensor,
        wk: &QTensor,
        wv: &QTensor,
        q_norm: &Option<Vec<f32>>,
        k_norm: &Option<Vec<f32>>,
        gate: &Option<(QTensor, bool)>,
        mask: &SetMask,
    ) -> Result<Vec<f32>, String> {
        let pool = self.pool.as_deref();
        let nh = self.layer_num_heads(li);
        let (nkv, hd, rd) = self.layer_geom(li);
        let (qd, kvd) = (nh * hd, nkv * hd);
        let inv = self.layer_inv_freq(li);
        let rope_scale = self.layer_rope_scale(li);
        let window = self.layer_window(li);
        if rd != 2 * inv.len() || nkv == 0 || nh % nkv != 0 {
            return Err(format!("layer {li}: unsupported attention geometry"));
        }
        let mut q = vec![0f32; t * qd];
        let mut k = vec![0f32; t * kvd];
        let mut v = vec![0f32; t * kvd];
        wq.matmat(x, t, &mut q, pool);
        wk.matmat(x, t, &mut k, pool);
        wv.matmat(x, t, &mut v, pool);
        let mut tmp = vec![0f32; hd];
        for (buf, norm, heads) in [(&mut q, q_norm, nh), (&mut k, k_norm, nkv)] {
            for pos in 0..t {
                for hh in 0..heads {
                    let head = &mut buf[(pos * heads + hh) * hd..(pos * heads + hh + 1) * hd];
                    if let Some(w) = norm {
                        inference::rms_norm_into(head, w, self.rms_eps, self.norm_style, &mut tmp);
                        head.copy_from_slice(&tmp);
                    }
                    crate::attention::rope_rotate_scaled(&mut head[..rd], pos, &inv, rope_scale);
                }
            }
        }
        // One head at a time: scores [T, T] through the host GEMM, the
        // layer's mask, a row softmax, then P·V.
        let group = nh / nkv;
        let scale = self.attn_scale;
        let mut out = vec![0f32; t * qd];
        let mut qh = vec![0f32; t * hd];
        let mut kh = vec![0f32; t * hd];
        let mut vt = vec![0f32; hd * t];
        let mut sc = vec![0f32; t * t];
        let mut oh = vec![0f32; t * hd];
        for g in 0..nkv {
            for j in 0..t {
                kh[j * hd..(j + 1) * hd].copy_from_slice(&k[j * kvd + g * hd..j * kvd + (g + 1) * hd]);
                for d in 0..hd {
                    vt[d * t + j] = v[j * kvd + g * hd + d];
                }
            }
            for hh in g * group..(g + 1) * group {
                for i in 0..t {
                    for d in 0..hd {
                        qh[i * hd + d] = q[i * qd + hh * hd + d] * scale;
                    }
                }
                crate::fcd_ops::gemm_nt_host(&qh, &kh, &mut sc, t, hd, t, pool);
                {
                    let sp = crate::pool::SendMut::new(sc.as_mut_ptr());
                    let f = |lo: usize, hi: usize| {
                        for i in lo..hi {
                            // SAFETY: disjoint score rows per worker.
                            let row = unsafe { std::slice::from_raw_parts_mut(sp.at(i * t), t) };
                            for (j, s) in row.iter_mut().enumerate() {
                                let keep = match window {
                                    Some(w) => j <= i && j + w > i,
                                    None => mask.sees(i, j),
                                };
                                if !keep {
                                    *s = f32::NEG_INFINITY;
                                }
                            }
                            let mx = row.iter().fold(f32::NEG_INFINITY, |m, &x| m.max(x));
                            let mut sum = 0f32;
                            for s in row.iter_mut() {
                                *s = (*s - mx).exp();
                                sum += *s;
                            }
                            let inv_sum = 1.0 / sum;
                            for s in row.iter_mut() {
                                *s *= inv_sum;
                            }
                        }
                    };
                    match pool {
                        Some(p) => p.run_rows(t, &f),
                        None => f(0, t),
                    }
                }
                crate::fcd_ops::gemm_nt_host(&sc, &vt, &mut oh, t, t, hd, pool);
                for i in 0..t {
                    out[i * qd + hh * hd..i * qd + (hh + 1) * hd].copy_from_slice(&oh[i * hd..(i + 1) * hd]);
                }
            }
        }
        if let Some((g, per_head)) = gate {
            let mut raw = vec![0f32; t * g.rows()];
            g.matmat(x, t, &mut raw, pool);
            for i in 0..t {
                crate::attention::apply_projected_gate(
                    &mut out[i * qd..(i + 1) * qd],
                    &raw[i * g.rows()..(i + 1) * g.rows()],
                    *per_head,
                    hd,
                    self.proj_gate_sigmoid,
                );
            }
        }
        Ok(out)
    }

    /// Log-probabilities over the vocabulary for `n` final-normed hidden rows
    /// `[n, hidden]`: one head GEMM for all of them, `[n, vocab]` out.
    pub(crate) fn log_probs_rows(&self, hidden: &[f32], n: usize) -> Vec<f32> {
        let v = self.vocab_size;
        let mut logits = vec![0f32; n * v];
        if n == 1 {
            self.weights.lm_head.matvec(hidden, &mut logits, self.pool.as_deref());
        } else {
            self.weights.lm_head.matmat(hidden, n, &mut logits, self.pool.as_deref());
        }
        self.log_softmax_rows(&mut logits);
        logits
    }

    /// Log-softmax of every vocabulary row of `logits`, rows in parallel.
    fn log_softmax_rows(&self, logits: &mut [f32]) {
        let v = self.vocab_size;
        let n = logits.len() / v;
        let dst = crate::pool::SendMut::new(logits.as_mut_ptr());
        let f = |lo: usize, hi: usize| {
            for r in lo..hi {
                // SAFETY: disjoint rows per worker.
                let row = unsafe { std::slice::from_raw_parts_mut(dst.at(r * v), v) };
                let mx = row.iter().fold(f32::NEG_INFINITY, |m, &x| m.max(x));
                let lse = mx as f64 + row.iter().map(|&x| ((x - mx) as f64).exp()).sum::<f64>().ln();
                for x in row.iter_mut() {
                    *x = (*x as f64 - lse) as f32;
                }
            }
        };
        match self.pool.as_deref() {
            Some(p) => p.run_rows(n, &f),
            None => f(0, n),
        }
    }
}