blob: 92ab1a30b9bddfe32c464a4b3adf047a477d8785 [file] [log] [blame]
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001/*
Giorgio Arenaa66eaa22017-12-21 19:50:06 +00002 * Copyright (c) 2016-2018 ARM Limited.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01003 *
4 * SPDX-License-Identifier: MIT
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to
8 * deal in the Software without restriction, including without limitation the
9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10 * sell copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24#ifndef __UTILS_UTILS_H__
25#define __UTILS_UTILS_H__
26
27#include "arm_compute/core/Helpers.h"
28#include "arm_compute/core/ITensor.h"
29#include "arm_compute/core/Types.h"
30#include "arm_compute/core/Validate.h"
steniu01bee466b2017-06-21 16:45:41 +010031#include "arm_compute/core/Window.h"
Anthony Barbier6ff3b192017-09-04 18:44:23 +010032#include "arm_compute/runtime/Tensor.h"
Giorgio Arenacf3935f2017-10-26 17:14:13 +010033#include "libnpy/npy.hpp"
Anthony Barbier2a07e182017-08-04 18:20:27 +010034#include "support/ToolchainSupport.h"
Anthony Barbier6ff3b192017-09-04 18:44:23 +010035
36#ifdef ARM_COMPUTE_CL
37#include "arm_compute/core/CL/OpenCL.h"
Isabella Gottardi02aabcc2017-10-12 17:28:51 +010038#include "arm_compute/runtime/CL/CLDistribution1D.h"
Anthony Barbier6ff3b192017-09-04 18:44:23 +010039#include "arm_compute/runtime/CL/CLTensor.h"
40#endif /* ARM_COMPUTE_CL */
Anthony Barbier7068f992017-10-26 15:23:08 +010041#ifdef ARM_COMPUTE_GC
42#include "arm_compute/runtime/GLES_COMPUTE/GCTensor.h"
43#endif /* ARM_COMPUTE_GC */
Anthony Barbier6ff3b192017-09-04 18:44:23 +010044
45#include <cstdlib>
46#include <cstring>
47#include <fstream>
48#include <iostream>
Giorgio Arenacf3935f2017-10-26 17:14:13 +010049#include <random>
50#include <string>
51#include <tuple>
52#include <vector>
Anthony Barbier6ff3b192017-09-04 18:44:23 +010053
54namespace arm_compute
55{
56namespace utils
57{
Georgios Pinitas12be7ab2018-07-03 12:06:23 +010058/** Supported image types */
59enum class ImageType
60{
61 UNKNOWN,
62 PPM,
63 JPEG
64};
65
Anthony Barbier6db0ff52018-01-05 10:59:12 +000066/** Abstract Example class.
67 *
68 * All examples have to inherit from this class.
69 */
70class Example
71{
72public:
Alex Gildayc357c472018-03-21 13:54:09 +000073 /** Setup the example.
74 *
75 * @param[in] argc Argument count.
76 * @param[in] argv Argument values.
Georgios Pinitas12be7ab2018-07-03 12:06:23 +010077 *
78 * @return True in case of no errors in setup else false
Alex Gildayc357c472018-03-21 13:54:09 +000079 */
Georgios Pinitas12be7ab2018-07-03 12:06:23 +010080 virtual bool do_setup(int argc, char **argv)
81 {
82 return true;
83 };
Alex Gildayc357c472018-03-21 13:54:09 +000084 /** Run the example. */
Anthony Barbier6db0ff52018-01-05 10:59:12 +000085 virtual void do_run() {};
Alex Gildayc357c472018-03-21 13:54:09 +000086 /** Teardown the example. */
Anthony Barbier6db0ff52018-01-05 10:59:12 +000087 virtual void do_teardown() {};
88
89 /** Default destructor. */
90 virtual ~Example() = default;
91};
92
93/** Run an example and handle the potential exceptions it throws
94 *
95 * @param[in] argc Number of command line arguments
96 * @param[in] argv Command line arguments
97 * @param[in] example Example to run
98 */
Anthony Barbier9fb0cac2018-04-20 15:46:21 +010099int run_example(int argc, char **argv, std::unique_ptr<Example> example);
Anthony Barbier6db0ff52018-01-05 10:59:12 +0000100
101template <typename T>
102int run_example(int argc, char **argv)
103{
Anthony Barbier9fb0cac2018-04-20 15:46:21 +0100104 return run_example(argc, argv, support::cpp14::make_unique<T>());
Anthony Barbier6db0ff52018-01-05 10:59:12 +0000105}
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100106
107/** Draw a RGB rectangular window for the detected object
108 *
109 * @param[in, out] tensor Input tensor where the rectangle will be drawn on. Format supported: RGB888
110 * @param[in] rect Geometry of the rectangular window
111 * @param[in] r Red colour to use
112 * @param[in] g Green colour to use
113 * @param[in] b Blue colour to use
114 */
115void draw_detection_rectangle(arm_compute::ITensor *tensor, const arm_compute::DetectionWindow &rect, uint8_t r, uint8_t g, uint8_t b);
116
Georgios Pinitas12be7ab2018-07-03 12:06:23 +0100117/** Gets image type given a file
118 *
119 * @param[in] filename File to identify its image type
120 *
121 * @return Image type
122 */
123ImageType get_image_type_from_file(const std::string &filename);
124
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100125/** Parse the ppm header from an input file stream. At the end of the execution,
126 * the file position pointer will be located at the first pixel stored in the ppm file
127 *
128 * @param[in] fs Input file stream to parse
129 *
130 * @return The width, height and max value stored in the header of the PPM file
131 */
132std::tuple<unsigned int, unsigned int, int> parse_ppm_header(std::ifstream &fs);
133
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100134/** Parse the npy header from an input file stream. At the end of the execution,
135 * the file position pointer will be located at the first pixel stored in the npy file //TODO
136 *
137 * @param[in] fs Input file stream to parse
138 *
139 * @return The width and height stored in the header of the NPY file
140 */
141std::tuple<std::vector<unsigned long>, bool, std::string> parse_npy_header(std::ifstream &fs);
142
143/** Obtain numpy type string from DataType.
144 *
145 * @param[in] data_type Data type.
146 *
147 * @return numpy type string.
148 */
149inline std::string get_typestring(DataType data_type)
150{
151 // Check endianness
152 const unsigned int i = 1;
153 const char *c = reinterpret_cast<const char *>(&i);
154 std::string endianness;
155 if(*c == 1)
156 {
157 endianness = std::string("<");
158 }
159 else
160 {
161 endianness = std::string(">");
162 }
163 const std::string no_endianness("|");
164
165 switch(data_type)
166 {
167 case DataType::U8:
Giorgio Arenaa66eaa22017-12-21 19:50:06 +0000168 case DataType::QASYMM8:
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100169 return no_endianness + "u" + support::cpp11::to_string(sizeof(uint8_t));
170 case DataType::S8:
171 return no_endianness + "i" + support::cpp11::to_string(sizeof(int8_t));
172 case DataType::U16:
173 return endianness + "u" + support::cpp11::to_string(sizeof(uint16_t));
174 case DataType::S16:
175 return endianness + "i" + support::cpp11::to_string(sizeof(int16_t));
176 case DataType::U32:
177 return endianness + "u" + support::cpp11::to_string(sizeof(uint32_t));
178 case DataType::S32:
179 return endianness + "i" + support::cpp11::to_string(sizeof(int32_t));
180 case DataType::U64:
181 return endianness + "u" + support::cpp11::to_string(sizeof(uint64_t));
182 case DataType::S64:
183 return endianness + "i" + support::cpp11::to_string(sizeof(int64_t));
Vidhya Sudhan Loganathana25d16c2018-11-16 11:33:12 +0000184 case DataType::F16:
185 return endianness + "f" + support::cpp11::to_string(sizeof(half));
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100186 case DataType::F32:
187 return endianness + "f" + support::cpp11::to_string(sizeof(float));
188 case DataType::F64:
189 return endianness + "f" + support::cpp11::to_string(sizeof(double));
190 case DataType::SIZET:
191 return endianness + "u" + support::cpp11::to_string(sizeof(size_t));
192 default:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +0100193 ARM_COMPUTE_ERROR("Data type not supported");
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100194 }
195}
196
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100197/** Maps a tensor if needed
198 *
199 * @param[in] tensor Tensor to be mapped
200 * @param[in] blocking Specified if map is blocking or not
201 */
202template <typename T>
Gian Marco Iodiceae27e942017-09-28 18:31:26 +0100203inline void map(T &tensor, bool blocking)
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100204{
205 ARM_COMPUTE_UNUSED(tensor);
206 ARM_COMPUTE_UNUSED(blocking);
207}
208
209/** Unmaps a tensor if needed
210 *
211 * @param tensor Tensor to be unmapped
212 */
213template <typename T>
Gian Marco Iodiceae27e942017-09-28 18:31:26 +0100214inline void unmap(T &tensor)
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100215{
216 ARM_COMPUTE_UNUSED(tensor);
217}
218
219#ifdef ARM_COMPUTE_CL
220/** Maps a tensor if needed
221 *
222 * @param[in] tensor Tensor to be mapped
223 * @param[in] blocking Specified if map is blocking or not
224 */
Gian Marco Iodiceae27e942017-09-28 18:31:26 +0100225inline void map(CLTensor &tensor, bool blocking)
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100226{
227 tensor.map(blocking);
228}
229
230/** Unmaps a tensor if needed
231 *
232 * @param tensor Tensor to be unmapped
233 */
Gian Marco Iodiceae27e942017-09-28 18:31:26 +0100234inline void unmap(CLTensor &tensor)
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100235{
236 tensor.unmap();
237}
Isabella Gottardi02aabcc2017-10-12 17:28:51 +0100238
239/** Maps a distribution if needed
240 *
241 * @param[in] distribution Distribution to be mapped
242 * @param[in] blocking Specified if map is blocking or not
243 */
244inline void map(CLDistribution1D &distribution, bool blocking)
245{
246 distribution.map(blocking);
247}
248
249/** Unmaps a distribution if needed
250 *
251 * @param distribution Distribution to be unmapped
252 */
253inline void unmap(CLDistribution1D &distribution)
254{
255 distribution.unmap();
256}
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100257#endif /* ARM_COMPUTE_CL */
258
Anthony Barbier7068f992017-10-26 15:23:08 +0100259#ifdef ARM_COMPUTE_GC
260/** Maps a tensor if needed
261 *
262 * @param[in] tensor Tensor to be mapped
263 * @param[in] blocking Specified if map is blocking or not
264 */
265inline void map(GCTensor &tensor, bool blocking)
266{
267 tensor.map(blocking);
268}
269
270/** Unmaps a tensor if needed
271 *
272 * @param tensor Tensor to be unmapped
273 */
274inline void unmap(GCTensor &tensor)
275{
276 tensor.unmap();
277}
278#endif /* ARM_COMPUTE_GC */
279
Vidhya Sudhan Loganathana25d16c2018-11-16 11:33:12 +0000280/** Specialized class to generate random non-zero FP16 values.
281 * uniform_real_distribution<half> generates values that get rounded off to zero, causing
282 * differences between ACL and reference implementation
283*/
284class uniform_real_distribution_fp16
285{
286 half min{ 0.0f }, max{ 0.0f };
287 std::uniform_real_distribution<float> neg{ min, -0.3f };
288 std::uniform_real_distribution<float> pos{ 0.3f, max };
289 std::uniform_int_distribution<uint8_t> sign_picker{ 0, 1 };
290
291public:
292 using result_type = half;
293 /** Constructor
294 *
295 * @param[in] a Minimum value of the distribution
296 * @param[in] b Maximum value of the distribution
297 */
298 explicit uniform_real_distribution_fp16(half a = half(0.0), half b = half(1.0))
299 : min(a), max(b)
300 {
301 }
302
303 /** () operator to generate next value
304 *
305 * @param[in] gen an uniform random bit generator object
306 */
307 half operator()(std::mt19937 &gen)
308 {
309 if(sign_picker(gen))
310 {
311 return (half)neg(gen);
312 }
313 return (half)pos(gen);
314 }
315};
316
Alex Gildayc357c472018-03-21 13:54:09 +0000317/** Numpy data loader */
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100318class NPYLoader
319{
320public:
Alex Gildayc357c472018-03-21 13:54:09 +0000321 /** Default constructor */
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100322 NPYLoader()
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100323 : _fs(), _shape(), _fortran_order(false), _typestring(), _file_layout(DataLayout::NCHW)
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100324 {
325 }
326
327 /** Open a NPY file and reads its metadata
328 *
329 * @param[in] npy_filename File to open
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100330 * @param[in] file_layout (Optional) Layout in which the weights are stored in the file.
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100331 */
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100332 void open(const std::string &npy_filename, DataLayout file_layout = DataLayout::NCHW)
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100333 {
334 ARM_COMPUTE_ERROR_ON(is_open());
335 try
336 {
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100337 _fs.open(npy_filename, std::ios::in | std::ios::binary);
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100338 ARM_COMPUTE_EXIT_ON_MSG(!_fs.good(), "Failed to load binary data from %s", npy_filename.c_str());
339 _fs.exceptions(std::ifstream::failbit | std::ifstream::badbit);
340 _file_layout = file_layout;
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100341
342 std::tie(_shape, _fortran_order, _typestring) = parse_npy_header(_fs);
343 }
344 catch(const std::ifstream::failure &e)
345 {
346 ARM_COMPUTE_ERROR("Accessing %s: %s", npy_filename.c_str(), e.what());
347 }
348 }
349 /** Return true if a NPY file is currently open */
350 bool is_open()
351 {
352 return _fs.is_open();
353 }
354
355 /** Return true if a NPY file is in fortran order */
356 bool is_fortran()
357 {
358 return _fortran_order;
359 }
360
Gian Marco0bc5a252017-12-04 13:55:08 +0000361 /** Initialise the tensor's metadata with the dimensions of the NPY file currently open
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100362 *
363 * @param[out] tensor Tensor to initialise
Gian Marco0bc5a252017-12-04 13:55:08 +0000364 * @param[in] dt Data type to use for the tensor
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100365 */
366 template <typename T>
Gian Marco0bc5a252017-12-04 13:55:08 +0000367 void init_tensor(T &tensor, arm_compute::DataType dt)
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100368 {
369 ARM_COMPUTE_ERROR_ON(!is_open());
Gian Marco0bc5a252017-12-04 13:55:08 +0000370 ARM_COMPUTE_ERROR_ON(dt != arm_compute::DataType::F32);
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100371
372 // Use the size of the input NPY tensor
373 TensorShape shape;
374 shape.set_num_dimensions(_shape.size());
375 for(size_t i = 0; i < _shape.size(); ++i)
376 {
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100377 size_t src = i;
378 if(_fortran_order)
379 {
380 src = _shape.size() - 1 - i;
381 }
382 shape.set(i, _shape.at(src));
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100383 }
384
Gian Marco0bc5a252017-12-04 13:55:08 +0000385 arm_compute::TensorInfo tensor_info(shape, 1, dt);
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100386 tensor.allocator()->init(tensor_info);
387 }
388
389 /** Fill a tensor with the content of the currently open NPY file.
390 *
391 * @note If the tensor is a CLTensor, the function maps and unmaps the tensor
392 *
393 * @param[in,out] tensor Tensor to fill (Must be allocated, and of matching dimensions with the opened NPY).
394 */
395 template <typename T>
396 void fill_tensor(T &tensor)
397 {
398 ARM_COMPUTE_ERROR_ON(!is_open());
Georgios Pinitasa799ce02018-09-12 20:11:34 +0100399 ARM_COMPUTE_ERROR_ON_DATA_TYPE_NOT_IN(&tensor, arm_compute::DataType::QASYMM8, arm_compute::DataType::S32, arm_compute::DataType::F32);
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100400 try
401 {
402 // Map buffer if creating a CLTensor
403 map(tensor, true);
404
405 // Check if the file is large enough to fill the tensor
406 const size_t current_position = _fs.tellg();
407 _fs.seekg(0, std::ios_base::end);
408 const size_t end_position = _fs.tellg();
409 _fs.seekg(current_position, std::ios_base::beg);
410
411 ARM_COMPUTE_ERROR_ON_MSG((end_position - current_position) < tensor.info()->tensor_shape().total_size() * tensor.info()->element_size(),
412 "Not enough data in file");
413 ARM_COMPUTE_UNUSED(end_position);
414
415 // Check if the typestring matches the given one
416 std::string expect_typestr = get_typestring(tensor.info()->data_type());
417 ARM_COMPUTE_ERROR_ON_MSG(_typestring != expect_typestr, "Typestrings mismatch");
418
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100419 bool are_layouts_different = (_file_layout != tensor.info()->data_layout());
420 // Correct dimensions (Needs to match TensorShape dimension corrections)
421 if(_shape.size() != tensor.info()->tensor_shape().num_dimensions())
422 {
423 for(int i = static_cast<int>(_shape.size()) - 1; i > 0; --i)
424 {
425 if(_shape[i] == 1)
426 {
427 _shape.pop_back();
428 }
429 else
430 {
431 break;
432 }
433 }
434 }
Michalis Spyrou39412952018-08-14 17:06:16 +0100435
436 TensorShape permuted_shape = tensor.info()->tensor_shape();
437 arm_compute::PermutationVector perm;
438 if(are_layouts_different && tensor.info()->tensor_shape().num_dimensions() > 2)
439 {
440 perm = (tensor.info()->data_layout() == arm_compute::DataLayout::NHWC) ? arm_compute::PermutationVector(2U, 0U, 1U) : arm_compute::PermutationVector(1U, 2U, 0U);
441 arm_compute::PermutationVector perm_vec = (tensor.info()->data_layout() == arm_compute::DataLayout::NCHW) ? arm_compute::PermutationVector(2U, 0U, 1U) : arm_compute::PermutationVector(1U, 2U, 0U);
442
443 arm_compute::permute(permuted_shape, perm_vec);
444 }
445
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100446 // Validate tensor shape
Anthony Barbier6db0ff52018-01-05 10:59:12 +0000447 ARM_COMPUTE_ERROR_ON_MSG(_shape.size() != tensor.info()->tensor_shape().num_dimensions(), "Tensor ranks mismatch");
Michalis Spyrou39412952018-08-14 17:06:16 +0100448 for(size_t i = 0; i < _shape.size(); ++i)
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100449 {
Michalis Spyrou39412952018-08-14 17:06:16 +0100450 ARM_COMPUTE_ERROR_ON_MSG(permuted_shape[i] != _shape[i], "Tensor dimensions mismatch");
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100451 }
452
Gian Marco0bc5a252017-12-04 13:55:08 +0000453 switch(tensor.info()->data_type())
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100454 {
Georgios Pinitasa799ce02018-09-12 20:11:34 +0100455 case arm_compute::DataType::QASYMM8:
456 case arm_compute::DataType::S32:
Gian Marco0bc5a252017-12-04 13:55:08 +0000457 case arm_compute::DataType::F32:
Vidhya Sudhan Loganathana25d16c2018-11-16 11:33:12 +0000458 case arm_compute::DataType::F16:
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100459 {
460 // Read data
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100461 if(!are_layouts_different && !_fortran_order && tensor.info()->padding().empty())
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100462 {
463 // If tensor has no padding read directly from stream.
464 _fs.read(reinterpret_cast<char *>(tensor.buffer()), tensor.info()->total_size());
465 }
466 else
467 {
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100468 // If tensor has padding or is in fortran order accessing tensor elements through execution window.
Michalis Spyrou39412952018-08-14 17:06:16 +0100469 Window window;
470 const unsigned int num_dims = _shape.size();
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100471 if(_fortran_order)
472 {
473 for(unsigned int dim = 0; dim < num_dims; dim++)
474 {
Michalis Spyrou39412952018-08-14 17:06:16 +0100475 permuted_shape.set(dim, _shape[num_dims - dim - 1]);
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100476 perm.set(dim, num_dims - dim - 1);
477 }
Michalis Spyrou39412952018-08-14 17:06:16 +0100478 if(are_layouts_different)
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100479 {
Michalis Spyrou39412952018-08-14 17:06:16 +0100480 // Permute only if num_dimensions greater than 2
481 if(num_dims > 2)
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100482 {
Michalis Spyrou39412952018-08-14 17:06:16 +0100483 if(_file_layout == DataLayout::NHWC) // i.e destination is NCHW --> permute(1,2,0)
484 {
485 arm_compute::permute(perm, arm_compute::PermutationVector(1U, 2U, 0U));
486 }
487 else
488 {
489 arm_compute::permute(perm, arm_compute::PermutationVector(2U, 0U, 1U));
490 }
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100491 }
492 }
493 }
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100494 window.use_tensor_dimensions(permuted_shape);
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100495
496 execute_window_loop(window, [&](const Coordinates & id)
497 {
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100498 Coordinates dst(id);
499 arm_compute::permute(dst, perm);
500 _fs.read(reinterpret_cast<char *>(tensor.ptr_to_element(dst)), tensor.info()->element_size());
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100501 });
502 }
503
504 break;
505 }
506 default:
Gian Marco0bc5a252017-12-04 13:55:08 +0000507 ARM_COMPUTE_ERROR("Unsupported data type");
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100508 }
509
510 // Unmap buffer if creating a CLTensor
511 unmap(tensor);
512 }
513 catch(const std::ifstream::failure &e)
514 {
515 ARM_COMPUTE_ERROR("Loading NPY file: %s", e.what());
516 }
517 }
518
519private:
520 std::ifstream _fs;
521 std::vector<unsigned long> _shape;
522 bool _fortran_order;
523 std::string _typestring;
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100524 DataLayout _file_layout;
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100525};
526
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100527/** Template helper function to save a tensor image to a PPM file.
528 *
529 * @note Only U8 and RGB888 formats supported.
530 * @note Only works with 2D tensors.
531 * @note If the input tensor is a CLTensor, the function maps and unmaps the image
532 *
533 * @param[in] tensor The tensor to save as PPM file
534 * @param[in] ppm_filename Filename of the file to create.
535 */
536template <typename T>
537void save_to_ppm(T &tensor, const std::string &ppm_filename)
538{
539 ARM_COMPUTE_ERROR_ON_FORMAT_NOT_IN(&tensor, arm_compute::Format::RGB888, arm_compute::Format::U8);
540 ARM_COMPUTE_ERROR_ON(tensor.info()->num_dimensions() > 2);
541
542 std::ofstream fs;
543
544 try
545 {
546 fs.exceptions(std::ofstream::failbit | std::ofstream::badbit | std::ofstream::eofbit);
547 fs.open(ppm_filename, std::ios::out | std::ios::binary);
548
549 const unsigned int width = tensor.info()->tensor_shape()[0];
550 const unsigned int height = tensor.info()->tensor_shape()[1];
551
552 fs << "P6\n"
553 << width << " " << height << " 255\n";
554
Anthony Barbier7068f992017-10-26 15:23:08 +0100555 // Map buffer if creating a CLTensor/GCTensor
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100556 map(tensor, true);
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100557
558 switch(tensor.info()->format())
559 {
560 case arm_compute::Format::U8:
561 {
562 arm_compute::Window window;
563 window.set(arm_compute::Window::DimX, arm_compute::Window::Dimension(0, width, 1));
564 window.set(arm_compute::Window::DimY, arm_compute::Window::Dimension(0, height, 1));
565
566 arm_compute::Iterator in(&tensor, window);
567
568 arm_compute::execute_window_loop(window, [&](const arm_compute::Coordinates & id)
569 {
570 const unsigned char value = *in.ptr();
571
572 fs << value << value << value;
573 },
574 in);
575
576 break;
577 }
578 case arm_compute::Format::RGB888:
579 {
580 arm_compute::Window window;
581 window.set(arm_compute::Window::DimX, arm_compute::Window::Dimension(0, width, width));
582 window.set(arm_compute::Window::DimY, arm_compute::Window::Dimension(0, height, 1));
583
584 arm_compute::Iterator in(&tensor, window);
585
586 arm_compute::execute_window_loop(window, [&](const arm_compute::Coordinates & id)
587 {
588 fs.write(reinterpret_cast<std::fstream::char_type *>(in.ptr()), width * tensor.info()->element_size());
589 },
590 in);
591
592 break;
593 }
594 default:
595 ARM_COMPUTE_ERROR("Unsupported format");
596 }
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100597
Anthony Barbier7068f992017-10-26 15:23:08 +0100598 // Unmap buffer if creating a CLTensor/GCTensor
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100599 unmap(tensor);
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100600 }
601 catch(const std::ofstream::failure &e)
602 {
603 ARM_COMPUTE_ERROR("Writing %s: (%s)", ppm_filename.c_str(), e.what());
604 }
605}
steniu01bee466b2017-06-21 16:45:41 +0100606
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100607/** Template helper function to save a tensor image to a NPY file.
608 *
Gian Marcobfa3b522017-12-12 10:08:38 +0000609 * @note Only F32 data type supported.
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100610 * @note Only works with 2D tensors.
611 * @note If the input tensor is a CLTensor, the function maps and unmaps the image
612 *
613 * @param[in] tensor The tensor to save as NPY file
614 * @param[in] npy_filename Filename of the file to create.
615 * @param[in] fortran_order If true, save matrix in fortran order.
616 */
617template <typename T>
618void save_to_npy(T &tensor, const std::string &npy_filename, bool fortran_order)
619{
Gian Marcobfa3b522017-12-12 10:08:38 +0000620 ARM_COMPUTE_ERROR_ON_DATA_TYPE_NOT_IN(&tensor, arm_compute::DataType::F32);
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100621
622 std::ofstream fs;
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100623 try
624 {
625 fs.exceptions(std::ofstream::failbit | std::ofstream::badbit | std::ofstream::eofbit);
626 fs.open(npy_filename, std::ios::out | std::ios::binary);
627
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100628 std::vector<npy::ndarray_len_t> shape(tensor.info()->num_dimensions());
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100629
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100630 for(unsigned int i = 0; i < tensor.info()->num_dimensions(); ++i)
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100631 {
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100632 shape[i] = tensor.info()->tensor_shape()[i];
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100633 }
634
635 // Map buffer if creating a CLTensor
636 map(tensor, true);
637
Gian Marcobfa3b522017-12-12 10:08:38 +0000638 switch(tensor.info()->data_type())
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100639 {
Gian Marcobfa3b522017-12-12 10:08:38 +0000640 case arm_compute::DataType::F32:
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100641 {
642 std::vector<float> tmp; /* Used only to get the typestring */
643 npy::Typestring typestring_o{ tmp };
644 std::string typestring = typestring_o.str();
645
646 std::ofstream stream(npy_filename, std::ofstream::binary);
Anthony Barbier87f21cd2017-11-10 16:27:32 +0000647 npy::write_header(stream, typestring, fortran_order, shape);
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100648
649 arm_compute::Window window;
Anthony Barbier4ead11a2018-08-06 09:25:36 +0100650 window.use_tensor_dimensions(tensor.info()->tensor_shape());
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100651
652 arm_compute::Iterator in(&tensor, window);
653
654 arm_compute::execute_window_loop(window, [&](const arm_compute::Coordinates & id)
655 {
656 stream.write(reinterpret_cast<const char *>(in.ptr()), sizeof(float));
657 },
658 in);
659
660 break;
661 }
662 default:
663 ARM_COMPUTE_ERROR("Unsupported format");
664 }
665
666 // Unmap buffer if creating a CLTensor
667 unmap(tensor);
668 }
669 catch(const std::ofstream::failure &e)
670 {
671 ARM_COMPUTE_ERROR("Writing %s: (%s)", npy_filename.c_str(), e.what());
672 }
673}
674
steniu01bee466b2017-06-21 16:45:41 +0100675/** Load the tensor with pre-trained data from a binary file
676 *
677 * @param[in] tensor The tensor to be filled. Data type supported: F32.
678 * @param[in] filename Filename of the binary file to load from.
679 */
680template <typename T>
681void load_trained_data(T &tensor, const std::string &filename)
682{
683 ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(&tensor, 1, DataType::F32);
684
685 std::ifstream fs;
686
687 try
688 {
689 fs.exceptions(std::ofstream::failbit | std::ofstream::badbit | std::ofstream::eofbit);
690 // Open file
691 fs.open(filename, std::ios::in | std::ios::binary);
692
693 if(!fs.good())
694 {
695 throw std::runtime_error("Could not load binary data: " + filename);
696 }
697
Anthony Barbier7068f992017-10-26 15:23:08 +0100698 // Map buffer if creating a CLTensor/GCTensor
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100699 map(tensor, true);
700
steniu01bee466b2017-06-21 16:45:41 +0100701 Window window;
702
703 window.set(arm_compute::Window::DimX, arm_compute::Window::Dimension(0, 1, 1));
704
705 for(unsigned int d = 1; d < tensor.info()->num_dimensions(); ++d)
706 {
707 window.set(d, Window::Dimension(0, tensor.info()->tensor_shape()[d], 1));
708 }
709
710 arm_compute::Iterator in(&tensor, window);
711
712 execute_window_loop(window, [&](const Coordinates & id)
713 {
714 fs.read(reinterpret_cast<std::fstream::char_type *>(in.ptr()), tensor.info()->tensor_shape()[0] * tensor.info()->element_size());
715 },
716 in);
717
Anthony Barbier7068f992017-10-26 15:23:08 +0100718 // Unmap buffer if creating a CLTensor/GCTensor
Georgios Pinitasdc836b62017-09-20 14:02:37 +0100719 unmap(tensor);
steniu01bee466b2017-06-21 16:45:41 +0100720 }
721 catch(const std::ofstream::failure &e)
722 {
723 ARM_COMPUTE_ERROR("Writing %s: (%s)", filename.c_str(), e.what());
724 }
725}
726
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100727template <typename T>
728void fill_random_tensor(T &tensor, float lower_bound, float upper_bound)
Anthony Barbier2a07e182017-08-04 18:20:27 +0100729{
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100730 std::random_device rd;
731 std::mt19937 gen(rd());
Anthony Barbier2a07e182017-08-04 18:20:27 +0100732
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100733 Window window;
Michalis Spyrou5e69bb42018-03-09 16:36:00 +0000734 window.use_tensor_dimensions(tensor.info()->tensor_shape());
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100735
736 map(tensor, true);
737
738 Iterator it(&tensor, window);
739
Gian Marcobfa3b522017-12-12 10:08:38 +0000740 switch(tensor.info()->data_type())
Anthony Barbier2a07e182017-08-04 18:20:27 +0100741 {
Vidhya Sudhan Loganathana25d16c2018-11-16 11:33:12 +0000742 case arm_compute::DataType::F16:
743 {
744 std::uniform_real_distribution<float> dist(lower_bound, upper_bound);
745
746 execute_window_loop(window, [&](const Coordinates & id)
747 {
748 *reinterpret_cast<half *>(it.ptr()) = (half)dist(gen);
749 },
750 it);
751
752 break;
753 }
Gian Marcobfa3b522017-12-12 10:08:38 +0000754 case arm_compute::DataType::F32:
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100755 {
756 std::uniform_real_distribution<float> dist(lower_bound, upper_bound);
757
758 execute_window_loop(window, [&](const Coordinates & id)
759 {
760 *reinterpret_cast<float *>(it.ptr()) = dist(gen);
761 },
762 it);
763
764 break;
765 }
Anthony Barbier2a07e182017-08-04 18:20:27 +0100766 default:
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100767 {
768 ARM_COMPUTE_ERROR("Unsupported format");
769 }
Anthony Barbier2a07e182017-08-04 18:20:27 +0100770 }
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100771
772 unmap(tensor);
Anthony Barbier2a07e182017-08-04 18:20:27 +0100773}
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100774
775template <typename T>
Gian Marco0bc5a252017-12-04 13:55:08 +0000776void init_sgemm_output(T &dst, T &src0, T &src1, arm_compute::DataType dt)
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100777{
Gian Marco0bc5a252017-12-04 13:55:08 +0000778 dst.allocator()->init(TensorInfo(TensorShape(src1.info()->dimension(0), src0.info()->dimension(1)), 1, dt));
Giorgio Arenacf3935f2017-10-26 17:14:13 +0100779}
Gian Marco5ca74092018-02-08 16:21:54 +0000780/** This function returns the amount of memory free reading from /proc/meminfo
781 *
782 * @return The free memory in kB
783 */
784uint64_t get_mem_free_from_meminfo();
Isabella Gottardi88d5b222018-04-06 12:24:55 +0100785
786/** Compare to tensor
787 *
788 * @param[in] tensor1 First tensor to be compared.
789 * @param[in] tensor2 Second tensor to be compared.
790 *
791 * @return The number of mismatches
792 */
793template <typename T>
794int compare_tensor(ITensor &tensor1, ITensor &tensor2)
795{
796 ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(&tensor1, &tensor2);
797 ARM_COMPUTE_ERROR_ON_MISMATCHING_SHAPES(&tensor1, &tensor2);
798
799 int num_mismatches = 0;
800 Window window;
801 window.use_tensor_dimensions(tensor1.info()->tensor_shape());
802
803 map(tensor1, true);
804 map(tensor2, true);
805 Iterator itensor1(&tensor1, window);
806 Iterator itensor2(&tensor2, window);
807
808 execute_window_loop(window, [&](const Coordinates & id)
809 {
810 if(std::abs(*reinterpret_cast<T *>(itensor1.ptr()) - *reinterpret_cast<T *>(itensor2.ptr())) > 0.00001)
811 {
812 ++num_mismatches;
813 }
814 },
815 itensor1, itensor2);
816
817 unmap(itensor1);
818 unmap(itensor2);
819
820 return num_mismatches;
821}
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100822} // namespace utils
823} // namespace arm_compute
824#endif /* __UTILS_UTILS_H__*/