aboutsummaryrefslogtreecommitdiff
path: root/chapters/data_layout.adoc
blob: 5d54e622446fa17da4ca57cddfcdbe440de89008 (plain)
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
//
// This confidential and proprietary software may be used only as
// authorised by a licensing agreement from ARM Limited
// (C) COPYRIGHT 2020-2021 ARM Limited
// ALL RIGHTS RESERVED
// The entire notice above must be reproduced on all authorised
// copies and copies may only be made to the extent permitted
// by a licensing agreement from ARM Limited.

=== Data Layout

==== CONCAT
Concatenate two tensors along a given axis. No data conversion happens during a concat operation.

*Arguments:*

|===
|Argument|Type|Name|Shape|Description

|Input|in_t*|input1|shape1|Input tensor with rank from 1 to 4
|Input|in_t*|input2|shape2|Input tensor with rank matching input1
|Attribute|int|axis|-|Axis along which concatenation is to occur.
|Output|in_t*|output|shape|Output tensor of same type, size as the input tensor
|===

*Operation Function:*

[source,c]
----
for_each (index1 in shape) {
    index2 = index1
    index2[axis] = index1[axis] - shape1[axis]
    in_t value = (index2[axis] < 0) ?
        tensor_read<in_t>(input1, shape1, index1) :
        tensor_read<in_t>(input2, shape2, index2) ;
    tensor_write<in_t>(output, shape, index1, value);
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t

|Any|Boolean|bool
|Any|signed 8|int8
|Any|signed 16|int16
|Any|signed 32|int32
|MI, MT|float|float
|===

==== PAD

Zero-pads a tensor along borders of each dimension.

*Arguments:*

|===
|Argument|Type|Name|Shape|Description

|Input|in_t*|input1|shape1|Input tensor
|Attribute|int|padding|[rank(input1),2]|Amount of padding to be done
|Output|in_t*|output|shape|Output tensor of same type as the input tensor
|===

*Quantization Parameters:*

|===
|Argument|Type|Name|Shape|Description

|Attribute|in_t|input1_zp|-|Input tensor zero point
|===

*Operation Function:*

[source,c]
----
for_each (index in shape) {
    index1 = index
    for (i=0; i<rank(shape); i++) {
        index1[i] = index1[i] - padding[i,0]
    }
    in_t value = tensor_read<in_t>(input1, shape1, index1, input1_zp, padding)
    tensor_write<in_t>(output, shape, index, value + input1_zp);
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t

|Any|Boolean|bool
|Any|signed 8|int8
|Any|signed 16|int16
|Any|signed 32|int32
|MI, MT|float|float
|===

==== RESHAPE

Returns a tensor with the same type/values as the input, with a new shape specified by the shape argument. Reshape may operate on tensors of any rank. No data conversion happens during a reshape operation.

*Arguments:*

|===
|Argument|Type|Name|Shape|Description

|Input|in_t*|input1|shape1|Input tensor
|Attribute|int|new_shape|[rank(output)]|List of values, with each element giving the size of the result tensor for the given dimension. At most one dimension may be given as-1 to automatically calculate the dimension size.
|Output|in_t*|output|shape|Output tensor of same type, size as the input tensor
|===

*Operation Function:*

[source,c]
----
assert(tensor_size(shape1)==tensor_size(shape))
for (i=0; i<tensor_size(shape); i++) {
    output[i] = input[i]
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t

|Any|Boolean|bool
|Any|signed 8|int8
|Any|signed 16|int16
|Any|signed 32|int32
|MI, MT|float|float
|===

==== REVERSE

Returns a tensor with the same type/values as the input, with the data reversed along the given axis. No data conversion happens during a reverse operation.

*Arguments:*

|===
|Argument|Type|Name|Shape|Description

|Input|in_t*|input|shape|Input tensor from 1 to 4 dims
|Attribute|int|axis|-|Axis to reverse
|Output|in_t*|output|shape|Output tensor. Same shape as input tensor.
|===

*Operation Function:*

[source,c]
----
assert(0<=axis && axis<rank(shape))
for_each (index in shape) {
    tmp_index = index;
    tmp_index[axis] = shape[axis]-1-index[axis];
    in_t value = tensor_read<in_t>(input, shape, tmp_index);
    tensor_write<in_t>(output, shape, index, value);
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t

|Any|Boolean|bool
|Any|signed 8|int8
|Any|signed 16|int16
|Any|signed 32|int32
|MI, MT|float|float
|===

==== SLICE

Extracts a slice of the input1 on the given axis, beginning at the start coordinates, and extending for size elements in each direction. No data conversion happens during a slice operation.

*Arguments:*
|===
|Argument|Type|Name|Shape|Description

|Input|in_t*|input1|shape1|Input tensor with rank from 1 to 4
|Attribute|int|start|[rank(input1)]|List of integer coordinates, of length equal to the rank of input1. Start coordinate for slicing.
|Attribute|int|size|[rank(input1)]|List of integer size values, of length equal to the rank of input1. Size of the input to be used.
|Output|in_t*|output|shape|Output tensor of same type as the input tensor
|===

*Operation Function:*

[source,c]
----
for_each (index in shape) {
    tmp_index = index;
    for (i=0; i<rank(shape); i++) {
       tmp_index[i] = index[i] + start[i];
    }
    in_t value = tensor_read<in_t>(input, shape1, tmp_index);
    tensor_write<in_t>(output, shape, index, value);
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t

|Any|Boolean|bool
|Any|signed 8|int8
|Any|signed 16|int16
|Any|signed 32|int32
|MI, MT|float|float
|===

==== TILE

Replicates input1 multiplies times along each dimension.

*Arguments:*

|===
|Argument|Type|Name|Shape|Description

|Input|in_t*|input1|shape1|Input tensor with rank from 1 to 4
|Attribute|int|multiplies|[rank(shape1)]|Number of times to replicate input1 in each dimension
|Output|in_t*|output|shape|Output tensor of same type, rank as the input tensor
|===

*Operation Function:*

[source,c]
----
for_each (index in shape) {
    tmp_index = index;
    for (i=0; i<rank(shape); i++) {
        assert(shape1[i] * multiplies[i] == shape[i])
        tmp_index[i] = index[i] % shape1[i]
    }
    in_t value = tensor_read<in_t>(input, shape1, tmp_index);
    tensor_write<in_t>(output, shape, index, value);
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t

|Any|Boolean|bool
|Any|signed 8|int8
|Any|signed 16|int16
|Any|signed 32|int32
|MI, MT|float|float
|===

==== TRANSPOSE

Permutes the dimensions based on perm.

*Arguments:*

|===
|Argument|Type|Name|Shape|Description

|Input|in_t*|input1|shape1|Input tensor with rank from 1 to 4
|Attribute|int|perms|[rank(input1)]|List of integers of length equal to the rank of input1.
|Output|in_t*|output|shape|Output tensor of same type, rank as the input tensor
|===

*Operation Function:*

[source,c]
----
for_each (index in shape) {
    tmp_index = index;
    for (i=0; i<rank(shape); i++) {
        assert(shape1[perm[i]] == shape[i])
        tmp_index[perm[i]] = index[i]
    }
    in_t value = tensor_read<in_t>(input, shape1, tmp_index);
    tensor_write<in_t>(output, shape, index, value);
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t

|Any|Boolean|bool
|Any|signed 8|int8
|Any|signed 16|int16
|Any|signed 32|int32
|MI, MT|float|float
|===