burn-tensor 0.16.1

Tensor library with user-friendly APIs and automatic differentiation support
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

#[burn_tensor_testgen::testgen(squeeze)]
mod tests {
    use super::*;
    use burn_tensor::{Shape, Tensor, TensorData};

    /// Test if the function can successfully squeeze the size 1 dimension of a 3D tensor.
    #[test]
    fn should_squeeze() {
        let tensor = TestTensor::<3>::ones(Shape::new([2, 1, 4]), &Default::default());
        let squeezed_tensor: Tensor<TestBackend, 2> = tensor.squeeze(1);
        let expected_shape = Shape::new([2, 4]);
        assert_eq!(squeezed_tensor.shape(), expected_shape);
    }
    /// Test if the function can successfully squeeze the first size 1 dimension of a 4D tensor.
    #[test]
    fn should_squeeze_first() {
        let tensor = TestTensor::<4>::ones(Shape::new([1, 3, 4, 5]), &Default::default());
        let squeezed_tensor: Tensor<TestBackend, 3> = tensor.squeeze(0);
        let expected_shape = Shape::new([3, 4, 5]);
        assert_eq!(squeezed_tensor.shape(), expected_shape);
    }
    /// Test if the function can successfully squeeze the last size 1 dimension of a 4D tensor.
    #[test]
    fn should_squeeze_last() {
        let tensor = TestTensor::<4>::ones(Shape::new([2, 3, 4, 1]), &Default::default());
        let squeezed_tensor: Tensor<TestBackend, 3> = tensor.squeeze(3);
        let expected_shape = Shape::new([2, 3, 4]);
        assert_eq!(squeezed_tensor.shape(), expected_shape);
    }
    /// Test if the function panics when the squeezed dimension is not of size 1.
    #[test]
    #[should_panic]
    fn should_squeeze_panic() {
        let tensor = TestTensor::<4>::ones(Shape::new([2, 3, 4, 5]), &Default::default());
        let squeezed_tensor: Tensor<TestBackend, 3> = tensor.squeeze(2);
    }

    /// Test if the function works with an empty slice
    #[test]
    fn should_squeeze_dims_with_empty_slice() {
        let tensor = TestTensor::<3>::ones(Shape::new([1, 1, 3]), &Default::default());
        let squeezed_tensor: Tensor<TestBackend, 1> = tensor.squeeze_dims(&[]);
        let expected_shape = Shape::new([3]);
        assert_eq!(squeezed_tensor.shape(), expected_shape);
    }

    /// Test if the function works with positive indices
    #[test]
    fn should_squeeze_dims_with_positive_indices() {
        let tensor = TestTensor::<4>::ones(Shape::new([1, 3, 1, 5]), &Default::default());
        let squeezed_tensor: Tensor<TestBackend, 2> = tensor.squeeze_dims(&[0, 2]);
        let expected_shape = Shape::new([3, 5]);
        assert_eq!(squeezed_tensor.shape(), expected_shape);
    }

    /// Test if the function works with negative indices
    #[test]
    fn should_squeeze_dims_with_negative_indices() {
        let tensor = TestTensor::<4>::ones(Shape::new([2, 1, 3, 1]), &Default::default());
        let squeezed_tensor: Tensor<TestBackend, 2> = tensor.squeeze_dims(&[-3, -1]);
        let expected_shape = Shape::new([2, 3]);
        assert_eq!(squeezed_tensor.shape(), expected_shape);
    }

    /// Test to make sure the function panics if a non-singleton dimension is squeezed
    #[test]
    #[should_panic]
    fn should_squeeze_dims_work_if_non_singleton() {
        let tensor = TestTensor::<3>::ones(Shape::new([2, 3, 4]), &Default::default());
        let squeezed_tensor: Tensor<TestBackend, 3> = tensor.squeeze_dims(&[1]);
        let expected_shape = Shape::new([2, 3, 4]);
        assert_eq!(squeezed_tensor.shape(), expected_shape);
    }

    /// Test to make sure the function panics if too many dimensions are requested to be squeezed
    #[test]
    #[should_panic]
    fn should_squeeze_dims_panic_on_too_many_dimensions() {
        let tensor = TestTensor::<3>::ones(Shape::new([1, 1, 1]), &Default::default());
        let _: Tensor<TestBackend, 1> = tensor.squeeze_dims(&[0, 1, 2]);
    }

    /// Test to make sure function panics if dimensions are mismatched
    #[test]
    #[should_panic]
    fn should_squeeze_dims_dimension_mismatch_panic() {
        let tensor = TestTensor::<4>::ones(Shape::new([1, 3, 1, 5]), &Default::default());
        let _: Tensor<TestBackend, 3> = tensor.squeeze_dims(&[0, 2]);
    }

    /// Test if the function can successfully unsqueeze the size 1 dimension at the specified position of a 3D tensor.
    #[test]
    fn should_unsqueeze_dim() {
        let tensor = TestTensor::<3>::ones(Shape::new([2, 4, 1]), &Default::default());
        let unsqueezed_tensor: Tensor<TestBackend, 4> = tensor.unsqueeze_dim(1);
        let expected_shape = Shape::new([2, 1, 4, 1]);
        assert_eq!(unsqueezed_tensor.shape(), expected_shape);
    }

    /// Test if the function can successfully unsqueeze the first size 1 dimension of a 4D tensor.
    #[test]
    fn should_unsqueeze_dim_first() {
        let tensor = TestTensor::<4>::ones(Shape::new([2, 3, 4, 5]), &Default::default());
        let unsqueezed_tensor: Tensor<TestBackend, 5> = tensor.unsqueeze_dim(0);
        let expected_shape = Shape::new([1, 2, 3, 4, 5]);
        assert_eq!(unsqueezed_tensor.shape(), expected_shape);
    }

    /// Test if the function can successfully unsqueeze the last size 1 dimension of a 4D tensor.
    #[test]
    fn should_unsqueeze_dim_last() {
        let tensor = TestTensor::<4>::ones(Shape::new([5, 4, 3, 2]), &Default::default());
        let unsqueezed_tensor: Tensor<TestBackend, 5> = tensor.unsqueeze_dim(4);
        let expected_shape = Shape::new([5, 4, 3, 2, 1]);
        assert_eq!(unsqueezed_tensor.shape(), expected_shape);
    }

    /// Test if the function panics when the unsqueezed dimension is out of bounds.
    #[test]
    #[should_panic]
    fn should_unsqueeze_dim_panic() {
        let tensor = TestTensor::<4>::ones(Shape::new([2, 3, 4, 5]), &Default::default());
        let unsqueezed_tensor: Tensor<TestBackend, 5> = tensor.unsqueeze_dim(5);
    }

    #[test]
    fn should_unsqueeze_dims_support_dim_inference() {
        let input_tensor = TestTensor::<3>::ones(Shape::new([3, 4, 5]), &Default::default());
        let output_tensor = input_tensor.unsqueeze_dims::<5>(&[1, -2]);
        let expected_shape = Shape::new([3, 1, 4, 1, 5]);
        assert_eq!(output_tensor.shape(), expected_shape);
    }

    #[test]
    fn should_unsqueeze_dims_handle_first_last() {
        let input_tensor = TestTensor::<3>::ones(Shape::new([3, 4, 5]), &Default::default());
        let output_tensor = input_tensor.unsqueeze_dims::<5>(&[0, 4]);
        let expected_shape = Shape::new([1, 3, 4, 5, 1]);
        assert_eq!(output_tensor.shape(), expected_shape);
    }

    #[test]
    fn should_unsqueeze_dims_work_with_single_dim() {
        //bruh, just call unsqueeze_dim
        let input_tensor = TestTensor::<3>::ones(Shape::new([3, 4, 5]), &Default::default());
        let output_tensor: Tensor<TestBackend, 4> = input_tensor.unsqueeze_dims(&[1]);
        let expected_shape = Shape::new([3, 1, 4, 5]);
        assert_eq!(output_tensor.shape(), expected_shape);
    }

    #[test]
    fn should_unsqueeze_dims_multiple_trailing_negatives() {
        let input_tensor = TestTensor::<3>::ones(Shape::new([3, 4, 5]), &Default::default());
        let output_tensor: Tensor<TestBackend, 6> = input_tensor.unsqueeze_dims(&[0, -1, -1]);
        let expected_shape = Shape::new([1, 3, 4, 5, 1, 1]);
        assert_eq!(output_tensor.shape(), expected_shape);
    }

    #[test]
    #[should_panic]
    fn should_unsqueeze_dims_panic() {
        let input_tensor = TestTensor::<3>::ones(Shape::new([3, 4, 5]), &Default::default());
        let output_tensor: Tensor<TestBackend, 5> = input_tensor.unsqueeze_dims(&[0, -6]);
    }
}