xnn 0.2.0

A lightweight ML framework with GPU-first architecture
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

//! Typed GPU buffer for element data.

use core::marker::PhantomData;

use alloc::format;

use crate::Element;

/// Typed GPU buffer for element storage.
#[derive(Clone)]
pub struct Buffer<T: Element> {
    inner: wgpu::Buffer,
    len: usize,
    _marker: PhantomData<T>,
}

impl<T: Element> Buffer<T> {
    /// Creates a new buffer wrapper.
    pub(crate) fn new(buffer: wgpu::Buffer, len: usize) -> Self {
        Self {
            inner: buffer,
            len,
            _marker: PhantomData,
        }
    }

    /// Returns the buffer size in bytes.
    pub(crate) fn byte_size(&self) -> u64 {
        self.inner.size()
    }

    /// Returns the number of elements.
    pub(crate) fn len(&self) -> usize {
        self.len
    }

    /// Returns `true` if empty.
    pub(crate) fn is_empty(&self) -> bool {
        self.len == 0
    }

    /// Returns the underlying wgpu buffer.
    pub(crate) fn inner(&self) -> &wgpu::Buffer {
        &self.inner
    }
}

impl<T: Element> core::fmt::Debug for Buffer<T> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_struct(&format!("Buffer<{}>", T::wgsl_type()))
            .field("byte_size", &self.inner.size())
            .field("len", &self.len)
            .finish_non_exhaustive()
    }
}

#[cfg(test)]
mod tests {
    use crate::Context;

    use super::*;

    #[test]
    fn test_new() {
        let ctx = Context::try_default().unwrap();
        let wgpu_buf = ctx.device().create_buffer(&wgpu::BufferDescriptor {
            label: None,
            size: 256,
            usage: wgpu::BufferUsages::STORAGE,
            mapped_at_creation: false,
        });
        let buf: Buffer<f32> = Buffer::new(wgpu_buf, 64);
        assert_eq!(buf.byte_size(), 256);
        assert_eq!(buf.len(), 64);
    }

    #[test]
    fn test_byte_size() {
        let ctx = Context::try_default().unwrap();
        let buf = ctx.create_buffer::<f32>(4).unwrap();
        assert_eq!(buf.byte_size(), 16);
        assert_eq!(buf.len(), 4);
    }

    #[test]
    fn test_len() {
        let ctx = Context::try_default().unwrap();
        let buf = ctx.create_buffer::<f32>(4).unwrap();
        assert_eq!(buf.byte_size(), 16);
        assert_eq!(buf.len(), 4);
    }

    #[test]
    fn test_is_empty() {
        let ctx = Context::try_default().unwrap();

        let buf = ctx.create_buffer::<f32>(0).unwrap();
        assert_eq!(buf.byte_size(), 0);
        assert!(buf.is_empty());

        let buf = ctx.create_buffer::<f32>(4).unwrap();
        assert!(!buf.is_empty());
    }

    #[test]
    fn test_debug() {
        let ctx = Context::try_default().unwrap();
        let buf = ctx.create_buffer::<f32>(4).unwrap();
        let debug = format!("{buf:?}");
        assert!(debug.contains("Buffer<f32>"));
        assert!(debug.contains("byte_size"));
        assert!(debug.contains("len"));
    }
}