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
//! # MatMul
//!
//! Matrix product that behaves like numpy.matmul.
//!
//! **ONNX Spec**: <https://onnx.ai/onnx/operators/onnx__MatMul.html>
//!
//! **Note**: In the node_conversion phase, MatMul nodes with constant weights may be converted to Linear nodes.
//!
//! ## Type Constraints
//! - T: tensor(float), tensor(double), tensor(float16), tensor(bfloat16), tensor(int32), tensor(int64), tensor(uint32), tensor(uint64)
//!
//! ## Opset Versions
//! - **Opset 1**: Initial version with numpy.matmul-like behavior and broadcasting support.
//! - **Opset 9**: Added support for additional integer types (int32, int64, uint32, uint64).
//! - **Opset 13**: Added bfloat16 type support; no functional changes to operation semantics.
//!
//! **Implementation Note**: This implementation validates opset 1+.
//!
//! ## Missing Test Coverage
//! - TODO: No test for 0D (scalar) inputs - Spec allows scalars but not tested
//! - TODO: No test for batched matmul with different batch dimensions - Broadcasting edge cases
//! - TODO: No test for dtype validation - Mixed dtypes should be rejected
//! - TODO: No test for incompatible shapes - e.g., [M, K] x [N, P] where K != N
//! - TODO: No test for integer types (int32, int64, uint32, uint64) - Opset 9+ type support not validated
//! - TODO: No test for bfloat16 type - Opset 13+ type support not validated
//! - TODO: No test for zero-size dimensions - Empty matrix multiplication
use onnx_ir_derive::NodeBuilder;
use crate::ir::{ArgType, Argument, Node, RawNode, TensorType};
use crate::processor::{
InputSpec, NodeProcessor, NodeSpec, OutputPreferences, OutputSpec, ProcessError,
};
use core::cmp::max;
/// Node representation for MatMul operation
#[derive(Debug, Clone, NodeBuilder)]
pub struct MatMulNode {
pub name: String,
pub inputs: Vec<Argument>,
pub outputs: Vec<Argument>,
}
pub(crate) struct MatMulProcessor;
impl NodeProcessor for MatMulProcessor {
type Config = ();
fn spec(&self) -> NodeSpec {
NodeSpec {
min_opset: 1,
max_opset: None,
inputs: InputSpec::Exact(2),
outputs: OutputSpec::Exact(1),
}
}
fn infer_types(
&self,
node: &mut RawNode,
_opset: usize,
_output_preferences: &OutputPreferences,
) -> Result<(), ProcessError> {
// Validate that no unexpected attributes are present
// The spec states "Attributes (None)" for MatMul
if let Some((key, _value)) = node.attrs.iter().next() {
return Err(ProcessError::InvalidAttribute {
name: key.clone(),
reason: format!("MatMul does not accept any attributes, found: {}", key),
});
}
match (&node.inputs[0].ty, &node.inputs[1].ty) {
(ArgType::Tensor(a), ArgType::Tensor(b)) => {
// Validate dtype compatibility - both inputs must have the same dtype
if a.dtype != b.dtype {
return Err(ProcessError::TypeMismatch {
expected: format!("Both inputs to have dtype {:?}", a.dtype),
actual: format!(
"Input A has dtype {:?}, Input B has dtype {:?}",
a.dtype, b.dtype
),
});
}
// TODO: Validate dtype is supported by current opset - int types require opset 9+, bfloat16 requires opset 13+ - burn/crates/onnx-ir/src/node/matmul.rs:56
// Validate rank constraints per ONNX spec
// MatMul requires both inputs to be at least 1D
if a.rank < 1 || b.rank < 1 {
return Err(ProcessError::Custom(format!(
"MatMul requires both inputs to have rank >= 1, got ranks: A={}, B={}",
a.rank, b.rank
)));
}
// TODO: Validate shape compatibility for matrix multiplication - Last dim of A must match second-to-last dim of B (when both >= 2D) - burn/crates/onnx-ir/src/node/matmul.rs:69
// TODO: Validate batch dimension broadcasting compatibility - Batch dims must be broadcastable - burn/crates/onnx-ir/src/node/matmul.rs:69
// For matrix multiplication, the last dimension of A must match the first/last dimension of B
// This is a basic shape compatibility check based on ranks
// When both are 2D: A[M, K] x B[K, N] -> valid
// When A is 1D and B is 2D: A[K] x B[K, N] -> valid
// When A is 2D and B is 1D: A[M, K] x B[K] -> valid
// Higher dimensional cases use broadcasting on batch dimensions
let mut out_rank = max(a.rank, b.rank);
if (a.rank >= 2 && b.rank == 1) || (a.rank == 1 && b.rank >= 2) {
out_rank -= 1;
}
node.outputs[0].ty = ArgType::Tensor(TensorType {
dtype: a.dtype,
rank: out_rank,
static_shape: None,
});
}
_ => {
return Err(ProcessError::TypeMismatch {
expected: "Tensor".to_string(),
actual: format!("{:?}, {:?}", node.inputs[0].ty, node.inputs[1].ty),
});
}
}
Ok(())
}
fn build_node(&self, builder: RawNode, _opset: usize) -> Node {
Node::MatMul(MatMulNode {
name: builder.name,
inputs: builder.inputs,
outputs: builder.outputs,
})
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::ir::{DType, NodeType};
use crate::node::test_utils::TestNodeBuilder;
fn create_test_node(a_rank: usize, b_rank: usize) -> RawNode {
TestNodeBuilder::new(NodeType::MatMul, "test_matmul")
.input_tensor_f32("A", a_rank, None)
.input_tensor_f32("B", b_rank, None)
.output_tensor_f32("C", 0, None) // Rank will be updated
.build()
}
#[test]
fn test_matmul_standard_case() {
let mut node = create_test_node(2, 2);
let processor = MatMulProcessor;
let prefs = OutputPreferences::new();
processor.infer_types(&mut node, 16, &prefs).unwrap();
match &node.outputs[0].ty {
ArgType::Tensor(tensor) => {
assert_eq!(tensor.dtype, DType::F32);
assert_eq!(tensor.rank, 2);
}
_ => panic!("Expected tensor output"),
}
}
#[test]
fn test_matmul_broadcasting() {
let mut node = create_test_node(3, 2);
let processor = MatMulProcessor;
let prefs = OutputPreferences::new();
processor.infer_types(&mut node, 16, &prefs).unwrap();
match &node.outputs[0].ty {
ArgType::Tensor(tensor) => {
assert_eq!(tensor.dtype, DType::F32);
assert_eq!(tensor.rank, 3);
}
_ => panic!("Expected tensor output"),
}
}
#[test]
fn test_matmul_vector_matrix() {
// When multiplying a vector (rank 1) by a matrix (rank 2)
// the result should have rank 1 (vector)
let mut node = create_test_node(1, 2);
let processor = MatMulProcessor;
let prefs = OutputPreferences::new();
processor.infer_types(&mut node, 16, &prefs).unwrap();
match &node.outputs[0].ty {
ArgType::Tensor(tensor) => {
assert_eq!(tensor.dtype, DType::F32);
assert_eq!(tensor.rank, 1);
}
_ => panic!("Expected tensor output"),
}
}
#[test]
fn test_matmul_invalid_input() {
let mut node = create_test_node(2, 2);
node.inputs[0].ty = ArgType::Scalar(DType::F32);
let processor = MatMulProcessor;
let prefs = OutputPreferences::new();
let result = processor.infer_types(&mut node, 16, &prefs);
assert!(matches!(result, Err(ProcessError::TypeMismatch { .. })));
}
}