tenferro-internal-ops 0.7.0

Graph op vocabulary and AD rule implementations for the tenferro workspace.
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
//! Unit tests for elementwise AD helper rules.

use computegraph::graph::GraphBuilder;
use computegraph::types::{OperationRole, ValueKey, ValueRef};
use tenferro_tensor::{CompareDir, DType};

use crate::ad::context::{ShapeGuardContext, TensorMeta};
use crate::input_key::TensorInputKey;
use crate::std_tensor_op::StdTensorOp;
use crate::SymDim;

fn tensor_input(id: u64) -> TensorInputKey {
    TensorInputKey::User { id }
}

fn input_key(id: u64) -> ValueKey<StdTensorOp> {
    ValueKey::Input(tensor_input(id))
}

#[test]
fn zero_like_covers_scalar_and_broadcasted_dtype_paths() {
    let mut builder = GraphBuilder::<StdTensorOp>::new();
    let anchor = builder.add_input(tensor_input(1));

    let dtype_cases = [
        (DType::F32, 4),
        (DType::F64, 8),
        (DType::I64, 8),
        (DType::C32, 8),
        (DType::C64, 16),
    ];
    let mut scalar_zeros = Vec::new();
    for (dtype, byte_len) in dtype_cases {
        let zero =
            super::super::zeros::build_zero_like(&mut builder, dtype, ValueRef::Local(anchor), 0);
        scalar_zeros.push((zero, dtype, byte_len));
    }

    let vector_zero =
        super::super::zeros::build_zero_like(&mut builder, DType::F64, ValueRef::Local(anchor), 2);
    let graph = builder.build();

    for (zero, dtype, byte_len) in scalar_zeros {
        let (op_id, _) = graph.values()[zero]
            .producer
            .expect("zero scalar must be produced by a constant op");
        let op = &graph.operations()[op_id];
        match &op.operation {
            StdTensorOp::Constant { dtype: got, bytes } => {
                assert_eq!(*got, dtype);
                assert_eq!(bytes.len(), byte_len);
                assert!(bytes.iter().all(|byte| *byte == 0));
            }
            other => panic!("expected constant zero, got {other:?}"),
        }
    }

    let (broadcast, _) = graph.values()[vector_zero]
        .producer
        .expect("ranked zero must be produced by broadcast");
    let op = &graph.operations()[broadcast];
    assert_eq!(
        op.operation,
        StdTensorOp::BroadcastInDim {
            shape: vec![
                crate::dim_expr::DimExpr::InputDim {
                    input_idx: 1,
                    axis: 0
                },
                crate::dim_expr::DimExpr::InputDim {
                    input_idx: 1,
                    axis: 1
                },
            ],
            dims: vec![],
        }
    );
    assert_eq!(op.inputs[1], ValueRef::Local(anchor));
}

#[test]
fn symbolic_zero_carries_aval_until_instantiated() {
    let mut builder = GraphBuilder::<StdTensorOp>::new();
    let anchor = builder.add_input(tensor_input(1));
    let meta = TensorMeta::exact(DType::C64, vec![SymDim::from(2usize), SymDim::from(3usize)]);

    let zero = super::super::zeros::SymbolicZero::from_meta(ValueRef::Local(anchor), &meta);
    assert_eq!(zero.dtype(), DType::C64);
    assert_eq!(zero.rank(), 2);
    assert_eq!(zero.anchor(), &ValueRef::Local(anchor));
    assert!(builder.build().operations().is_empty());

    let mut builder = GraphBuilder::<StdTensorOp>::new();
    let anchor = builder.add_input(tensor_input(2));
    let zero = super::super::zeros::SymbolicZero::from_meta(ValueRef::Local(anchor), &meta);
    let materialized = zero.instantiate(&mut builder);
    let graph = builder.build();

    let (op_id, _) = graph.values()[materialized]
        .producer
        .expect("ranked symbolic zero should materialize as broadcast");
    assert!(matches!(
        graph.operations()[op_id].operation,
        StdTensorOp::BroadcastInDim { .. }
    ));
}

#[test]
fn one_like_uses_dtype_aware_constant_without_exp_shortcut() {
    let mut builder = GraphBuilder::<StdTensorOp>::new();
    let anchor = builder.add_input(tensor_input(1));

    let scalar_one =
        super::super::zeros::build_one_like(&mut builder, DType::I64, ValueRef::Local(anchor), 0);
    let vector_one =
        super::super::zeros::build_one_like(&mut builder, DType::F64, ValueRef::Local(anchor), 2);
    let graph = builder.build();

    assert!(
        graph
            .operations()
            .iter()
            .all(|op| op.operation != StdTensorOp::Exp),
        "one-like seed helper must not synthesize constants through Exp"
    );

    let (scalar_op_id, _) = graph.values()[scalar_one]
        .producer
        .expect("scalar one must be produced by a constant op");
    match graph.operations()[scalar_op_id].operation.clone() {
        StdTensorOp::Constant { dtype, bytes } => {
            assert_eq!(dtype, DType::I64);
            assert_eq!(bytes, 1_i64.to_le_bytes().to_vec());
        }
        other => panic!("expected constant one, got {other:?}"),
    }

    let (broadcast_op_id, _) = graph.values()[vector_one]
        .producer
        .expect("ranked one must be produced by broadcast");
    let op = &graph.operations()[broadcast_op_id];
    assert_eq!(
        op.operation,
        StdTensorOp::BroadcastInDim {
            shape: vec![
                crate::dim_expr::DimExpr::InputDim {
                    input_idx: 1,
                    axis: 0
                },
                crate::dim_expr::DimExpr::InputDim {
                    input_idx: 1,
                    axis: 1
                },
            ],
            dims: vec![],
        }
    );
    assert_eq!(op.inputs[1], ValueRef::Local(anchor));
}

#[test]
fn linearize_elementwise_inactive_inputs_return_none_without_ops() {
    let mut ctx = ShapeGuardContext::default();
    let keys = vec![input_key(1), input_key(2), input_key(3)];

    for op in [
        StdTensorOp::Div,
        StdTensorOp::Abs,
        StdTensorOp::Sign,
        StdTensorOp::Maximum,
        StdTensorOp::Minimum,
        StdTensorOp::Select,
        StdTensorOp::Clamp,
    ] {
        let mut builder = GraphBuilder::<StdTensorOp>::new();
        let result = op
            .jvp_rule(
                &mut builder,
                &keys,
                &[input_key(4)],
                &[None, None, None],
                &mut ctx,
            )
            .unwrap();
        assert_eq!(result, vec![None], "{op:?}");
        assert!(
            builder.build().operations().is_empty(),
            "inactive {op:?} should not emit linearized ops"
        );
    }
}

#[test]
fn linearize_div_with_two_active_inputs_sums_both_terms() {
    let mut builder = GraphBuilder::<StdTensorOp>::new();
    let dx = builder.add_input(tensor_input(10));
    let dy = builder.add_input(tensor_input(11));
    let mut ctx = ShapeGuardContext::default();
    let op = StdTensorOp::Div;

    let result = op
        .jvp_rule(
            &mut builder,
            &[input_key(12), input_key(13)],
            &[input_key(14)],
            &[Some(dx), Some(dy)],
            &mut ctx,
        )
        .unwrap();

    assert!(result[0].is_some());
    let graph = builder.build();
    assert_eq!(
        graph.operations().last().map(|op| &op.operation),
        Some(&StdTensorOp::Add)
    );
}

#[test]
fn linearize_extrema_uses_jax_balanced_tie_masks() {
    let mut ctx = ShapeGuardContext::default();

    let mut max_builder = GraphBuilder::<StdTensorOp>::new();
    let dx = max_builder.add_input(tensor_input(20));
    let result = StdTensorOp::Maximum
        .jvp_rule(
            &mut max_builder,
            &[input_key(21), input_key(22)],
            &[],
            &[Some(dx), None],
            &mut ctx,
        )
        .unwrap();
    assert!(result[0].is_some());
    let graph = max_builder.build();
    assert_eq!(graph.operations()[0].operation, StdTensorOp::Maximum);
    assert_eq!(
        graph
            .operations()
            .iter()
            .filter(|op| op.operation == StdTensorOp::Compare(CompareDir::Eq))
            .count(),
        2
    );
    assert!(
        graph
            .operations()
            .iter()
            .filter(|op| op.operation == StdTensorOp::Select)
            .count()
            >= 2
    );
    assert!(graph
        .operations()
        .iter()
        .any(|op| op.operation == StdTensorOp::Div));

    let mut min_builder = GraphBuilder::<StdTensorOp>::new();
    let dy = min_builder.add_input(tensor_input(23));
    let result = StdTensorOp::Minimum
        .jvp_rule(
            &mut min_builder,
            &[input_key(24), input_key(25)],
            &[],
            &[None, Some(dy)],
            &mut ctx,
        )
        .unwrap();
    assert!(result[0].is_some());
    let graph = min_builder.build();
    assert_eq!(graph.operations()[0].operation, StdTensorOp::Minimum);
    assert_eq!(
        graph
            .operations()
            .iter()
            .filter(|op| op.operation == StdTensorOp::Compare(CompareDir::Eq))
            .count(),
        2
    );
    assert!(
        graph
            .operations()
            .iter()
            .filter(|op| op.operation == StdTensorOp::Select)
            .count()
            >= 2
    );
    assert!(graph
        .operations()
        .iter()
        .any(|op| op.operation == StdTensorOp::Div));
}

#[test]
fn linearize_clamp_builds_nested_selects_for_active_bounds() {
    let mut builder = GraphBuilder::<StdTensorOp>::new();
    let dx = builder.add_input(tensor_input(30));
    let dlower = builder.add_input(tensor_input(31));
    let dupper = builder.add_input(tensor_input(32));
    let mut ctx = ShapeGuardContext::default();

    let result = StdTensorOp::Clamp
        .jvp_rule(
            &mut builder,
            &[input_key(33), input_key(34), input_key(35)],
            &[],
            &[Some(dx), Some(dlower), Some(dupper)],
            &mut ctx,
        )
        .unwrap();

    assert!(result[0].is_some());
    let graph = builder.build();
    assert!(
        graph
            .operations()
            .iter()
            .filter(|op| op.operation == StdTensorOp::Select)
            .count()
            >= 2
    );
}

#[test]
fn transpose_elementwise_handles_missing_or_inactive_cotangents() {
    let mut builder = GraphBuilder::<StdTensorOp>::new();
    let mut ctx = ShapeGuardContext::default();
    let inputs = vec![
        ValueRef::External(input_key(40)),
        ValueRef::External(input_key(41)),
    ];

    assert_eq!(
        StdTensorOp::Div
            .transpose_rule(
                &mut builder,
                &[None],
                &inputs,
                &OperationRole::Primary,
                &mut ctx
            )
            .unwrap(),
        vec![None, None]
    );
    let abs_ct = builder.add_input(tensor_input(42));
    assert_eq!(
        StdTensorOp::Abs
            .transpose_rule(
                &mut builder,
                &[Some(abs_ct)],
                &[inputs[0].clone()],
                &OperationRole::Primary,
                &mut ctx,
            )
            .unwrap(),
        vec![None]
    );
    assert_eq!(
        StdTensorOp::Maximum
            .transpose_rule(
                &mut builder,
                &[None],
                &inputs,
                &OperationRole::Linearized {
                    active_mask: vec![true, true],
                },
                &mut ctx,
            )
            .unwrap(),
        vec![None, None]
    );
}

#[test]
fn transpose_select_splits_cotangent_only_to_active_value_inputs() {
    let mut builder = GraphBuilder::<StdTensorOp>::new();
    let ct = builder.add_input(tensor_input(50));
    let mut ctx = ShapeGuardContext::default();
    let inputs = vec![
        ValueRef::External(input_key(51)),
        ValueRef::External(input_key(52)),
        ValueRef::External(input_key(53)),
    ];

    let result = StdTensorOp::Select
        .transpose_rule(
            &mut builder,
            &[Some(ct)],
            &inputs,
            &OperationRole::Linearized {
                active_mask: vec![false, true, false],
            },
            &mut ctx,
        )
        .unwrap();

    assert_eq!(result[0], None);
    assert!(result[1].is_some());
    assert_eq!(result[2], None);
    let graph = builder.build();
    assert!(graph
        .operations()
        .iter()
        .any(|op| op.operation == StdTensorOp::Select));
}

#[test]
fn transpose_clamp_covers_lower_only_and_inner_paths() {
    let mut ctx = ShapeGuardContext::default();
    let inputs = vec![
        ValueRef::External(input_key(60)),
        ValueRef::External(input_key(61)),
        ValueRef::External(input_key(62)),
    ];

    let mut lower_builder = GraphBuilder::<StdTensorOp>::new();
    let lower_ct = lower_builder.add_input(tensor_input(63));
    let result = StdTensorOp::Clamp
        .transpose_rule(
            &mut lower_builder,
            &[Some(lower_ct)],
            &inputs,
            &OperationRole::Linearized {
                active_mask: vec![false, true, false],
            },
            &mut ctx,
        )
        .unwrap();
    assert_eq!(result[0], None);
    assert!(result[1].is_some());
    assert_eq!(result[2], None);

    let mut full_builder = GraphBuilder::<StdTensorOp>::new();
    let full_ct = full_builder.add_input(tensor_input(64));
    let result = StdTensorOp::Clamp
        .transpose_rule(
            &mut full_builder,
            &[Some(full_ct)],
            &inputs,
            &OperationRole::Linearized {
                active_mask: vec![true, true, true],
            },
            &mut ctx,
        )
        .unwrap();
    assert!(result.iter().all(Option::is_some));
}