bunsen 0.21.0

bunsen is acceleration tooling for burn
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

use std::fmt::Debug;

use burn::{
    Tensor,
    prelude::{
        Backend,
        Shape,
    },
    tensor::{
        BasicOps,
        DType,
    },
};

use crate::{
    burner::descriptors::{
        ParamDesc,
        ParamKindBinding,
        TensorKindDesc,
    },
    errors::{
        BunsenError,
        BunsenResult,
    },
};

/// This is meta-descriptor for a [`Tensor`].
#[derive(Debug, Clone, PartialEq)]
pub struct TensorDesc {
    kind: TensorKindDesc,
    dtype: DType,
    shape: Shape,
}

impl<B, const R: usize, K> From<&Tensor<B, R, K>> for TensorDesc
where
    B: Backend,
    K: BasicOps<B>,
    K: ParamKindBinding,
{
    fn from(param: &Tensor<B, R, K>) -> Self {
        Self {
            kind: TensorKindDesc::for_kind::<K>(),
            dtype: param.dtype(),
            shape: param.shape(),
        }
    }
}

/// Convert a string to a [`DType`].
pub fn dtype_from_str(dtype: &str) -> BunsenResult<DType> {
    Ok(match dtype {
        "F64" => DType::F64,
        "F32" => DType::F32,
        "Flex32" => DType::Flex32,
        "F16" => DType::F16,
        "BF16" => DType::BF16,
        "I64" => DType::I64,
        "I32" => DType::I32,
        "I16" => DType::I16,
        "I8" => DType::I8,
        "U64" => DType::U64,
        "U32" => DType::U32,
        "U16" => DType::U16,
        "U8" => DType::U8,
        _ => return Err(BunsenError::External(format!("Invalid dtype: {}", dtype))),
    })
}

impl TensorDesc {
    /// Create a new `TensorDesc`.
    pub fn new(
        kind: TensorKindDesc,
        dtype: DType,
        shape: Shape,
    ) -> Self {
        Self { kind, dtype, shape }
    }

    /// The [`TensorKindDesc`] kind wrapper.
    pub fn kind(&self) -> TensorKindDesc {
        self.kind
    }

    /// The dtype.
    pub fn dtype(&self) -> DType {
        self.dtype
    }

    /// The shape.
    pub fn shape(&self) -> &Shape {
        &self.shape
    }

    /// The rank of the shape.
    pub fn rank(&self) -> usize {
        self.shape.rank()
    }

    /// The number of elements in the shape.
    pub fn num_elements(&self) -> usize {
        self.shape.num_elements()
    }

    /// The estimated size of the tensor.
    /// This ignores alignment, padding, and metadata.
    pub fn size_estimate(&self) -> usize {
        self.dtype.size() * self.num_elements()
    }
}

/// A type alias for a [`ParamDesc`] of a [`TensorDesc`].
pub type TensorParamDesc = ParamDesc<TensorDesc>;

#[cfg(test)]
#[allow(unused)]
mod tests {
    use super::*;

    #[test]
    #[cfg(feature = "cuda")]
    fn test_tensor_desc() {
        type B = burn::backend::Cuda;
        let device = Default::default();

        {
            // Float
            let tensor: Tensor<B, 2> = Tensor::ones([2, 3], &device);

            let desc = TensorDesc::from(&tensor);

            assert_eq!(desc.kind, TensorKindDesc::Float);
            assert_eq!(desc.dtype, DType::F32);
            assert_eq!(desc.shape, Shape::new([2, 3]));

            assert_eq!(desc.rank(), 2);
            assert_eq!(desc.size_estimate(), DType::F32.size() * 2 * 3);
        }

        {
            // Bool
            let tensor: Tensor<B, 2, burn::tensor::Bool> = Tensor::zeros([2, 3], &device);

            let desc = TensorDesc::from(&tensor);

            assert_eq!(desc.kind, TensorKindDesc::Bool);
            assert_eq!(desc.dtype, tensor.dtype());
            assert_eq!(desc.shape, Shape::new([2, 3]));

            assert_eq!(desc.rank(), 2);
            assert_eq!(desc.size_estimate(), tensor.dtype().size() * 2 * 3);
        }

        {
            // Int
            let tensor: Tensor<B, 2, burn::tensor::Int> = Tensor::zeros([2, 3], &device);

            let desc = TensorDesc::from(&tensor);

            assert_eq!(desc.kind, TensorKindDesc::Int);
            assert_eq!(desc.dtype, tensor.dtype());
            assert_eq!(desc.shape, Shape::new([2, 3]));

            assert_eq!(desc.rank(), 2);
            assert_eq!(desc.size_estimate(), tensor.dtype().size() * 2 * 3);
        }
    }
}