use derive_new::new;
use onnx_ir_derive::NodeBuilder;
use crate::ir::Argument;
use crate::processor::{
InputSpec, NodeProcessor, NodeSpec, OutputPreferences, OutputSpec, ProcessError,
};
use crate::ir::{ArgType, AttributeValue, Node, RawNode, RuntimeInputRef, TensorDataExt};
#[derive(Debug, Clone)]
pub enum PadInput {
Static(Vec<usize>),
Runtime(RuntimeInputRef),
}
#[derive(Debug, Clone)]
pub enum ConstantValueInput {
Static(f32),
Runtime(RuntimeInputRef),
}
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub enum PadMode {
#[default]
Constant,
Reflect,
Edge,
}
impl std::str::FromStr for PadMode {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"constant" => Ok(PadMode::Constant),
"reflect" => Ok(PadMode::Reflect),
"edge" => Ok(PadMode::Edge),
_ => Err(format!("Invalid pad mode: {}", s)),
}
}
}
impl PadMode {
pub fn as_str(&self) -> &str {
match self {
PadMode::Constant => "constant",
PadMode::Reflect => "reflect",
PadMode::Edge => "edge",
}
}
}
#[derive(Debug, Clone, new)]
pub struct PadConfig {
pub pads: PadInput,
pub constant_value: ConstantValueInput,
pub mode: PadMode,
}
#[derive(Debug, Clone, NodeBuilder)]
pub struct PadNode {
pub name: String,
pub inputs: Vec<Argument>,
pub outputs: Vec<Argument>,
pub config: PadConfig,
}
pub(crate) struct PadProcessor;
impl NodeProcessor for PadProcessor {
type Config = PadConfig;
fn spec(&self) -> NodeSpec {
NodeSpec {
min_opset: 11,
max_opset: None,
inputs: InputSpec::Range(1, 4),
outputs: OutputSpec::Exact(1),
}
}
fn lift_constants(&self, node: &mut RawNode, _opset: usize) -> Result<(), ProcessError> {
if node.inputs.len() > 1 && node.inputs[1].is_constant() {
node.inputs[1].to_static()?;
}
if node.inputs.len() > 2 && node.inputs[2].is_constant() {
node.inputs[2].to_static()?;
}
Ok(())
}
fn infer_types(
&self,
node: &mut RawNode,
_opset: usize,
_output_preferences: &OutputPreferences,
) -> Result<(), ProcessError> {
if let Some(input) = node.inputs.first() {
node.outputs[0].ty = input.ty.clone();
}
Ok(())
}
fn extract_config(&self, node: &RawNode, _opset: usize) -> Result<Self::Config, ProcessError> {
fn get_mode(node: &RawNode) -> Result<PadMode, ProcessError> {
use std::str::FromStr;
for (key, value) in node.attrs.iter() {
if key.as_str() == "mode" {
let mode_str = value.clone().into_string();
let mode = PadMode::from_str(&mode_str).map_err(|e| {
ProcessError::InvalidAttribute {
name: "mode".to_string(),
reason: e,
}
})?;
return Ok(mode);
}
}
Ok(PadMode::default())
}
fn get_pads(node: &RawNode) -> Result<PadInput, ProcessError> {
if node.inputs.len() >= 4 {
return Err(ProcessError::Custom(
"Pad: axes input is not supported".to_string(),
));
}
let input_dim = match &node.inputs.first().unwrap().ty {
ArgType::Tensor(tensor) => tensor.rank,
_ => {
return Err(ProcessError::TypeMismatch {
expected: "Tensor".to_string(),
actual: "Pad: Only tensor input is valid".to_string(),
});
}
};
for (key, value) in node.attrs.iter() {
if key.as_str() == "pads" {
let pads = value
.clone()
.into_i64s()
.iter()
.map(|&x| {
if x < 0 {
return Err(ProcessError::InvalidAttribute {
name: "pads".to_string(),
reason: "Negative pad is not supported".to_string(),
});
}
Ok(x as usize)
})
.collect::<Result<Vec<usize>, ProcessError>>()?;
if pads.len() != input_dim * 2 {
return Err(ProcessError::InvalidAttribute {
name: "pads".to_string(),
reason: "pads should be a 1D tensor of shape [2 * num_axes]"
.to_string(),
});
}
if input_dim < 2 {
return Err(ProcessError::Custom(
"Pad: input tensor should be rank 2 or higher".to_string(),
));
}
let validated_pads = validate_and_reorder_pads(&pads, input_dim)?;
return Ok(PadInput::Static(validated_pads));
}
}
if node.inputs.len() > 1 {
let input = &node.inputs[1];
match input.value() {
None => {
return Ok(PadInput::Runtime(RuntimeInputRef::new(
input.name.clone(),
1,
)));
}
Some(tensor_data) => {
let pad_values: Vec<i64> = tensor_data.to_vec().unwrap();
let pads = pad_values
.iter()
.map(|&x| {
if x < 0 {
return Err(ProcessError::Custom(
"Pad: Negative pad is not supported".to_string(),
));
}
Ok(x as usize)
})
.collect::<Result<Vec<usize>, ProcessError>>()?;
if pads.len() != input_dim * 2 {
return Err(ProcessError::Custom(
"Pad: pads should be a 1D tensor of shape [2 * num_axes]"
.to_string(),
));
}
if input_dim < 2 {
return Err(ProcessError::Custom(
"Pad: input tensor should be rank 2 or higher".to_string(),
));
}
let validated_pads = validate_and_reorder_pads(&pads, input_dim)?;
return Ok(PadInput::Static(validated_pads));
}
}
}
Err(ProcessError::Custom(
"Pad: pads should be given as attribute or as input".to_string(),
))
}
fn validate_and_reorder_pads(
pads: &[usize],
input_dim: usize,
) -> Result<Vec<usize>, ProcessError> {
let left_index = input_dim - 1;
let top_index = input_dim - 2;
let right_index = pads.len() - 1;
let bottom_index = pads.len() - 2;
let index_list = [left_index, top_index, right_index, bottom_index];
for (index, &item) in pads.iter().enumerate() {
if !index_list.contains(&index) && item != 0 {
return Err(ProcessError::Custom(
"Pad: padding will only be applied to the last two dimensions but found non zero padding for other dimensions".to_string(),
));
}
}
let left = pads[left_index];
let top = pads[top_index];
let right = pads[right_index];
let bottom = pads[bottom_index];
Ok(vec![left, right, top, bottom])
}
fn get_constant_value(node: &RawNode) -> Result<ConstantValueInput, ProcessError> {
if node.attrs.contains_key("value") {
let constant_value = node.attrs.get("value").map(|value| match value {
AttributeValue::Float32(value) => Ok(*value),
_ => Err(ProcessError::InvalidAttribute {
name: "value".to_string(),
reason: "only float32 values are currently supported for constant value as attribute".to_string(),
}),
}).transpose()?.ok_or_else(|| ProcessError::Custom("constant_value should have had a value".to_string()))?;
return Ok(ConstantValueInput::Static(constant_value));
}
if let Some(input) = node.inputs.get(2) {
match input.value() {
None => {
return Ok(ConstantValueInput::Runtime(RuntimeInputRef::new(
input.name.clone(),
2,
)));
}
Some(tensor_data) => {
match tensor_data.scalar_f32() {
Ok(value) => return Ok(ConstantValueInput::Static(value)),
Err(_) => {
return Err(ProcessError::TypeMismatch {
expected: "float value".to_string(),
actual: "only float values are currently supported for constant value".to_string(),
});
}
}
}
}
}
Ok(ConstantValueInput::Static(0.0))
}
let mode = get_mode(node)?;
let pads = get_pads(node)?;
let constant_value = get_constant_value(node)?;
let config = PadConfig {
pads,
constant_value,
mode,
};
Ok(config)
}
fn build_node(&self, builder: RawNode, opset: usize) -> Node {
let config = self
.extract_config(&builder, opset)
.expect("Config extraction failed");
Node::Pad(PadNode {
name: builder.name,
inputs: builder.inputs,
outputs: builder.outputs,
config,
})
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::ir::{ArgType, Argument, DType, NodeType, TensorType};
use crate::node::test_utils::TestNodeBuilder;
fn create_test_node(
pad_attrs: Option<Vec<i64>>,
pad_inputs: Option<Vec<i64>>,
constant_value_attr: Option<f32>,
constant_value_input: Option<f32>,
mode: Option<&str>,
rank: usize,
) -> TestNodeBuilder {
let mut builder = TestNodeBuilder::new(NodeType::Pad, "test_pad")
.input_tensor_f32("data", rank, None)
.output_tensor_f32("output", rank, None);
if let Some(pads) = pad_inputs.clone() {
let pads_len = pads.len();
builder = builder.input_tensor_i64_data("pads", pads, vec![pads_len]);
}
if let Some(value) = constant_value_input {
builder = builder.input_scalar_tensor_f32("constant_value", Some(value));
}
if let Some(pads) = pad_attrs {
builder = builder.attr_ints("pads", pads);
}
if let Some(value) = constant_value_attr {
builder = builder.attr_float("value", value);
}
if let Some(mode_val) = mode {
builder = builder.attr_string("mode", mode_val);
}
builder
}
#[test]
fn test_pad_config_with_attrs() {
let pads = vec![0, 0, 1, 1];
let node = create_test_node(
Some(pads.clone()),
None,
Some(0.0),
None,
Some("constant"),
2,
)
.build_with_graph_data(16);
let mut node = node;
let processor = PadProcessor;
let prefs = OutputPreferences::new();
let config = processor.extract_config(&node, 16).unwrap();
processor.infer_types(&mut node, 16, &prefs).unwrap();
assert!(matches!(&config.pads, PadInput::Static(pads) if pads == &vec![0, 1, 0, 1]));
assert!(
matches!(&config.constant_value, ConstantValueInput::Static(v) if (*v - 0.0).abs() < 1e-6)
);
assert_eq!(config.mode, PadMode::Constant);
}
#[test]
fn test_pad_config_with_inputs() {
let pads = vec![0, 0, 1, 1];
let node = create_test_node(None, Some(pads.clone()), None, Some(1.0), None, 2)
.build_with_graph_data(16);
let mut node = node;
let processor = PadProcessor;
let prefs = OutputPreferences::new();
let config = processor.extract_config(&node, 16).unwrap();
processor.infer_types(&mut node, 16, &prefs).unwrap();
assert!(matches!(&config.pads, PadInput::Static(pads) if pads == &vec![0, 1, 0, 1]));
assert!(
matches!(&config.constant_value, ConstantValueInput::Static(v) if (*v - 1.0).abs() < 1e-6)
);
}
#[test]
fn test_pad_config_with_3d_tensor() {
let pads = vec![0, 0, 0, 0, 1, 1];
let node = create_test_node(
Some(pads.clone()),
None,
Some(0.5),
None,
Some("constant"),
3,
)
.build_with_graph_data(16);
let mut node = node;
let processor = PadProcessor;
let prefs = OutputPreferences::new();
let config = processor.extract_config(&node, 16).unwrap();
processor.infer_types(&mut node, 16, &prefs).unwrap();
assert!(matches!(&config.pads, PadInput::Static(pads) if pads == &vec![0, 1, 0, 1]));
assert!(
matches!(&config.constant_value, ConstantValueInput::Static(v) if (*v - 0.5).abs() < 1e-6)
);
}
#[test]
fn test_pad_config_attrs_override_inputs() {
let attr_pads = vec![0, 0, 2, 2];
let input_pads = vec![0, 0, 1, 1];
let node = create_test_node(
Some(attr_pads.clone()),
Some(input_pads),
Some(0.0),
Some(1.0),
Some("constant"),
2,
)
.build_with_graph_data(16);
let mut node = node;
let processor = PadProcessor;
let prefs = OutputPreferences::new();
let config = processor.extract_config(&node, 16).unwrap();
processor.infer_types(&mut node, 16, &prefs).unwrap();
assert!(matches!(&config.pads, PadInput::Static(pads) if pads == &vec![0, 2, 0, 2]));
assert!(
matches!(&config.constant_value, ConstantValueInput::Static(v) if (*v - 0.0).abs() < 1e-6)
);
}
fn create_test_node_with_runtime_inputs() -> TestNodeBuilder {
TestNodeBuilder::new(NodeType::Pad, "test_pad")
.input_tensor_f32("data", 2, None)
.input_tensor_i64("pads", 1, None) .input_tensor_f32("constant_value", 0, None) .output_tensor_f32("output", 2, None)
}
#[test]
fn test_pad_config_with_runtime_inputs() {
let node = create_test_node_with_runtime_inputs().build();
let mut node = node;
let processor = PadProcessor;
let prefs = OutputPreferences::new();
let config = processor.extract_config(&node, 16).unwrap();
processor.infer_types(&mut node, 16, &prefs).unwrap();
assert!(matches!(&config.pads, PadInput::Runtime(arg) if arg.name == "pads"));
assert!(
matches!(&config.constant_value, ConstantValueInput::Runtime(arg) if arg.name == "constant_value")
);
}
#[test]
fn test_pad_config_mixed_static_runtime_pads() {
let builder = TestNodeBuilder::new(NodeType::Pad, "test_pad")
.input_tensor_f32("data", 2, None)
.input_tensor_i64_data("pads", vec![0, 0, 1, 1], vec![4]) .input_tensor_f32("constant_value", 0, None) .output_tensor_f32("output", 2, None);
let node = builder.build_with_graph_data(16);
let mut node = node;
let processor = PadProcessor;
let prefs = OutputPreferences::new();
let config = processor.extract_config(&node, 16).unwrap();
processor.infer_types(&mut node, 16, &prefs).unwrap();
assert!(matches!(&config.pads, PadInput::Static(pads) if pads == &vec![0, 1, 0, 1]));
assert!(
matches!(&config.constant_value, ConstantValueInput::Runtime(arg) if arg.name == "constant_value")
);
}
#[test]
fn test_pad_config_mixed_runtime_static_constant() {
let builder = TestNodeBuilder::new(NodeType::Pad, "test_pad")
.input_tensor_f32("data", 2, None)
.input_tensor_i64("pads", 1, None) .input_scalar_tensor_f32("constant_value", Some(2.5)) .output_tensor_f32("output", 2, None);
let node = builder.build_with_graph_data(16);
let mut node = node;
let processor = PadProcessor;
let prefs = OutputPreferences::new();
let config = processor.extract_config(&node, 16).unwrap();
processor.infer_types(&mut node, 16, &prefs).unwrap();
assert!(matches!(&config.pads, PadInput::Runtime(arg) if arg.name == "pads"));
assert!(
matches!(&config.constant_value, ConstantValueInput::Static(v) if (*v - 2.5).abs() < 1e-6)
);
}
#[test]
fn test_pad_config_default_constant_value() {
let pads = vec![0, 0, 1, 1];
let node = create_test_node(None, Some(pads.clone()), None, None, None, 2)
.build_with_graph_data(16);
let mut node = node;
let processor = PadProcessor;
let prefs = OutputPreferences::new();
let config = processor.extract_config(&node, 16).unwrap();
processor.infer_types(&mut node, 16, &prefs).unwrap();
assert!(matches!(&config.pads, PadInput::Static(pads) if pads == &vec![0, 1, 0, 1]));
assert!(
matches!(&config.constant_value, ConstantValueInput::Static(v) if (*v - 0.0).abs() < 1e-6)
);
}
#[test]
fn test_pad_config_no_inputs() {
let mut node = create_test_node(None, None, None, None, None, 2).build_with_graph_data(16);
node.inputs = vec![];
let processor = PadProcessor;
let spec = processor.spec();
let result = crate::processor::validate_node_spec(&node, 16, &spec);
assert!(matches!(
result,
Err(ProcessError::InvalidInputCount { .. })
));
}
#[test]
fn test_pad_config_invalid_input_type() {
let mut node = create_test_node(Some(vec![0, 0, 1, 1]), None, None, None, None, 2)
.build_with_graph_data(16);
node.inputs[0].ty = ArgType::Scalar(DType::F32);
let node = node;
let processor = PadProcessor;
let _prefs = OutputPreferences::new();
let result = processor.extract_config(&node, 16);
assert!(matches!(result, Err(ProcessError::TypeMismatch { .. })));
}
#[test]
fn test_pad_config_with_axes_input() {
let mut node = create_test_node(None, Some(vec![0, 0, 1, 1]), None, Some(0.0), None, 2)
.build_with_graph_data(16);
node.inputs.push(Argument {
name: "axes".to_string(),
ty: ArgType::Tensor(TensorType {
dtype: DType::I64,
rank: 1,
static_shape: None,
}),
value_source: crate::ir::ValueSource::Dynamic,
value_store: None,
});
let node = node;
let processor = PadProcessor;
let _prefs = OutputPreferences::new();
let result = processor.extract_config(&node, 16);
assert!(matches!(result, Err(ProcessError::Custom(_))));
}
#[test]
fn test_pad_config_negative_pad() {
let node = create_test_node(Some(vec![0, 0, -1, 1]), None, None, None, None, 2)
.build_with_graph_data(16);
let node = node;
let processor = PadProcessor;
let _prefs = OutputPreferences::new();
let result = processor.extract_config(&node, 16);
assert!(matches!(result, Err(ProcessError::InvalidAttribute { .. })));
}
#[test]
fn test_pad_config_reflect_mode() {
let node = create_test_node(Some(vec![0, 0, 1, 1]), None, None, None, Some("reflect"), 2)
.build_with_graph_data(16);
let processor = PadProcessor;
let config = processor.extract_config(&node, 16).unwrap();
assert_eq!(config.mode, PadMode::Reflect);
}
#[test]
fn test_pad_config_edge_mode() {
let node = create_test_node(Some(vec![0, 0, 1, 1]), None, None, None, Some("edge"), 2)
.build_with_graph_data(16);
let processor = PadProcessor;
let config = processor.extract_config(&node, 16).unwrap();
assert_eq!(config.mode, PadMode::Edge);
}
#[test]
fn test_pad_config_invalid_mode() {
let node = create_test_node(
Some(vec![0, 0, 1, 1]),
None,
None,
None,
Some("invalid_mode"),
2,
)
.build_with_graph_data(16);
let processor = PadProcessor;
let result = processor.extract_config(&node, 16);
assert!(matches!(result, Err(ProcessError::InvalidAttribute { .. })));
}
#[test]
fn test_pad_config_no_pads() {
let node = create_test_node(None, None, None, None, None, 2).build_with_graph_data(16);
let node = node;
let processor = PadProcessor;
let _prefs = OutputPreferences::new();
let result = processor.extract_config(&node, 16);
assert!(matches!(result, Err(ProcessError::Custom(_))));
}
#[test]
fn test_pad_config_invalid_pads_length() {
let node = create_test_node(Some(vec![0, 0, 1]), None, None, None, None, 2)
.build_with_graph_data(16);
let node = node;
let processor = PadProcessor;
let _prefs = OutputPreferences::new();
let result = processor.extract_config(&node, 16);
assert!(matches!(result, Err(ProcessError::InvalidAttribute { .. })));
}
#[test]
fn test_pad_config_invalid_tensor_rank() {
let node =
create_test_node(Some(vec![0, 1]), None, None, None, None, 1).build_with_graph_data(16);
let node = node;
let processor = PadProcessor;
let _prefs = OutputPreferences::new();
let result = processor.extract_config(&node, 16);
assert!(matches!(result, Err(ProcessError::Custom(_))));
}
#[test]
fn test_pad_config_non_zero_padding_on_other_dimensions() {
let node = create_test_node(Some(vec![1, 0, 0, 0, 1, 1]), None, None, None, None, 3)
.build_with_graph_data(16);
let node = node;
let processor = PadProcessor;
let _prefs = OutputPreferences::new();
let result = processor.extract_config(&node, 16);
assert!(matches!(result, Err(ProcessError::Custom(_))));
}
}