bunsen 0.21.0-pre.2

bunsen is a community companion library 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

use burn::prelude;
use strum;

/// A meta-descriptor for [`burn::tensor::TensorKind`].
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, strum::EnumString, strum::Display,
)]
#[non_exhaustive]
pub enum TensorKindDesc {
    /// A Bool Tensor
    /// Equivalent to [`burn::tensor::Bool`].
    Bool,

    /// A Float Tensor
    /// Equivalent to [`burn::tensor::Float`].
    Float,

    /// An Int Tensor
    /// Equivalent to [`burn::tensor::Int`].
    Int,
}

impl TensorKindDesc {
    /// Get the [`TensorKindDesc`] for a kit [`burn::tensor::TensorKind`].
    pub const fn for_kind<K: ParamKindBinding>() -> Self {
        K::KIND
    }
}

/// A trait that binds a kit Tensor Kind to a `ParamKind`.
pub trait ParamKindBinding {
    /// The [`TensorKindDesc`] kind wrapper.
    const KIND: TensorKindDesc;
}

impl ParamKindBinding for prelude::Bool {
    const KIND: TensorKindDesc = TensorKindDesc::Bool;
}

impl ParamKindBinding for prelude::Float {
    const KIND: TensorKindDesc = TensorKindDesc::Float;
}

impl ParamKindBinding for prelude::Int {
    const KIND: TensorKindDesc = TensorKindDesc::Int;
}

#[cfg(test)]
mod tests {
    use burn::tensor;

    use crate::kit::descriptors::TensorKindDesc;

    #[test]
    fn test_tensor_kinds() {
        assert_eq!(
            TensorKindDesc::for_kind::<tensor::Bool>(),
            TensorKindDesc::Bool
        );
        assert_eq!(
            TensorKindDesc::for_kind::<tensor::Float>(),
            TensorKindDesc::Float
        );
        assert_eq!(
            TensorKindDesc::for_kind::<tensor::Int>(),
            TensorKindDesc::Int
        );
    }
}