use crate::device::{DeviceCapabilities, WorkloadType};
use crate::error::{BarracudaError, Result};
use crate::tensor::Tensor;
pub struct SageConv {
node_features: Tensor,
edge_index: Vec<(usize, usize)>,
weights: Tensor,
degrees: Vec<u32>,
num_nodes: usize,
num_edges: usize,
in_features: usize,
out_features: usize,
normalize: bool,
}
impl SageConv {
pub fn new(
node_features: Tensor,
edge_index: Vec<(usize, usize)>,
weights: Tensor,
degrees: Vec<u32>,
normalize: bool,
) -> Result<Self> {
let node_shape = node_features.shape();
if node_shape.len() != 2 {
return Err(BarracudaError::invalid_op(
"sage_conv",
"node_features must be 2D [num_nodes, in_features]",
));
}
let num_nodes = node_shape[0];
let in_features = node_shape[1];
if degrees.len() != num_nodes {
return Err(BarracudaError::invalid_op(
"sage_conv",
"degrees must have num_nodes elements",
));
}
let weight_shape = weights.shape();
if weight_shape.len() != 2 || weight_shape[0] != 2 * in_features {
return Err(BarracudaError::invalid_op(
"sage_conv",
"weights must be [2 * in_features, out_features]",
));
}
let out_features = weight_shape[1];
let num_edges = edge_index.len();
if num_edges == 0 {
return Err(BarracudaError::invalid_op(
"sage_conv",
"edge_index cannot be empty",
));
}
Ok(Self {
node_features,
edge_index,
weights,
degrees,
num_nodes,
num_edges,
in_features,
out_features,
normalize,
})
}
fn wgsl_shader() -> &'static str {
{
static SHADER: std::sync::LazyLock<String> = std::sync::LazyLock::new(|| {
include_str!("../shaders/gnn/sage_conv_f64.wgsl").to_string()
});
SHADER.as_str()
}
}
pub fn execute(self) -> Result<Tensor> {
let device = self.node_features.device();
let edge_data: Vec<u32> = self
.edge_index
.iter()
.flat_map(|(src, dst)| vec![*src as u32, *dst as u32])
.collect();
let edge_buffer = device
.device
.create_buffer_init(&wgpu::util::BufferInitDescriptor {
label: Some("SAGEConv Edge Index"),
contents: bytemuck::cast_slice(&edge_data),
usage: wgpu::BufferUsages::STORAGE | wgpu::BufferUsages::COPY_DST,
});
let degrees_buffer = device
.device
.create_buffer_init(&wgpu::util::BufferInitDescriptor {
label: Some("SAGEConv Degrees"),
contents: bytemuck::cast_slice(&self.degrees),
usage: wgpu::BufferUsages::STORAGE | wgpu::BufferUsages::COPY_DST,
});
let aggregated_size = self.num_nodes * self.in_features;
let aggregated_buffer = device.create_buffer_f32(aggregated_size)?;
let output_size = self.num_nodes * self.out_features;
let output_buffer = device.create_buffer_f32(output_size)?;
#[repr(C)]
#[derive(Copy, Clone, bytemuck::Pod, bytemuck::Zeroable)]
struct Params {
num_nodes: u32,
num_edges: u32,
in_features: u32,
out_features: u32,
normalize: u32,
_pad1: u32,
_pad2: u32,
_pad3: u32,
}
let params = Params {
num_nodes: self.num_nodes as u32,
num_edges: self.num_edges as u32,
in_features: self.in_features as u32,
out_features: self.out_features as u32,
normalize: u32::from(self.normalize),
_pad1: 0,
_pad2: 0,
_pad3: 0,
};
let params_buffer = device
.device
.create_buffer_init(&wgpu::util::BufferInitDescriptor {
label: Some("SAGEConv Params"),
contents: bytemuck::cast_slice(&[params]),
usage: wgpu::BufferUsages::UNIFORM | wgpu::BufferUsages::COPY_DST,
});
let shader_module = device.compile_shader(Self::wgsl_shader(), Some("SAGEConv Shader"));
let bind_group_layout =
device
.device
.create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor {
label: Some("SAGEConv Bind Group Layout"),
entries: &[
wgpu::BindGroupLayoutEntry {
binding: 0,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Uniform,
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
wgpu::BindGroupLayoutEntry {
binding: 1,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Storage { read_only: true },
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
wgpu::BindGroupLayoutEntry {
binding: 2,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Storage { read_only: true },
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
wgpu::BindGroupLayoutEntry {
binding: 3,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Storage { read_only: true },
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
wgpu::BindGroupLayoutEntry {
binding: 4,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Storage { read_only: true },
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
wgpu::BindGroupLayoutEntry {
binding: 5,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Storage { read_only: false },
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
wgpu::BindGroupLayoutEntry {
binding: 6,
visibility: wgpu::ShaderStages::COMPUTE,
ty: wgpu::BindingType::Buffer {
ty: wgpu::BufferBindingType::Storage { read_only: false },
has_dynamic_offset: false,
min_binding_size: None,
},
count: None,
},
],
});
let bind_group = device.device.create_bind_group(&wgpu::BindGroupDescriptor {
label: Some("SAGEConv Bind Group"),
layout: &bind_group_layout,
entries: &[
wgpu::BindGroupEntry {
binding: 0,
resource: params_buffer.as_entire_binding(),
},
wgpu::BindGroupEntry {
binding: 1,
resource: self.node_features.buffer().as_entire_binding(),
},
wgpu::BindGroupEntry {
binding: 2,
resource: edge_buffer.as_entire_binding(),
},
wgpu::BindGroupEntry {
binding: 3,
resource: self.weights.buffer().as_entire_binding(),
},
wgpu::BindGroupEntry {
binding: 4,
resource: degrees_buffer.as_entire_binding(),
},
wgpu::BindGroupEntry {
binding: 5,
resource: aggregated_buffer.as_entire_binding(),
},
wgpu::BindGroupEntry {
binding: 6,
resource: output_buffer.as_entire_binding(),
},
],
});
let pipeline_layout =
device
.device
.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor {
label: Some("SAGEConv Pipeline Layout"),
bind_group_layouts: &[&bind_group_layout],
immediate_size: 0,
});
let mut encoder = device.create_encoder_guarded(&wgpu::CommandEncoderDescriptor {
label: Some("SAGEConv Encoder"),
});
let aggregate_pipeline =
device
.device
.create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
label: Some("SAGEConv Aggregate Pipeline"),
layout: Some(&pipeline_layout),
module: &shader_module,
entry_point: Some("aggregate"),
cache: None,
compilation_options: Default::default(),
});
{
let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
label: Some("SAGEConv Aggregate Pass"),
timestamp_writes: None,
});
pass.set_pipeline(&aggregate_pipeline);
pass.set_bind_group(0, Some(&bind_group), &[]);
let caps = DeviceCapabilities::from_device(device);
let optimal_wg_size = caps.optimal_workgroup_size(WorkloadType::MatMul);
let workgroups = (self.num_edges as u32).div_ceil(optimal_wg_size);
pass.dispatch_workgroups(workgroups, 1, 1);
}
let transform_pipeline =
device
.device
.create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
label: Some("SAGEConv Transform Pipeline"),
layout: Some(&pipeline_layout),
module: &shader_module,
entry_point: Some("apply_transform"),
cache: None,
compilation_options: Default::default(),
});
{
let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
label: Some("SAGEConv Transform Pass"),
timestamp_writes: None,
});
pass.set_pipeline(&transform_pipeline);
pass.set_bind_group(0, Some(&bind_group), &[]);
let caps = DeviceCapabilities::from_device(device);
let optimal_wg_size = caps.optimal_workgroup_size(WorkloadType::MatMul);
let workgroups = (self.num_nodes as u32).div_ceil(optimal_wg_size);
pass.dispatch_workgroups(workgroups, 1, 1);
}
if self.normalize {
let normalize_pipeline =
device
.device
.create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
label: Some("SAGEConv Normalize Pipeline"),
layout: Some(&pipeline_layout),
module: &shader_module,
entry_point: Some("normalize_output"),
cache: None,
compilation_options: Default::default(),
});
{
let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
label: Some("SAGEConv Normalize Pass"),
timestamp_writes: None,
});
pass.set_pipeline(&normalize_pipeline);
pass.set_bind_group(0, Some(&bind_group), &[]);
let caps = DeviceCapabilities::from_device(device);
let optimal_wg_size = caps.optimal_workgroup_size(WorkloadType::MatMul);
let workgroups = (self.num_nodes as u32).div_ceil(optimal_wg_size);
pass.dispatch_workgroups(workgroups, 1, 1);
}
}
device.submit_commands(Some(encoder.finish()));
Ok(Tensor::from_buffer(
output_buffer,
vec![self.num_nodes, self.out_features],
device.clone(),
))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[tokio::test]
async fn test_sage_conv_basic() {
let device = crate::device::test_pool::get_test_device().await;
let num_nodes = 4;
let in_features = 8;
let out_features = 16;
let node_features = Tensor::from_vec_on(
vec![1.0; num_nodes * in_features],
vec![num_nodes, in_features],
device.clone(),
)
.await
.unwrap();
let edge_index = vec![(0, 1), (1, 2), (2, 3), (3, 0)];
let degrees = vec![1u32; num_nodes];
let weights = Tensor::from_vec_on(
vec![0.1; 2 * in_features * out_features],
vec![2 * in_features, out_features],
device.clone(),
)
.await
.unwrap();
let sage = SageConv::new(node_features, edge_index, weights, degrees, false).unwrap();
let output = sage.execute().unwrap();
assert_eq!(output.shape(), &[num_nodes, out_features]);
}
#[tokio::test]
async fn test_sage_conv_with_normalize() {
let device = crate::device::test_pool::get_test_device().await;
let num_nodes = 3;
let in_features = 4;
let out_features = 8;
let node_features = Tensor::from_vec_on(
vec![1.0; num_nodes * in_features],
vec![num_nodes, in_features],
device.clone(),
)
.await
.unwrap();
let edge_index = vec![(0, 1), (1, 2)];
let degrees = vec![1u32; num_nodes];
let weights = Tensor::from_vec_on(
vec![0.1; 2 * in_features * out_features],
vec![2 * in_features, out_features],
device.clone(),
)
.await
.unwrap();
let sage = SageConv::new(node_features, edge_index, weights, degrees, true).unwrap();
let output = sage.execute().unwrap();
assert_eq!(output.shape(), &[num_nodes, out_features]);
}
#[tokio::test]
async fn test_sage_conv_large_batch() {
let device = crate::device::test_pool::get_test_device().await;
let num_nodes = 100;
let in_features = 64;
let out_features = 128;
let node_features = Tensor::from_vec_on(
vec![1.0; num_nodes * in_features],
vec![num_nodes, in_features],
device.clone(),
)
.await
.unwrap();
let edge_index: Vec<(usize, usize)> =
(0..num_nodes).map(|i| (i, (i + 1) % num_nodes)).collect();
let degrees = vec![1u32; num_nodes];
let weights = Tensor::from_vec_on(
vec![0.1; 2 * in_features * out_features],
vec![2 * in_features, out_features],
device.clone(),
)
.await
.unwrap();
let sage = SageConv::new(node_features, edge_index, weights, degrees, false).unwrap();
let output = sage.execute().unwrap();
assert_eq!(output.shape(), &[num_nodes, out_features]);
}
}