safemlx 0.2.2

Low-level MLX execution layer used by the Eredu model runtime
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

//! Macros for creating arrays.

/// A helper macro to create an array with up to 3 dimensions.
///
/// # Examples
///
/// ```rust
/// # let stream = safemlx::Stream::new_with_device(&safemlx::Device::new(safemlx::DeviceType::Cpu, 0));
/// use safemlx::array;
///
/// // Create an empty array
/// // Note that an empty array defaults to f32 and one dimension
/// let empty = array!();
///
/// // Create a scalar array
/// let s = array!(1);
/// // Scalar array has 0 dimension
/// assert_eq!(s.ndim(), 0);
///
/// // Create a one-element array (singleton matrix)
/// let s = array!([1]);
/// // Singleton array has 1 dimension
/// assert!(s.ndim() == 1);
///
/// // Create a 1D array
/// let a1 = array!([1, 2, 3]);
///
/// // Create a 2D array
/// let a2 = array!([
///     [1, 2, 3],
///     [4, 5, 6]
/// ]);
///
/// // Create a 3D array
/// let a3 = array!([
///     [
///         [1, 2, 3],
///         [4, 5, 6]
///     ],
///     [
///         [7, 8, 9],
///         [10, 11, 12]
///     ]
/// ]);
///
/// // Create a 2x2 array by specifying the shape
/// let a = array!([1, 2, 3, 4], shape=[2, 2]);
/// ```
#[macro_export]
macro_rules! array {
    ([$($x:expr),*], shape=[$($s:expr),*]) => {
        {
            let data = [$($x,)*];
            let shape = [$($s,)*];
            $crate::Array::from_slice(&data, &shape)
        }
    };
    ([$([$([$($x:expr),*]),*]),*]) => {
        {
            let arr = [$([$([$($x,)*],)*],)*];
            <$crate::Array as $crate::FromNested<_>>::from_nested(arr)
        }
    };
    ([$([$($x:expr),*]),*]) => {
        {
            let arr = [$([$($x,)*],)*];
            <$crate::Array as $crate::FromNested<_>>::from_nested(arr)
        }
    };
    ([$($x:expr),*]) => {
        {
            let arr = [$($x,)*];
            <$crate::Array as $crate::FromNested<_>>::from_nested(arr)
        }
    };
    ($x:expr) => {
        {
            <$crate::Array as $crate::FromScalar<_>>::from_scalar($x)
        }
    };
    // Empty array default to f32
    () => {
        $crate::Array::from_slice::<f32>(&[], &[0])
    };
}

#[cfg(test)]
mod tests {
    use crate::ops::indexing::IndexOp;

    #[test]
    fn test_scalar_array() {
        let stream = crate::test_stream();
        let arr = array!(1);

        // Scalar array has 0 dimension
        assert_eq!(arr.ndim(), 0);
        // Scalar array has empty shape
        assert!(arr.shape().is_empty());
        assert_eq!(arr.item::<i32>(&stream), 1);
    }

    #[test]
    fn test_array_1d() {
        let stream = crate::test_stream();
        let arr = array!([1, 2, 3]);

        // One element array has 1 dimension
        assert_eq!(arr.ndim(), 1);
        assert_eq!(arr.shape(), &[3]);
        assert_eq!(arr.index_device(0, stream).item::<i32>(&stream), 1);
        assert_eq!(arr.index_device(1, stream).item::<i32>(&stream), 2);
        assert_eq!(arr.index_device(2, stream).item::<i32>(&stream), 3);
    }

    #[test]
    fn test_array_2d() {
        let stream = crate::test_stream();
        let a = array!([[1, 2, 3], [4, 5, 6]]);

        assert_eq!(a.ndim(), 2);
        assert_eq!(a.shape(), &[2, 3]);
        assert_eq!(a.index_device((0, 0), stream).item::<i32>(&stream), 1);
        assert_eq!(a.index_device((0, 1), stream).item::<i32>(&stream), 2);
        assert_eq!(a.index_device((0, 2), stream).item::<i32>(&stream), 3);
        assert_eq!(a.index_device((1, 0), stream).item::<i32>(&stream), 4);
        assert_eq!(a.index_device((1, 1), stream).item::<i32>(&stream), 5);
        assert_eq!(a.index_device((1, 2), stream).item::<i32>(&stream), 6);
    }

    #[test]
    fn test_array_3d() {
        let stream = crate::test_stream();
        let a = array!([[[1, 2, 3], [4, 5, 6]], [[7, 8, 9], [10, 11, 12]]]);

        assert!(a.ndim() == 3);
        assert_eq!(a.shape(), &[2, 2, 3]);
        assert_eq!(a.index_device((0, 0, 0), stream).item::<i32>(&stream), 1);
        assert_eq!(a.index_device((0, 0, 1), stream).item::<i32>(&stream), 2);
        assert_eq!(a.index_device((0, 0, 2), stream).item::<i32>(&stream), 3);
        assert_eq!(a.index_device((0, 1, 0), stream).item::<i32>(&stream), 4);
        assert_eq!(a.index_device((0, 1, 1), stream).item::<i32>(&stream), 5);
        assert_eq!(a.index_device((0, 1, 2), stream).item::<i32>(&stream), 6);
        assert_eq!(a.index_device((1, 0, 0), stream).item::<i32>(&stream), 7);
        assert_eq!(a.index_device((1, 0, 1), stream).item::<i32>(&stream), 8);
        assert_eq!(a.index_device((1, 0, 2), stream).item::<i32>(&stream), 9);
        assert_eq!(a.index_device((1, 1, 0), stream).item::<i32>(&stream), 10);
        assert_eq!(a.index_device((1, 1, 1), stream).item::<i32>(&stream), 11);
        assert_eq!(a.index_device((1, 1, 2), stream).item::<i32>(&stream), 12);
    }

    #[test]
    fn test_array_with_shape() {
        let stream = crate::test_stream();
        let a = array!([1, 2, 3, 4], shape = [2, 2]);

        assert_eq!(a.ndim(), 2);
        assert_eq!(a.shape(), &[2, 2]);
        assert_eq!(a.index_device((0, 0), stream).item::<i32>(&stream), 1);
        assert_eq!(a.index_device((0, 1), stream).item::<i32>(&stream), 2);
        assert_eq!(a.index_device((1, 0), stream).item::<i32>(&stream), 3);
        assert_eq!(a.index_device((1, 1), stream).item::<i32>(&stream), 4);
    }
}