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
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
//! Basic GPU Linear Algebra Operations
//!
//! This module provides fundamental GPU operations like matrix transpose and
//! multiplication that form the building blocks for more complex linear algebra
//! algorithms. These operations are optimized for GPU execution patterns.

use super::context::{GpuLinalgContext, LinalgMetadata};
use crate::gpu::buffer::GpuBuffer;
use crate::{Result, Shape, TensorError};
use bytemuck::{Pod, Zeroable};
use scirs2_core::numeric::Float;

/// Matrix transpose operation
pub fn transpose<T>(
    context: &mut GpuLinalgContext,
    input: &GpuBuffer<T>,
    output: &GpuBuffer<T>,
    shape: &Shape,
) -> Result<()>
where
    T: Float + Pod + Zeroable + Send + Sync + 'static,
{
    context.transpose(input, output, shape)
}

/// Matrix multiplication optimized for linear algebra operations
pub fn matmul_linalg<T>(
    context: &mut GpuLinalgContext,
    a: &GpuBuffer<T>,
    b: &GpuBuffer<T>,
    c: &GpuBuffer<T>,
    shape_a: &Shape,
    shape_b: &Shape,
) -> Result<()>
where
    T: Float + Pod + Zeroable + Send + Sync + 'static,
{
    context.matmul_linalg(a, b, c, shape_a, shape_b)
}

/// Adaptive matrix multiplication that selects optimal parameters based on matrix dimensions
pub fn adaptive_matmul_linalg<T>(
    context: &mut GpuLinalgContext,
    a: &GpuBuffer<T>,
    b: &GpuBuffer<T>,
    c: &GpuBuffer<T>,
    shape_a: &Shape,
    shape_b: &Shape,
) -> Result<()>
where
    T: Float + Pod + Zeroable + Send + Sync + 'static,
{
    context.adaptive_matmul_linalg(a, b, c, shape_a, shape_b)
}

impl GpuLinalgContext {
    /// Matrix transpose operation
    pub fn transpose<T>(
        &mut self,
        input: &GpuBuffer<T>,
        output: &GpuBuffer<T>,
        shape: &Shape,
    ) -> Result<()>
    where
        T: Float + Pod + Zeroable + Clone + Send + Sync + 'static,
    {
        // Ensure pipeline is initialized
        if self.transpose_pipeline.is_none() {
            self.initialize_pipelines()?;
        }

        let pipeline =
            self.transpose_pipeline
                .as_ref()
                .ok_or_else(|| TensorError::ComputeError {
                    operation: "transpose".to_string(),
                    details: "Transpose pipeline not initialized".to_string(),
                    retry_possible: false,
                    context: None,
                })?;

        // Create metadata
        let metadata = LinalgMetadata::new(shape[0], shape[1]);
        let metadata_buffer = self.create_metadata_buffer(&metadata)?;

        // Create bind group
        let bind_group = self.device().create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some("transpose_bind_group"),
            layout: &pipeline.get_bind_group_layout(0),
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: input.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: output.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 2,
                    resource: metadata_buffer.as_entire_binding(),
                },
            ],
        });

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

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

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

            // Dispatch with workgroup size optimization
            let workgroup_size = 16; // 16x16 workgroups for 2D operations
            let workgroups_x = (shape[1] + workgroup_size - 1) / workgroup_size;
            let workgroups_y = (shape[0] + workgroup_size - 1) / workgroup_size;

            compute_pass.dispatch_workgroups(workgroups_x as u32, workgroups_y as u32, 1);
        }

        self.queue().submit(std::iter::once(encoder.finish()));
        Ok(())
    }

    /// Matrix multiplication optimized for linear algebra operations
    pub fn matmul_linalg<T>(
        &mut self,
        a: &GpuBuffer<T>,
        b: &GpuBuffer<T>,
        c: &GpuBuffer<T>,
        shape_a: &Shape,
        shape_b: &Shape,
    ) -> Result<()>
    where
        T: Float + Pod + Zeroable + Clone + Send + Sync + 'static,
    {
        // Ensure pipeline is initialized
        if self.matmul_linalg_pipeline.is_none() {
            self.initialize_pipelines()?;
        }

        let pipeline =
            self.matmul_linalg_pipeline
                .as_ref()
                .ok_or_else(|| TensorError::ComputeError {
                    operation: "matmul".to_string(),
                    details: "Matrix multiplication pipeline not initialized".to_string(),
                    retry_possible: false,
                    context: None,
                })?;

        // Validate matrix dimensions
        if shape_a.len() != 2 || shape_b.len() != 2 {
            return Err(TensorError::invalid_shape_simple(
                "Matrix multiplication requires 2D tensors".to_string(),
            ));
        }

        if shape_a[1] != shape_b[0] {
            return Err(TensorError::ShapeMismatch {
                operation: "matmul_linalg".to_string(),
                expected: format!(
                    "inner dimensions to match (got {} vs {})",
                    shape_a[1], shape_b[0]
                ),
                got: format!("shapes {:?} and {:?}", shape_a, shape_b),
                context: None,
            });
        }

        // Create metadata
        let metadata =
            LinalgMetadata::new_two_matrices(shape_a[0], shape_a[1], shape_b[0], shape_b[1]);
        let metadata_buffer = self.create_metadata_buffer(&metadata)?;

        // Create bind group
        let bind_group = self.device().create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some("matmul_linalg_bind_group"),
            layout: &pipeline.get_bind_group_layout(0),
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: a.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: b.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 2,
                    resource: c.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 3,
                    resource: metadata_buffer.as_entire_binding(),
                },
            ],
        });

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

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

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

            // Dispatch with tiled workgroups for optimal memory access
            let tile_size = 16;
            let workgroups_x = (shape_b[1] + tile_size - 1) / tile_size;
            let workgroups_y = (shape_a[0] + tile_size - 1) / tile_size;

            compute_pass.dispatch_workgroups(workgroups_x as u32, workgroups_y as u32, 1);
        }

        self.queue().submit(std::iter::once(encoder.finish()));
        Ok(())
    }

    /// Adaptive matrix multiplication that selects optimal parameters based on matrix dimensions
    pub fn adaptive_matmul_linalg<T>(
        &mut self,
        a: &GpuBuffer<T>,
        b: &GpuBuffer<T>,
        c: &GpuBuffer<T>,
        shape_a: &Shape,
        shape_b: &Shape,
    ) -> Result<()>
    where
        T: Float + Pod + Zeroable + Clone + Send + Sync + 'static,
    {
        // Validate matrix dimensions
        if shape_a.len() != 2 || shape_b.len() != 2 {
            return Err(TensorError::invalid_shape_simple(
                "Matrix multiplication requires 2D tensors".to_string(),
            ));
        }

        if shape_a[1] != shape_b[0] {
            return Err(TensorError::ShapeMismatch {
                operation: "adaptive_matmul_linalg".to_string(),
                expected: format!(
                    "inner dimensions to match (got {} vs {})",
                    shape_a[1], shape_b[0]
                ),
                got: format!("shapes {:?} and {:?}", shape_a, shape_b),
                context: None,
            });
        }

        let m = shape_a[0];
        let k = shape_a[1];
        let n = shape_b[1];

        // Select optimal parameters using adaptive configuration
        let tile_size = self.adaptive_gemm_config().select_tile_size(m, n, k);
        let (workgroup_x, workgroup_y) = self.adaptive_gemm_config().select_workgroup_size(m, n, k);

        // Estimate performance characteristics
        let bandwidth_utilization = self
            .adaptive_gemm_config()
            .estimate_bandwidth_utilization(m, n, k);

        // For very high bandwidth utilization, prefer shared memory optimization
        if bandwidth_utilization > 0.8 && self.adaptive_gemm_config().prefer_shared_memory {
            self.matmul_with_shared_memory_optimization(a, b, c, shape_a, shape_b, tile_size)
        } else {
            self.matmul_with_memory_coalescing_optimization(
                a,
                b,
                c,
                shape_a,
                shape_b,
                workgroup_x,
                workgroup_y,
            )
        }
    }

    /// Matrix multiplication with shared memory optimization for high data reuse scenarios
    fn matmul_with_shared_memory_optimization<T>(
        &mut self,
        a: &GpuBuffer<T>,
        b: &GpuBuffer<T>,
        c: &GpuBuffer<T>,
        shape_a: &Shape,
        shape_b: &Shape,
        tile_size: u32,
    ) -> Result<()>
    where
        T: Float + Pod + Zeroable + Clone + Send + Sync + 'static,
    {
        // Ensure pipeline is initialized
        if self.matmul_linalg_pipeline.is_none() {
            self.initialize_pipelines()?;
        }

        let pipeline =
            self.matmul_linalg_pipeline
                .as_ref()
                .ok_or_else(|| TensorError::ComputeError {
                    operation: "matmul".to_string(),
                    details: "Matrix multiplication pipeline not initialized".to_string(),
                    retry_possible: false,
                    context: None,
                })?;

        // Create metadata with tile size hint
        let mut metadata =
            LinalgMetadata::new_two_matrices(shape_a[0], shape_a[1], shape_b[0], shape_b[1]);
        // Store tile size in max_iterations field as a hint to the shader
        metadata.max_iterations = tile_size;
        let metadata_buffer = self.create_metadata_buffer(&metadata)?;

        // Create bind group
        let bind_group = self.device().create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some("adaptive_matmul_shared_bind_group"),
            layout: &pipeline.get_bind_group_layout(0),
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: a.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: b.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 2,
                    resource: c.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 3,
                    resource: metadata_buffer.as_entire_binding(),
                },
            ],
        });

        // Dispatch compute with optimal tile size
        let mut encoder = self
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("adaptive_matmul_shared_encoder"),
            });

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

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

            // Use the adaptive tile size for workgroup dispatch
            let workgroups_x = (shape_b[1] + tile_size as usize - 1) / tile_size as usize;
            let workgroups_y = (shape_a[0] + tile_size as usize - 1) / tile_size as usize;

            compute_pass.dispatch_workgroups(workgroups_x as u32, workgroups_y as u32, 1);
        }

        self.queue().submit(std::iter::once(encoder.finish()));
        Ok(())
    }

    /// Matrix multiplication with memory coalescing optimization for bandwidth-bound scenarios
    fn matmul_with_memory_coalescing_optimization<T>(
        &mut self,
        a: &GpuBuffer<T>,
        b: &GpuBuffer<T>,
        c: &GpuBuffer<T>,
        shape_a: &Shape,
        shape_b: &Shape,
        workgroup_x: u32,
        workgroup_y: u32,
    ) -> Result<()>
    where
        T: Float + Pod + Zeroable + Clone + Send + Sync + 'static,
    {
        // Ensure pipeline is initialized
        if self.matmul_linalg_pipeline.is_none() {
            self.initialize_pipelines()?;
        }

        let pipeline =
            self.matmul_linalg_pipeline
                .as_ref()
                .ok_or_else(|| TensorError::ComputeError {
                    operation: "matmul".to_string(),
                    details: "Matrix multiplication pipeline not initialized".to_string(),
                    retry_possible: false,
                    context: None,
                })?;

        // Create metadata
        let metadata =
            LinalgMetadata::new_two_matrices(shape_a[0], shape_a[1], shape_b[0], shape_b[1]);
        let metadata_buffer = self.create_metadata_buffer(&metadata)?;

        // Create bind group
        let bind_group = self.device().create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some("adaptive_matmul_coalescing_bind_group"),
            layout: &pipeline.get_bind_group_layout(0),
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: a.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: b.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 2,
                    resource: c.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 3,
                    resource: metadata_buffer.as_entire_binding(),
                },
            ],
        });

        // Dispatch compute with optimal workgroup sizes for memory coalescing
        let mut encoder = self
            .device()
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("adaptive_matmul_coalescing_encoder"),
            });

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

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

            // Use adaptive workgroup sizes optimized for memory access patterns
            let workgroups_x = (shape_b[1] + workgroup_x as usize - 1) / workgroup_x as usize;
            let workgroups_y = (shape_a[0] + workgroup_y as usize - 1) / workgroup_y as usize;

            compute_pass.dispatch_workgroups(workgroups_x as u32, workgroups_y as u32, 1);
        }

        self.queue().submit(std::iter::once(encoder.finish()));
        Ok(())
    }
}