aboutsummaryrefslogtreecommitdiff
path: root/chapters/reduction.adoc
blob: bef68a3829125eab5fb48ed05b6a1c5099df1fa1 (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
296
297
298
299
300
301
302
303
//
// This confidential and proprietary software may be used only as
// authorised by a licensing agreement from ARM Limited
// (C) COPYRIGHT 2020 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.

=== Reduction Operators

==== REDUCE_ANY

Reduce a tensor along the given axes with a logical OR operation

*Arguments:*

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

|Input|in_t*|input|in_shape|Input tensor from 1 to 4 dims
|Attribute|int|axes|[]|List of axes with size from 1 to rank(input1). Values are integers into the 0-based dimensions of the input tensor. An empty list is not allowed.
|Attribute|int|keep_dims|-|If 1, axes reduced will be retained with length=1.
|Output|out_t*|output|out_shape|Output tensor. Same rank as the input tensor if keep_dims set, else one less than input tensor rank.
|===

*Operation Function:*

[source,c]
----
tmp_shape = in_shape;
for_each (axis in axes[]) {
    tmp_shape[axis]=1;
}
if (keep_dims) assert(tmp_shape == out_shape)
for_each (index in tmp_shape) {
    tensor_write<in_t>(output, tmp_shape, index, false)
}
for_each (index in in_shape) {
    tmp_index = index;
    for each (axis in axes[]) {
        tmp_index[axis]=0;
    }
    value = tensor_read<in_t>(input, in_shape, index)
    acc   = tensor_read<in_t>(output, tmp_shape, tmp_index)
    acc   = acc || value
    tensor_write<in_t>(output, tmp_shape, tmp_index, acc)
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t|out_t

|Any|Boolean|bool|bool
|===

==== REDUCE_ALL

Reduce a tensor along the given axes with a logical AND operation

*Arguments:*

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

|Input|in_t*|input|in_shape|Input tensor from 1 to 4 dims
|Attribute|int|axes|[]|List of axes with size from 1 to rank(input1). Values are integers into the 0-based dimensions of the input tensor. An empty list is not allowed.
|Attribute|int|keep_dims|-|If 1, axes reduced will be retained with length=1.
|Output|out_t*|output|out_shape|Output tensor. Same rank as the input tensor if keep_dims set, else one less than input tensor rank.
|===

*Operation Function:*

[source,c]
----
tmp_shape = in_shape;
for_each (axis in axes[]) {
    tmp_shape[axis]=1;
}
if (keep_dims) assert(tmp_shape == out_shape)
for_each (index in tmp_shape) {
    tensor_write<in_t>(output, tmp_shape, index, true)
}
for_each (index in in_shape) {
    tmp_index = index;
    for each (axis in axes[]) {
        tmp_index[axis]=0;
    }
    value = tensor_read<in_t>(input, in_shape, index)
    acc   = tensor_read<in_t>(output, tmp_shape, tmp_index)
    acc   = acc && value
    tensor_write<in_t>(output, tmp_shape, tmp_index, acc)
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t|out_t

|Any|Boolean|bool|bool
|===

==== REDUCE_MAX

Reduce a tensor along the given axes with a maximum operation

*Arguments:*

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

|Input|in_t*|input|in_shape|Input tensor from 1 to 4 dims
|Attribute|int|axes|[]|List of axes with size from 1 to rank(input1). Values are integers into the 0-based dimensions of the input tensor. An empty list is not allowed.
|Attribute|int|keep_dims|-|If 1, axes reduced will be retained with length=1.
|Output|out_t*|output|out_shape|Output tensor. Same rank as the input tensor if keep_dims set, else one less than input tensor rank.
|===

*Operation Function:*

[source,c]
----
tmp_shape = in_shape;
for_each (axis in axes[]) {
    tmp_shape[axis]=1;
}
if (keep_dims) assert(tmp_shape == out_shape)
for_each (index in tmp_shape) {
    tensor_write<in_t>(output, tmp_shape, index, minimum<in_t>)
}
for_each (index in in_shape) {
    tmp_index = index;
    for each (axis in axes[]) {
        tmp_index[axis]=0;
    }
    value = tensor_read<in_t>(input, in_shape, index)
    acc   = tensor_read<in_t>(output, tmp_shape, tmp_index)
    acc   = apply_max<in_t>(acc, value)
    tensor_write<in_t>(output, tmp_shape, tmp_index, acc)
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t|out_t

|Any|signed 8|aint8|aint8
|Any|signed 16|int16|int16
|Any|signed 32|int32|int32
|MI, MT|float|float|float
|===

==== REDUCE_MIN

Reduce a tensor along the given axes with a minimum operation

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

|Input|in_t*|input|in_shape|Input tensor from 1 to 4 dims
|Attribute|int|axes|[]|List of axes with size from 1 to rank(input1). Values are integers into the 0-based dimensions of the input tensor. An empty list is not allowed.
|Attribute|int|keep_dims|-|If 1, axes reduced will be retained with length=1.
|Output|out_t*|output|out_shape|Output tensor. Same rank as the input tensor if keep_dims set, else one less than input tensor rank.
|===

*Quantization Parameters:*

Quantization is ignored when doing the REDUCE_MIN operation. The input and output must maintain the same parameters.

*Operation Function:*

[source,c]
----
tmp_shape = in_shape;
for_each (axis in axes[]) {
    tmp_shape[axis]=1;
}
if (keep_dims) assert(tmp_shape == out_shape)
for_each (index in tmp_shape) {
    tensor_write<in_t>(output, tmp_shape, index, maximum<in_t>)
}
for_each (index in in_shape) {
    tmp_index = index;
    for each (axis in axes[]) {
        tmp_index[axis]=0;
    }
    value = tensor_read<in_t>(input, in_shape, index)
    acc   = tensor_read<in_t>(output, tmp_shape, tmp_index)
    acc   = apply_min<in_t>(acc, value)
    tensor_write<in_t>(output, tmp_shape, tmp_index, acc)
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t|out_t

|Any|signed 8|aint8|aint8
|Any|signed 16|int16|int16
|Any|signed 32|int32|int32
|MI, MT|float|float|float
|===

==== REDUCE_PRODUCT

Reduce a tensor along the given axes by computing the product of the axes.

*Arguments:*

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

|Input|in_t*|input|in_shape|Input tensor from 1 to 4 dims
|Attribute|int|axes|[]|List of axes with size from 1 to rank(input1). Values are integers into the 0-based dimensions of the input tensor. An empty list is not allowed.
|Attribute|int|keep_dims|-|If 1, axes reduced will be retained with length=1.
|Output|out_t*|output|out_shape|Output tensor. Same rank as the input tensor if keep_dims set, else one less than input tensor rank.
|===

*Operation Function:*

[source,c]
----
tmp_shape = in_shape;
for_each (axis in axes[]) {
    tmp_shape[axis]=1;
}
if (keep_dims) assert(tmp_shape == out_shape)
for_each (index in tmp_shape) {
    tensor_write<in_t>(output, tmp_shape, index, 1.0)
}
for_each (index in in_shape) {
    tmp_index = index;
    for each (axis in axes[]) {
        tmp_index[axis]=0;
    }
    value = tensor_read<in_t>(input, in_shape, index)
    acc   = tensor_read<in_t>(output, tmp_shape, tmp_index)
    acc   = acc * value
    tensor_write<in_t>(output, tmp_shape, tmp_index, acc)
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t|out_t

|MI, MT|float|float|float
|===

==== REDUCE_SUM

Reduce a tensor along the given axes by computing the sum of the axes.

*Arguments:*

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

|Input|in_t*|input|in_shape|Input tensor from 1 to 4 dims
|Attribute|int|axes|[]|List of axes with size from 1 to rank(input1). Values are integers into the 0-based dimensions of the input tensor. An empty list is not allowed.
|Attribute|int|keep_dims|-|If 1, axes reduced will be retained with length=1.
|Output|out_t*|output|out_shape|Output tensor. Same rank as the input tensor if keep_dims set, else one less than input tensor rank.
|===

*Operation Function:*

[source,c]
----
tmp_shape = in_shape;
for_each (axis in axes[]) {
    tmp_shape[axis]=1;
}
if (keep_dims) assert(tmp_shape == out_shape)
for_each (index in tmp_shape) {
    tensor_write<in_t>(output, tmp_shape, index, 0)
}
for_each (index in in_shape) {
    tmp_index = index;
    for each (axis in axes[]) {
        tmp_index[axis]=0;
    }
    value = tensor_read<in_t>(input, in_shape, index)
    acc   = tensor_read<in_t>(output, tmp_shape, tmp_index)
    acc   = apply_add<in_t>(acc, value)
    tensor_write<in_t>(output, tmp_shape, tmp_index, acc)
}
----

*Supported Data Types:*

|===
|Profile|Mode|in_t|out_t

|Any|signed 32|int32|int32
|MI, MT|float|float|float
|===