tenflowers-core 0.1.1

Core tensor operations and execution engine for TenfloweRS
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
//! Layer Normalization Operations
//!
//! This module provides layer normalization operations optimized for transformer
//! architectures and other neural networks that benefit from normalizing across
//! the feature dimension rather than the batch dimension.

use crate::tensor::TensorStorage;
use crate::{Result, Tensor, TensorError};
use scirs2_core::numeric::{Float, FromPrimitive};

/// Layer normalization
/// Input shape: `[..., normalized_shape]`
/// Gamma/beta shapes: `[normalized_shape]`
pub fn layer_norm<T>(
    input: &Tensor<T>,
    gamma: &Tensor<T>,
    beta: &Tensor<T>,
    normalized_shape: &[usize],
    epsilon: T,
) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + Float
        + FromPrimitive
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    match (&input.storage, &gamma.storage, &beta.storage) {
        (
            TensorStorage::Cpu(input_arr),
            TensorStorage::Cpu(gamma_arr),
            TensorStorage::Cpu(beta_arr),
        ) => {
            let input_shape = input_arr.shape();
            let ndim = input_arr.ndim();

            // Validate normalized_shape
            if normalized_shape.len() > ndim {
                return Err(TensorError::InvalidShape {
                    operation: "layer_norm".to_string(),
                    reason: "normalized_shape has more dimensions than input".to_string(),
                    shape: Some(input_arr.shape().to_vec()),
                    context: None,
                });
            }

            let norm_start = ndim - normalized_shape.len();
            for (i, &dim) in normalized_shape.iter().enumerate() {
                if input_shape[norm_start + i] != dim {
                    return Err(TensorError::ShapeMismatch {
                        operation: "layer_norm".to_string(),
                        expected: format!("normalized_shape {normalized_shape:?}"),
                        got: format!("input shape {input_shape:?}"),
                        context: None,
                    });
                }
            }

            // Validate gamma/beta shapes
            if gamma_arr.shape() != normalized_shape || beta_arr.shape() != normalized_shape {
                return Err(TensorError::ShapeMismatch {
                    operation: "layer_norm".to_string(),
                    expected: format!("gamma/beta shape {normalized_shape:?}"),
                    got: format!(
                        "gamma: {:?}, beta: {:?}",
                        gamma_arr.shape(),
                        beta_arr.shape()
                    ),
                    context: None,
                });
            }

            let mut output = input_arr.clone();
            let total_elements = input_arr.len();
            let norm_size: usize = normalized_shape.iter().product();
            let batch_size = total_elements / norm_size;

            // Reshape for easier processing
            let reshaped_input = input_arr
                .view()
                .into_shape_with_order([batch_size, norm_size])
                .map_err(|e| TensorError::InvalidShape {
                    operation: "layer_norm".to_string(),
                    reason: e.to_string(),
                    shape: None,
                    context: None,
                })?;
            let mut reshaped_output = output
                .view_mut()
                .into_shape_with_order([batch_size, norm_size])
                .map_err(|e| TensorError::InvalidShape {
                    operation: "layer_norm".to_string(),
                    reason: e.to_string(),
                    shape: None,
                    context: None,
                })?;

            let gamma_flat = gamma_arr
                .view()
                .into_shape_with_order([norm_size])
                .map_err(|e| TensorError::InvalidShape {
                    operation: "layer_norm".to_string(),
                    reason: e.to_string(),
                    shape: None,
                    context: None,
                })?;
            let beta_flat = beta_arr
                .view()
                .into_shape_with_order([norm_size])
                .map_err(|e| TensorError::InvalidShape {
                    operation: "layer_norm".to_string(),
                    reason: e.to_string(),
                    shape: None,
                    context: None,
                })?;

            // Normalize each sample
            for i in 0..batch_size {
                // Calculate mean
                let mut sum = T::zero();
                for j in 0..norm_size {
                    sum = sum + reshaped_input[[i, j]];
                }
                let mean =
                    sum / T::from(norm_size).expect("norm_size should convert to numeric type");

                // Calculate variance
                let mut var_sum = T::zero();
                for j in 0..norm_size {
                    let diff = reshaped_input[[i, j]] - mean;
                    var_sum = var_sum + (diff * diff);
                }
                let variance =
                    var_sum / T::from(norm_size).expect("norm_size should convert to numeric type");
                let std_dev = (variance + epsilon).sqrt();

                // Normalize and scale
                for j in 0..norm_size {
                    let normalized = (reshaped_input[[i, j]] - mean) / std_dev;
                    reshaped_output[[i, j]] = gamma_flat[[j]] * normalized + beta_flat[[j]];
                }
            }

            Ok(Tensor::from_array(output))
        }
        #[cfg(feature = "gpu")]
        (TensorStorage::Gpu(_), TensorStorage::Gpu(_), TensorStorage::Gpu(_)) => {
            layer_norm_gpu(input, gamma, beta, normalized_shape, epsilon)
        }
        #[cfg(feature = "gpu")]
        _ => Err(TensorError::unsupported_operation_simple(
            "Mixed CPU/GPU layer norm not supported".to_string(),
        )),
    }
}

#[cfg(feature = "gpu")]
fn layer_norm_gpu<T>(
    input: &Tensor<T>,
    gamma: &Tensor<T>,
    beta: &Tensor<T>,
    normalized_shape: &[usize],
    epsilon: T,
) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + Float
        + FromPrimitive
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    use crate::gpu::buffer::GpuBuffer;
    use crate::tensor::TensorStorage;
    use wgpu::util::DeviceExt;

    if let (
        TensorStorage::Gpu(input_gpu),
        TensorStorage::Gpu(gamma_gpu),
        TensorStorage::Gpu(beta_gpu),
    ) = (&input.storage, &gamma.storage, &beta.storage)
    {
        let device = input_gpu.device();
        let queue = input_gpu.queue();

        let input_shape = input.shape();
        let ndim = input_shape.rank();

        // Validate normalized_shape
        if normalized_shape.len() > ndim {
            return Err(TensorError::InvalidShape {
                operation: "layer_norm".to_string(),
                reason: "normalized_shape has more dimensions than input".to_string(),
                shape: Some(input_shape.dims().to_vec()),
                context: None,
            });
        }

        let norm_start = ndim - normalized_shape.len();
        for (i, &dim) in normalized_shape.iter().enumerate() {
            if input_shape.dims()[norm_start + i] != dim {
                return Err(TensorError::ShapeMismatch {
                    operation: "layer_norm".to_string(),
                    expected: format!("normalized_shape {normalized_shape:?}"),
                    got: format!("input shape {:?}", input_shape.dims()),
                    context: None,
                });
            }
        }

        let total_elements = input_shape.dims().iter().product::<usize>();
        let norm_size: usize = normalized_shape.iter().product();
        let batch_size = total_elements / norm_size;

        // Create output buffer
        let output_buffer = device.create_buffer(&wgpu::BufferDescriptor {
            label: Some("layer_norm_output"),
            size: (total_elements * std::mem::size_of::<T>()) as u64,
            usage: wgpu::BufferUsages::STORAGE
                | wgpu::BufferUsages::COPY_SRC
                | wgpu::BufferUsages::COPY_DST,
            mapped_at_creation: false,
        });

        // Create parameters uniform buffer
        #[repr(C)]
        #[derive(Copy, Clone, bytemuck::Pod, bytemuck::Zeroable)]
        struct NormalizationParams {
            normalized_size: u32,
            epsilon: f32,
        }

        let params = NormalizationParams {
            normalized_size: norm_size as u32,
            epsilon: epsilon.to_f32().unwrap_or(1e-5),
        };

        let params_buffer = device.create_buffer_init(&wgpu::util::BufferInitDescriptor {
            label: Some("layer_norm_params"),
            contents: bytemuck::cast_slice(&[params]),
            usage: wgpu::BufferUsages::UNIFORM,
        });

        // Load compute shader
        let shader_source = include_str!("../../gpu/shaders/normalization_ops.wgsl");
        let shader_module = device.create_shader_module(wgpu::ShaderModuleDescriptor {
            label: Some("layer_norm_shader"),
            source: wgpu::ShaderSource::Wgsl(shader_source.into()),
        });

        // Choose kernel based on normalized size (fused vs simple)
        let use_fused_kernel = norm_size >= 256;
        let entry_point = if use_fused_kernel {
            "layer_norm" // Fused kernel with shared memory optimization
        } else {
            "layer_norm_simple" // Simple kernel for smaller sizes
        };

        // Create bind group layout
        let bind_group_layout = device.create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor {
            label: Some("layer_norm_bind_group_layout"),
            entries: &[
                wgpu::BindGroupLayoutEntry {
                    binding: 0,
                    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: 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: false },
                        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::Uniform,
                        has_dynamic_offset: false,
                        min_binding_size: None,
                    },
                    count: None,
                },
            ],
        });

        // Create bind group
        let bind_group = device.create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some("layer_norm_bind_group"),
            layout: &bind_group_layout,
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: input_gpu.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: gamma_gpu.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 2,
                    resource: beta_gpu.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 3,
                    resource: output_buffer.as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 4,
                    resource: params_buffer.as_entire_binding(),
                },
            ],
        });

        // Create compute pipeline
        let pipeline_layout = device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor {
            label: Some("layer_norm_pipeline_layout"),
            bind_group_layouts: &[Some(&bind_group_layout)],
            immediate_size: 0,
        });

        let compute_pipeline = device.create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
            label: Some("layer_norm_pipeline"),
            layout: Some(&pipeline_layout),
            module: &shader_module,
            entry_point: Some(entry_point),
            cache: None,
            compilation_options: Default::default(),
        });

        // Dispatch compute shader
        let mut encoder = device.create_command_encoder(&wgpu::CommandEncoderDescriptor {
            label: Some("layer_norm_encoder"),
        });

        {
            let mut compute_pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
                label: Some("layer_norm_pass"),
                timestamp_writes: None,
            });

            compute_pass.set_pipeline(&compute_pipeline);
            compute_pass.set_bind_group(0, &bind_group, &[]);

            // Dispatch one workgroup per normalization group
            compute_pass.dispatch_workgroups(batch_size as u32, 1, 1);
        }

        queue.submit(std::iter::once(encoder.finish()));
        device.poll(wgpu::PollType::wait_indefinitely()).ok();

        // Create result tensor
        let device_id = match input.device() {
            crate::Device::Gpu(id) => *id,
            _ => {
                return Err(TensorError::device_error_simple(
                    "Expected GPU device".to_string(),
                ))
            }
        };

        let result_gpu = GpuBuffer::from_wgpu_buffer(
            output_buffer,
            input_gpu.device.clone(),
            input_gpu.queue.clone(),
            crate::Device::Gpu(device_id),
            total_elements,
        );

        let mut result = Tensor::from_gpu_buffer(result_gpu, input.shape().clone());
        result.set_requires_grad(input.requires_grad());
        Ok(result)
    } else {
        Err(TensorError::unsupported_operation_simple(
            "GPU layer norm requires GPU tensors".to_string(),
        ))
    }
}