onednnl 0.0.1

high-level bindings to oneDNN Deep Learning library
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

use {
    crate::error::DnnlError,
    onednnl_sys::{
        dnnl_accumulation_mode_t, dnnl_primitive_attr_create, dnnl_primitive_attr_destroy,
        dnnl_primitive_attr_get_accumulation_mode, dnnl_primitive_attr_get_deterministic,
        dnnl_primitive_attr_set_accumulation_mode, dnnl_primitive_attr_set_deterministic,
        dnnl_primitive_attr_t,
        dnnl_status_t::{self},
    },
};

pub struct PrimitiveAttributes {
    pub(crate) handle: dnnl_primitive_attr_t,
}

impl PrimitiveAttributes {
    /// Create a PrimitiveAttributes
    ///
    /// ```
    /// use onednnl::primitive::attributes::PrimitiveAttributes;
    ///
    /// let attr = PrimitiveAttributes::new();
    ///
    /// assert!(attr.is_ok());
    /// ```
    pub fn new() -> Result<Self, DnnlError> {
        let mut handle = std::ptr::null_mut();
        let status = unsafe { dnnl_primitive_attr_create(&mut handle) };

        if status == dnnl_status_t::dnnl_success {
            Ok(Self { handle })
        } else {
            Err(status.into())
        }
    }

    /// Get the accumulation mode
    ///
    /// ```
    /// use {
    ///     onednnl::primitive::attributes::PrimitiveAttributes, onednnl_sys::dnnl_accumulation_mode_t,
    /// };
    ///
    /// let attr = PrimitiveAttributes::new();
    ///
    /// assert!(attr.is_ok());
    ///
    /// let attr = attr.unwrap();
    ///
    /// assert_eq!(
    ///     attr.get_accumulation_mode(),
    ///     Ok(dnnl_accumulation_mode_t::dnnl_accumulation_mode_strict)
    /// );
    /// ```
    pub fn get_accumulation_mode(&self) -> Result<dnnl_accumulation_mode_t::Type, DnnlError> {
        let mut output = 0;
        let status = unsafe { dnnl_primitive_attr_get_accumulation_mode(self.handle, &mut output) };

        if status == dnnl_status_t::dnnl_success {
            Ok(output)
        } else {
            Err(status.into())
        }
    }

    /// Set the accumulation mode
    ///
    /// ```
    /// use {
    ///     onednnl::primitive::attributes::PrimitiveAttributes, onednnl_sys::dnnl_accumulation_mode_t,
    /// };
    ///
    /// let attr = PrimitiveAttributes::new();
    ///
    /// assert!(attr.is_ok());
    ///
    /// let mut attr = attr.unwrap();
    ///
    /// assert!(attr
    ///     .set_accumulation_mode(dnnl_accumulation_mode_t::dnnl_accumulation_mode_any)
    ///     .is_ok());
    ///
    /// assert_eq!(
    ///     attr.get_accumulation_mode(),
    ///     Ok(dnnl_accumulation_mode_t::dnnl_accumulation_mode_any)
    /// );
    /// ```
    pub fn set_accumulation_mode(
        &mut self,
        mode: dnnl_accumulation_mode_t::Type,
    ) -> Result<(), DnnlError> {
        let status = unsafe { dnnl_primitive_attr_set_accumulation_mode(self.handle, mode) };

        if status == dnnl_status_t::dnnl_success {
            Ok(())
        } else {
            Err(status.into())
        }
    }

    /// Get the deterministic attr
    ///
    /// ```
    /// use {
    ///     onednnl::primitive::attributes::PrimitiveAttributes, onednnl_sys::dnnl_accumulation_mode_t,
    /// };
    ///
    /// let attr = PrimitiveAttributes::new();
    ///
    /// assert!(attr.is_ok());
    ///
    /// let attr = attr.unwrap();
    ///
    /// assert_eq!(attr.get_deterministic(), Ok(false));
    /// ```
    pub fn get_deterministic(&self) -> Result<bool, DnnlError> {
        let mut output = 0;

        let status = unsafe { dnnl_primitive_attr_get_deterministic(self.handle, &mut output) };

        if status == dnnl_status_t::dnnl_success {
            Ok(output == 1)
        } else {
            Err(status.into())
        }
    }

    /// Set the deterministic attr
    ///
    /// ```
    /// use {
    ///     onednnl::primitive::attributes::PrimitiveAttributes, onednnl_sys::dnnl_accumulation_mode_t,
    /// };
    ///
    /// let attr = PrimitiveAttributes::new();
    ///
    /// assert!(attr.is_ok());
    ///
    /// let mut attr = attr.unwrap();
    ///
    /// assert_eq!(attr.get_deterministic(), Ok(false));
    ///
    /// assert_eq!(attr.set_deterministic(true), Ok(()));
    ///
    /// assert_eq!(attr.get_deterministic(), Ok(true));
    /// ```
    pub fn set_deterministic(&mut self, deterministic: bool) -> Result<(), DnnlError> {
        let value = if deterministic { 1 } else { 0 };

        let status = unsafe { dnnl_primitive_attr_set_deterministic(self.handle, value) };
        if status == dnnl_status_t::dnnl_success {
            Ok(())
        } else {
            Err(status.into())
        }
    }
}

impl Drop for PrimitiveAttributes {
    fn drop(&mut self) {
        unsafe {
            dnnl_primitive_attr_destroy(self.handle);
        }
    }
}