-
Notifications
You must be signed in to change notification settings - Fork 996
Expand file tree
/
Copy pathschema.fbs
More file actions
1223 lines (1054 loc) · 28.8 KB
/
schema.fbs
File metadata and controls
1223 lines (1054 loc) · 28.8 KB
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
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Meta Platforms, Inc. and affiliates.
//
// FlatBuffer schema for MLX delegate - THIS IS THE SOURCE OF TRUTH
// Defines the IR that gets serialized into the .pte file and executed by MLX runtime
//
// After editing this file, regenerate dependent files with:
// python backends/mlx/serialization/generate.py
//
// BACKWARD COMPATIBILITY RULES:
// - New fields in tables: APPEND ONLY (add at the end, with a default value)
// - New union members: APPEND ONLY (add at the end of the union)
// - New tables: Safe to add freely
// - New enum values: APPEND ONLY
// - NEVER remove, reorder, or change the type of existing fields/members
namespace mlx_delegate;
// =============================================================================
// Core types
// =============================================================================
// We use ET's ScalarType (int8) directly.
// See runtime/core/portable_type/scalar_type.h for ScalarType values.
// Tensor slot identifier - indexes into tensors array
struct Tid {
idx: uint32;
}
// Value slot identifier - indexes into values array
// Values are stored as variant<int64, double, bool> at runtime
struct Vid {
idx: uint32;
}
// NOTE: These compound types use tables with manual discriminators rather than
// FlatBuffers unions because IntOrVid is used in vectors ([IntOrVid]), and
// FlatBuffers does not support vectors of unions.
// For fields that can be either a literal int or a runtime Vid
table IntOrVid {
literal: int64; // widened to int64 for future-proofing
vid: Vid;
is_vid: bool = false;
}
// For fields that can be either a literal float or a runtime Vid
table FloatOrVid {
literal: double; // widened to double for future-proofing
vid: Vid;
is_vid: bool = false;
}
// For fields that can be either a tensor (Tid) or a scalar value (Vid)
table VidOrTid {
vid: Vid;
tid: Tid;
is_vid: bool = false; // false = use tid, true = use vid
}
// For fields that can be a literal int, a runtime Vid, or a tensor (Tid)
table IntOrVidOrTid {
literal: int64;
vid: Vid;
tid: Tid;
kind: uint8 = 0; // 0 = literal int, 1 = vid, 2 = tid
}
// =============================================================================
// Op nodes - mirrors ops_schema.py dataclasses
// =============================================================================
table NoopNode {}
table IdCopyNode {
x: Tid (required);
out: Tid (required);
}
table AddmmNode {
mat1: Tid (required); // First matrix
mat2: Tid (required); // Second matrix
out: Tid (required);
bias: Tid; // optional - added to result
alpha: float = 1.0; // Scalar multiplier for mat1 @ mat2
beta: float = 1.0; // Scalar multiplier for bias
}
table ItemIntNode {
x: Tid (required);
out: Vid (required);
}
table ExpandDimsNode {
x: Tid (required);
out: Tid (required);
axis: int32;
}
table TileNode {
x: Tid (required);
out: Tid (required);
reps: [IntOrVid] (required);
}
table TakeAlongAxisNode {
x: Tid (required);
indices: Tid (required);
out: Tid (required);
axis: int32;
}
table TakeNode {
x: Tid (required);
out: Tid (required);
index: IntOrVidOrTid (required); // Scalar int, dynamic Vid, or tensor of indices
axis: int32; // Axis along which to select
}
table RMSNormNode {
x: Tid (required);
weight: Tid; // optional (None = no per-element scaling, same as ones)
out: Tid (required);
eps: float;
}
table LayerNormNode {
x: Tid (required);
out: Tid (required);
weight: Tid; // optional
bias: Tid; // optional
eps: float;
}
table RopeNode {
x: Tid (required);
out: Tid (required);
dims: int32;
offset: VidOrTid (required); // Position offset: scalar (Vid) or tensor of positions (Tid)
freqs: Tid; // optional
traditional: bool = false;
base: float = 500000.0; // Llama 3 default
scale: float = 1.0;
}
table SdpaNode {
q: Tid (required);
k: Tid (required);
v: Tid (required);
out: Tid (required);
scale: float;
mask: Tid; // optional
causal: bool = false;
}
table AddNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table AddIntNode {
a: IntOrVid (required);
b: IntOrVid (required);
out: Vid (required);
}
table SubtractIntNode {
a: IntOrVid (required);
b: IntOrVid (required);
out: Vid (required);
}
table MultiplyIntNode {
a: IntOrVid (required);
b: IntOrVid (required);
out: Vid (required);
}
table FloorDivideIntNode {
a: IntOrVid (required);
b: IntOrVid (required);
out: Vid (required);
}
table ModIntNode {
a: IntOrVid (required);
b: IntOrVid (required);
out: Vid (required);
}
table SymSizeNode {
a: Tid (required);
dim: int32;
out: Vid (required);
}
table MultiplyNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table DivideNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table SubtractNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table Conv1DNode {
x: Tid (required);
w: Tid (required);
out: Tid (required);
stride: int32 = 1;
padding: int32 = 0;
dilation: int32 = 1;
groups: int32 = 1;
}
table Conv2DNode {
x: Tid (required);
w: Tid (required);
out: Tid (required);
stride_h: int32 = 1;
stride_w: int32 = 1;
padding_h: int32 = 0;
padding_w: int32 = 0;
dilation_h: int32 = 1;
dilation_w: int32 = 1;
groups: int32 = 1;
}
table Conv3DNode {
x: Tid (required);
w: Tid (required);
out: Tid (required);
stride_d: int32 = 1;
stride_h: int32 = 1;
stride_w: int32 = 1;
padding_d: int32 = 0;
padding_h: int32 = 0;
padding_w: int32 = 0;
dilation_d: int32 = 1;
dilation_h: int32 = 1;
dilation_w: int32 = 1;
groups: int32 = 1;
}
table ConvTranspose1DNode {
x: Tid (required);
w: Tid (required);
out: Tid (required);
stride: int32 = 1;
padding: int32 = 0;
dilation: int32 = 1;
output_padding: int32 = 0;
groups: int32 = 1;
}
table ConvTranspose2DNode {
x: Tid (required);
w: Tid (required);
out: Tid (required);
stride_h: int32 = 1;
stride_w: int32 = 1;
padding_h: int32 = 0;
padding_w: int32 = 0;
dilation_h: int32 = 1;
dilation_w: int32 = 1;
output_padding_h: int32 = 0;
output_padding_w: int32 = 0;
groups: int32 = 1;
}
table ConvTranspose3DNode {
x: Tid (required);
w: Tid (required);
out: Tid (required);
stride_d: int32 = 1;
stride_h: int32 = 1;
stride_w: int32 = 1;
padding_d: int32 = 0;
padding_h: int32 = 0;
padding_w: int32 = 0;
dilation_d: int32 = 1;
dilation_h: int32 = 1;
dilation_w: int32 = 1;
output_padding_d: int32 = 0;
output_padding_h: int32 = 0;
output_padding_w: int32 = 0;
groups: int32 = 1;
}
table GeluNode {
x: Tid (required);
out: Tid (required);
approximate: string (required); // "none" or "tanh"
}
table ARangeNode {
out: Tid (required);
start: IntOrVid (required); // Can be literal or dynamic (from item())
stop: IntOrVid (required); // Can be literal or dynamic (from item())
step: IntOrVid (required); // Can be literal or dynamic
scalar_type: int8 = null; // ET ScalarType (optional - None means infer from context)
}
table SiluNode {
x: Tid (required);
out: Tid (required);
}
table SigmoidNode {
x: Tid (required);
out: Tid (required);
}
table TanhNode {
x: Tid (required);
out: Tid (required);
}
table SqueezeNode {
x: Tid (required);
out: Tid (required);
dims: [int32]; // Optional list of dimensions to squeeze. If empty, squeeze all dims of size 1
}
table SplitNode {
x: Tid (required);
outs: [Tid] (required); // Multiple output tensor IDs (one for each split chunk)
sizes: [IntOrVid] (required); // Split sizes (can be dynamic)
axis: int32;
}
table RsqrtNode {
x: Tid (required);
out: Tid (required);
}
table MaximumNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table MinimumNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table LogNode {
x: Tid (required);
out: Tid (required);
}
table SoftmaxNode {
x: Tid (required);
out: Tid (required);
axis: int32; // Dimension to compute softmax over
precise: bool = false; // Use precise (slow) implementation
}
table BroadcastToNode {
x: Tid (required);
out: Tid (required);
shape: [IntOrVid] (required); // Target shape to broadcast to
}
table PadNode {
x: Tid (required);
out: Tid (required);
pad_width: [IntOrVid] (required); // Padding pairs: [(before_0, after_0), (before_1, after_1), ...]
mode: string (required); // "constant" or "edge"
constant_value: float = 0.0; // Value to pad with (for constant mode)
}
table WhereNode {
condition: Tid (required);
x: Tid (required);
y: Tid (required);
out: Tid (required);
}
table ReshapeNode {
x: Tid (required);
out: Tid (required);
shape: [IntOrVid] (required);
}
table TransposeNode {
x: Tid (required);
out: Tid (required);
perm: [int32] (required);
}
table AsStridedNode {
x: Tid (required);
out: Tid (required);
shape: [IntOrVid] (required); // Output view shape (can be dynamic)
strides: [IntOrVid] (required); // Element strides per dimension (can be dynamic)
offset: uint64 = 0; // Element offset into source
}
table ContiguousNode {
x: Tid (required);
out: Tid (required);
}
table GatherNode {
x: Tid (required);
indices: [Tid] (required); // Index tensors (one per indexed axis)
out: Tid (required);
axes: [int32] (required); // Which axes to gather along
slice_sizes: [int32] (required); // Size of slice per dimension of x
}
table SliceNode {
x: Tid (required);
out: Tid (required);
axis: IntOrVid (required);
start: IntOrVid (required);
stop: IntOrVid (required);
step: int32 = 1;
}
table AsTypeNode {
x: Tid (required);
out: Tid (required);
scalar_type: int8; // ET ScalarType
}
table QuantizedMatmulNode {
x: Tid (required);
w: Tid (required);
scales: Tid (required);
out: Tid (required);
biases: Tid; // optional - required for affine mode, null for nvfp4
group_size: int32;
bits: int32;
mode: string (required);
transpose: bool = true;
}
// Scatter-add: accumulate updates into input at index positions along an axis
// Maps to mlx::scatter_add(a, indices, updates, axis)
table ScatterAddNode {
x: Tid (required); // Input tensor to scatter into
indices: Tid (required); // Index tensor
updates: Tid (required); // Values to accumulate
out: Tid (required);
axis: int32; // Dimension to scatter along
}
table ConcatenateNode {
tensors: [Tid] (required); // List of tensors to concatenate
out: Tid (required);
axis: int32;
}
table FullNode {
out: Tid (required);
shape: [IntOrVid] (required);
v: FloatOrVid (required); // Fill value (can be dynamic from item())
scalar_type: int8; // ET ScalarType
}
table FullLikeNode {
x: Tid (required); // Input tensor to copy shape from
out: Tid (required);
v: FloatOrVid (required); // Fill value (can be dynamic from item())
scalar_type: int8 = null; // ET ScalarType (optional - if null, use x's dtype)
}
table ArgmaxNode {
x: Tid (required);
out: Tid (required);
axis: int32;
keepdims: bool = false;
}
table SliceUpdateNode {
dst: Tid (required);
update: Tid (required);
out: Tid (required); // Can be same as dst
axis: IntOrVid (required);
start: IntOrVid (required);
stop: IntOrVid (required);
step: int32 = 1;
}
// Index-based update: copies update tensor into dst at positions specified by 1D indices
// Runtime optimizes these into slice_update calls for contiguous runs
table IndexCopyNode {
dst: Tid (required); // destination tensor to update
update: Tid (required); // source tensor to copy from
indices: Tid (required); // 1D tensor of indices along axis
out: Tid (required); // output tensor (can be same as dst)
axis: int32; // dimension to index along
}
table DequantizeNode {
w: Tid (required); // Quantized matrix to dequantize
scales: Tid (required); // Scales per group_size elements
out: Tid (required);
biases: Tid; // optional - biases per group_size elements
group_size: int32;
bits: int32;
mode: string (required); // Quantization mode (e.g. "affine")
global_scale: Tid; // optional - global scale for nvfp4
dtype: int8 = null; // ET ScalarType for output dtype
}
// Comparison ops (return bool arrays)
table LessNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table LessEqualNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table GreaterNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table GreaterEqualNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table EqualNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table NotEqualNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
// Logical ops
table LogicalNotNode {
x: Tid (required);
out: Tid (required);
}
table LogicalAndNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table LogicalOrNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
// Triangular matrix ops
table TriNode {
out: Tid (required);
n: IntOrVid (required); // Number of rows
m: IntOrVid (required); // Number of columns
k: int32 = 0; // Diagonal offset: 0=main, +above, -below
scalar_type: int8; // ET ScalarType
}
table TrilNode {
x: Tid (required);
out: Tid (required);
k: int32 = 0; // Diagonal offset: 0=main, +above, -below
}
table TriuNode {
x: Tid (required);
out: Tid (required);
k: int32 = 0; // Diagonal offset: 0=main, +above, -below
}
table ClipNode {
x: Tid (required);
out: Tid (required);
a_min: Tid; // optional lower bound
a_max: Tid; // optional upper bound
}
table CumsumNode {
x: Tid (required);
out: Tid (required);
axis: int32;
reverse: bool = false;
inclusive: bool = true;
}
table StackNode {
tensors: [Tid] (required);
out: Tid (required);
axis: int32 = 0;
}
table SignNode {
x: Tid (required);
out: Tid (required);
}
table AnyNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
}
table AllNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
}
table RepeatNode {
x: Tid (required);
out: Tid (required);
repeats: IntOrVid (required); // Number of times to repeat each element (can be dynamic)
axis: int32; // Axis along which to repeat
}
table SortNode {
x: Tid (required);
out: Tid (required);
axis: int32;
}
table ArgsortNode {
x: Tid (required);
out: Tid (required);
axis: int32;
}
table PartitionNode {
x: Tid (required);
out: Tid (required);
kth: IntOrVid (required); // Partition index
axis: int32;
}
table ArgPartitionNode {
x: Tid (required);
out: Tid (required);
kth: IntOrVid (required); // Partition index
axis: int32;
}
// =============================================================================
// Math ops - Unary element-wise
// =============================================================================
table FloorNode {
x: Tid (required);
out: Tid (required);
}
table CeilNode {
x: Tid (required);
out: Tid (required);
}
table SquareNode {
x: Tid (required);
out: Tid (required);
}
table ExpNode {
x: Tid (required);
out: Tid (required);
}
table SinNode {
x: Tid (required);
out: Tid (required);
}
table CosNode {
x: Tid (required);
out: Tid (required);
}
table TanNode {
x: Tid (required);
out: Tid (required);
}
table ArcsinNode {
x: Tid (required);
out: Tid (required);
}
table ArccosNode {
x: Tid (required);
out: Tid (required);
}
table ArctanNode {
x: Tid (required);
out: Tid (required);
}
table SinhNode {
x: Tid (required);
out: Tid (required);
}
table CoshNode {
x: Tid (required);
out: Tid (required);
}
table ArcsinhNode {
x: Tid (required);
out: Tid (required);
}
table ArccoshNode {
x: Tid (required);
out: Tid (required);
}
table ArctanhNode {
x: Tid (required);
out: Tid (required);
}
table Log2Node {
x: Tid (required);
out: Tid (required);
}
table Log10Node {
x: Tid (required);
out: Tid (required);
}
table Log1pNode {
x: Tid (required);
out: Tid (required);
}
table ErfNode {
x: Tid (required);
out: Tid (required);
}
table Expm1Node {
x: Tid (required);
out: Tid (required);
}
table RoundNode {
x: Tid (required);
out: Tid (required);
decimals: int32 = 0;
}
table ReciprocalNode {
x: Tid (required);
out: Tid (required);
}
table SqrtNode {
x: Tid (required);
out: Tid (required);
}
table AbsNode {
x: Tid (required);
out: Tid (required);
}
table NegNode {
x: Tid (required);
out: Tid (required);
}
// =============================================================================
// Math ops - Binary element-wise
// =============================================================================
table Atan2Node {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table LogAddExpNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table FloorDivideNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table RemainderNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
table PowerNode {
a: Tid (required);
b: Tid (required);
out: Tid (required);
}
// =============================================================================
// Math ops - Reduction
// =============================================================================
table LogSumExpNode {
x: Tid (required);
out: Tid (required);
axes: [int32];
keepdims: bool = false;
}
table SumNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
}
table MeanNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
}
table VarNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
ddof: int32 = 0; // Delta degrees of freedom (0=population var, 1=sample var)
}
table StdNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
ddof: int32 = 0; // Delta degrees of freedom
}
table ProdNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
}
table MaxNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
}
table MinNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
}
table ArgminNode {
x: Tid (required);
out: Tid (required);
axis: int32;
keepdims: bool = false;
}
table MedianNode {
x: Tid (required);
out: Tid (required);
axes: [int32]; // Empty = reduce all
keepdims: bool = false;
}
table GatherMmNode {
a: Tid (required); // Input activations
b: Tid (required); // Weight matrix [E, out, in] or similar
out: Tid (required);
lhs_indices: Tid; // optional - LHS gather indices
rhs_indices: Tid; // optional - RHS gather indices (expert selection)
sorted_indices: bool = false;
}
table GatherQmmNode {
x: Tid (required); // Input activations
w: Tid (required); // Quantized weight matrix [E, out, in_packed]
scales: Tid (required); // Quantization scales [E, out, in//gs]
out: Tid (required);
mode: string (required); // "affine", "fp", etc.
biases: Tid; // optional - for affine mode
lhs_indices: Tid; // optional - LHS gather indices
rhs_indices: Tid; // optional - RHS gather indices (expert selection)
transpose: bool = true;
group_size: int32;
bits: int32;
sorted_indices: bool = false;
}
table ScanNode {
originals: [Tid] (required); // [B, T, ...] — read-only, not modified
sliced: [Tid] (required); // runtime writes per-step slices here (same length as originals)
outputs: [Tid] (required); // body writes [B, ...] per step, runtime stacks to [B, T, ...]
carry: [Tid] (required); // body reads/writes in place, persists across steps
body_chain_idx: int32; // index into MLXGraph.instruction_chains
scan_axis: int32 = 1; // dimension to iterate over
}
// Custom Metal kernel execution via mlx::core::fast::metal_kernel().
// Two-phase API:
// 1. Factory: metal_kernel(name, input_names, output_names, source, header,
// ensure_row_contiguous, atomic_outputs) -> kernel_fn
// 2. Invocation: kernel_fn(inputs, output_shapes, output_dtypes, grid,
// threadgroup, template_args, init_value)
//
// Output shapes are flattened: output_shapes_flat contains all shape dims
// concatenated, output_shape_lengths gives the rank of each output.
// E.g. shapes [[B,T,H,D], [B,H,D,K]] -> flat=[B,T,H,D,B,H,D,K], lengths=[4,4]
//
// Template args are parallel arrays: template_arg_names[i] paired with
// template_arg_kinds[i] (0=int, 1=bool, 2=dtype/ScalarType) and
// template_arg_values[i] (int value, bool as 0/1, or ScalarType enum).
table MetalKernelNode {
// Required fields (no defaults) — must come first for Python dataclass ordering
name: string (required);
source: string (required);
inputs: [Tid] (required);
outputs: [Tid] (required);
grid: [IntOrVid] (required);
threadgroup: [IntOrVid] (required);
// Optional / defaulted fields
header: string;
input_names: [string];
output_names: [string];
ensure_row_contiguous: bool = true;
atomic_outputs: bool = false;
output_shapes_flat: [IntOrVid];
output_shape_lengths: [int32];
output_dtypes: [int8];
template_arg_names: [string];
template_arg_kinds: [int8]; // 0=int, 1=bool, 2=dtype (ScalarType)
template_arg_values: [int32]; // int value, bool as 0/1, or ScalarType enum
init_value: float = null;
}
table BitwiseXorNode {
a: Tid;
b: Tid;
out: Tid;
}
// =============================================================================
// Union of all op types
// =============================================================================
// BC: APPEND ONLY — new op nodes must be added at the end of this union.
// Reordering or removing members changes numeric type IDs and breaks existing .pte files.
union OpNode {
NoopNode,
IdCopyNode,
AddmmNode,
ItemIntNode,