cubek-fft 0.3.0

CubeK: Fast Fourier Transform
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

use std::marker::PhantomData;

use cubecl::{
    benchmark::{Benchmark, TimingMethod},
    client::Client,
    future,
    prelude::*,
    std::tensor::TensorHandle,
    zspace::Shape,
};
use cubek_test_utils::{RunSamples, StridedLayout, TestInput};

use crate::eval::benchmarks::problem::FftProblem;
use crate::eval::benchmarks::strategy::FftStrategy;
use crate::{FftMode, irfft_launch, rfft_launch};

pub fn bench(
    _strategy: &FftStrategy,
    problem: &FftProblem,
    num_samples: usize,
) -> Result<RunSamples, String> {
    let device = cubecl::test_device();
    let client = device.client();

    let bench = FftBench::<f32> {
        shape: problem.shape.clone(),
        mode: problem.mode,
        device,
        client,
        samples: num_samples,
        _e: PhantomData,
    };

    let durations = bench
        .run(cubek_test_utils::timing_method(TimingMethod::System))
        .map_err(|e| format!("benchmark failed: {e}"))?
        .durations;

    Ok(RunSamples::new(durations))
}

struct FftBench<E> {
    shape: Vec<usize>,
    mode: FftMode,
    device: cubecl::Device,
    client: Client,
    samples: usize,
    _e: PhantomData<E>,
}

#[derive(Clone)]
struct FftInput {
    signal: TensorHandle,
    spectrum_re: TensorHandle,
    spectrum_im: TensorHandle,
}

fn make_uniform(client: &Client, shape: Vec<usize>, dtype: ElemType, seed: u64) -> TensorHandle {
    TestInput::builder(client.clone(), Shape::from(shape))
        .layout(StridedLayout::RowMajor)
        .dtype(dtype)
        .uniform(seed, 0., 1.)
        .generate_without_host_data()
}

fn empty_handle(client: &Client, shape: Vec<usize>, elem: impl Into<Type>) -> TensorHandle {
    TensorHandle::empty(client, shape, elem)
}

impl<E: Float> Benchmark for FftBench<E> {
    type Input = FftInput;
    type Output = ();

    fn prepare(&self) -> Self::Input {
        let client = self.device.client();
        let elem = E::elem_type_native();

        let mut shape_out = self.shape.clone();
        let dim = self.shape.len() - 1;
        shape_out[dim] = self.shape[dim] / 2 + 1;

        match self.mode {
            FftMode::Forward => {
                let signal = make_uniform(&client, self.shape.clone(), elem, 0);
                let spectrum_re = empty_handle(&client, shape_out.clone(), elem);
                let spectrum_im = empty_handle(&client, shape_out, elem);
                FftInput {
                    signal,
                    spectrum_re,
                    spectrum_im,
                }
            }
            FftMode::Inverse => {
                let signal = empty_handle(&client, self.shape.clone(), elem);
                let spectrum_re = make_uniform(&client, shape_out.clone(), elem, 0);
                let spectrum_im = make_uniform(&client, shape_out, elem, 1);
                FftInput {
                    signal,
                    spectrum_re,
                    spectrum_im,
                }
            }
        }
    }

    fn execute(&self, input: Self::Input) -> Result<(), String> {
        let dim = self.shape.len() - 1;
        match self.mode {
            FftMode::Forward => rfft_launch(
                &self.client,
                input.signal.binding(),
                input.spectrum_re.binding(),
                input.spectrum_im.binding(),
                dim,
                E::elem_type_native(),
            )
            .map_err(|err| format!("{err}"))?,
            FftMode::Inverse => irfft_launch(
                &self.client,
                input.spectrum_re.binding(),
                input.spectrum_im.binding(),
                input.signal.binding(),
                dim,
                E::elem_type_native(),
            )
            .map_err(|err| format!("{err}"))?,
        }
        Ok(())
    }

    fn num_samples(&self) -> usize {
        self.samples
    }

    fn name(&self) -> String {
        format!(
            "fft-{}-{:?}-{:?}",
            E::elem_type_native(),
            self.shape,
            self.mode,
        )
        .to_lowercase()
    }

    fn sync(&self) {
        future::block_on(self.client.sync()).unwrap()
    }
}