blob: 342959824923828fee0d3280f344ac52373b9656 [file] [log] [blame]
telsoa014fcda012018-03-09 14:13:49 +00001//
Sadik Armagana9c2ce12020-07-14 10:02:22 +01002// Copyright © 2017 Arm Ltd and Contributors. All rights reserved.
David Beckecb56cd2018-09-05 12:52:57 +01003// SPDX-License-Identifier: MIT
telsoa014fcda012018-03-09 14:13:49 +00004//
Matteo Martincighc601aa62019-10-29 15:03:22 +00005
telsoa014fcda012018-03-09 14:13:49 +00006#pragma once
Matteo Martincighc601aa62019-10-29 15:03:22 +00007
David Beckf0b48452018-10-19 15:20:56 +01008#include <armnn/ArmNN.hpp>
alered01a7227ac2020-05-07 14:58:29 +01009#include <armnn/Logging.hpp>
10#include <armnn/utility/Timer.hpp>
Matteo Martincighc601aa62019-10-29 15:03:22 +000011#include <armnn/BackendRegistry.hpp>
Narumol Prangnawaratac2770a2020-04-01 16:51:23 +010012#include <armnn/utility/Assert.hpp>
Matthew Sloyan80c6b142020-09-08 12:00:32 +010013#include <armnn/utility/NumericCast.hpp>
telsoa01c577f2c2018-08-31 09:22:23 +010014
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +000015#if defined(ARMNN_SERIALIZER)
Derek Lamberti0028d1b2019-02-20 13:57:42 +000016#include "armnnDeserializer/IDeserializer.hpp"
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +000017#endif
telsoa01c577f2c2018-08-31 09:22:23 +010018#if defined(ARMNN_TF_LITE_PARSER)
David Beckf0b48452018-10-19 15:20:56 +010019#include <armnnTfLiteParser/ITfLiteParser.hpp>
telsoa01c577f2c2018-08-31 09:22:23 +010020#endif
telsoa01c577f2c2018-08-31 09:22:23 +010021#if defined(ARMNN_ONNX_PARSER)
David Beckf0b48452018-10-19 15:20:56 +010022#include <armnnOnnxParser/IOnnxParser.hpp>
telsoa01c577f2c2018-08-31 09:22:23 +010023#endif
telsoa014fcda012018-03-09 14:13:49 +000024
Francis Murtagh532a29d2020-06-29 11:50:01 +010025#include <Filesystem.hpp>
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +000026#include <HeapProfiling.hpp>
Jim Flynn2fd61002019-05-03 12:54:26 +010027#include <TensorIOUtils.hpp>
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +000028
David Monahana8837bf2020-04-16 10:01:56 +010029#include "armnn/utility/StringUtils.hpp"
James Wardc89829f2020-10-12 14:17:36 +010030#include <cxxopts/cxxopts.hpp>
31#include "CxxoptsUtils.hpp"
James Ward08f40162020-09-07 16:45:07 +010032#include <fmt/format.h>
James Ward6d9f5c52020-09-28 11:56:35 +010033#include <mapbox/variant.hpp>
telsoa014fcda012018-03-09 14:13:49 +000034
Aron Virginas-Tar339bcae2019-01-31 16:44:26 +000035#include <algorithm>
36#include <iterator>
Aron Virginas-Tar5cc8e562018-10-23 15:14:46 +010037#include <fstream>
telsoa014fcda012018-03-09 14:13:49 +000038#include <map>
39#include <string>
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +000040#include <vector>
telsoa01c577f2c2018-08-31 09:22:23 +010041#include <type_traits>
42
Aron Virginas-Tar5cc8e562018-10-23 15:14:46 +010043namespace
44{
45
46inline bool CheckRequestedBackendsAreValid(const std::vector<armnn::BackendId>& backendIds,
47 armnn::Optional<std::string&> invalidBackendIds = armnn::EmptyOptional())
48{
49 if (backendIds.empty())
50 {
51 return false;
52 }
53
54 armnn::BackendIdSet validBackendIds = armnn::BackendRegistryInstance().GetBackendIds();
55
56 bool allValid = true;
57 for (const auto& backendId : backendIds)
58 {
59 if (std::find(validBackendIds.begin(), validBackendIds.end(), backendId) == validBackendIds.end())
60 {
61 allValid = false;
62 if (invalidBackendIds)
63 {
64 if (!invalidBackendIds.value().empty())
65 {
66 invalidBackendIds.value() += ", ";
67 }
68 invalidBackendIds.value() += backendId;
69 }
70 }
71 }
72 return allValid;
73}
74
75} // anonymous namespace
76
telsoa01c577f2c2018-08-31 09:22:23 +010077namespace InferenceModelInternal
78{
Jim Flynnb4d7eae2019-05-01 14:44:27 +010079using BindingPointInfo = armnn::BindingPointInfo;
telsoa01c577f2c2018-08-31 09:22:23 +010080
81using QuantizationParams = std::pair<float,int32_t>;
82
83struct Params
84{
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +000085 std::string m_ModelPath;
86 std::vector<std::string> m_InputBindings;
87 std::vector<armnn::TensorShape> m_InputShapes;
88 std::vector<std::string> m_OutputBindings;
Aron Virginas-Tar339bcae2019-01-31 16:44:26 +000089 std::vector<armnn::BackendId> m_ComputeDevices;
Matteo Martincigh00dda4a2019-08-14 11:42:30 +010090 std::string m_DynamicBackendsPath;
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +000091 size_t m_SubgraphId;
92 bool m_IsModelBinary;
93 bool m_VisualizePostOptimizationModel;
94 bool m_EnableFp16TurboMode;
Narumol Prangnawaratd8cc8112020-03-24 13:54:05 +000095 bool m_EnableBf16TurboMode;
Matthew Jackson54658b92019-08-27 15:35:59 +010096 bool m_PrintIntermediateLayers;
Derek Lamberti132563c2019-12-02 16:06:40 +000097 bool m_ParseUnsupported;
Sadik Armagana9c2ce12020-07-14 10:02:22 +010098 bool m_InferOutputShape;
Sadik Armagana25886e2020-09-15 17:17:08 +010099 bool m_EnableFastMath;
Matthew Sloyan42432112021-01-08 10:30:51 +0000100 bool m_SaveCachedNetwork;
101 std::string m_CachedNetworkFilePath;
Matthew Sloyan0a7dc6b2021-02-10 16:50:53 +0000102 unsigned int m_NumberOfThreads;
Finn Williams40646322021-02-11 16:16:42 +0000103 std::string m_MLGOTuningFilePath;
Sadik Armagana04a9d72021-04-27 10:02:10 +0100104 bool m_AsyncEnabled;
Finn Williams40646322021-02-11 16:16:42 +0000105
telsoa01c577f2c2018-08-31 09:22:23 +0100106
107 Params()
Matteo Martincigh00dda4a2019-08-14 11:42:30 +0100108 : m_ComputeDevices{}
telsoa01c577f2c2018-08-31 09:22:23 +0100109 , m_SubgraphId(0)
110 , m_IsModelBinary(true)
111 , m_VisualizePostOptimizationModel(false)
112 , m_EnableFp16TurboMode(false)
Narumol Prangnawaratd8cc8112020-03-24 13:54:05 +0000113 , m_EnableBf16TurboMode(false)
Matthew Jackson54658b92019-08-27 15:35:59 +0100114 , m_PrintIntermediateLayers(false)
Derek Lamberti132563c2019-12-02 16:06:40 +0000115 , m_ParseUnsupported(false)
Sadik Armagana9c2ce12020-07-14 10:02:22 +0100116 , m_InferOutputShape(false)
Sadik Armagana25886e2020-09-15 17:17:08 +0100117 , m_EnableFastMath(false)
Matthew Sloyan42432112021-01-08 10:30:51 +0000118 , m_SaveCachedNetwork(false)
119 , m_CachedNetworkFilePath("")
Matthew Sloyan0a7dc6b2021-02-10 16:50:53 +0000120 , m_NumberOfThreads(0)
Finn Williams40646322021-02-11 16:16:42 +0000121 , m_MLGOTuningFilePath("")
Sadik Armagana04a9d72021-04-27 10:02:10 +0100122 , m_AsyncEnabled(false)
telsoa01c577f2c2018-08-31 09:22:23 +0100123 {}
124};
125
126} // namespace InferenceModelInternal
127
128template <typename IParser>
129struct CreateNetworkImpl
130{
131public:
132 using Params = InferenceModelInternal::Params;
telsoa01c577f2c2018-08-31 09:22:23 +0100133
134 static armnn::INetworkPtr Create(const Params& params,
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100135 std::vector<armnn::BindingPointInfo>& inputBindings,
136 std::vector<armnn::BindingPointInfo>& outputBindings)
telsoa01c577f2c2018-08-31 09:22:23 +0100137 {
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000138 const std::string& modelPath = params.m_ModelPath;
telsoa01c577f2c2018-08-31 09:22:23 +0100139
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000140 // Create a network from a file on disk
141 auto parser(IParser::Create());
telsoa01c577f2c2018-08-31 09:22:23 +0100142
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000143 std::map<std::string, armnn::TensorShape> inputShapes;
144 if (!params.m_InputShapes.empty())
145 {
146 const size_t numInputShapes = params.m_InputShapes.size();
147 const size_t numInputBindings = params.m_InputBindings.size();
148 if (numInputShapes < numInputBindings)
149 {
James Ward08f40162020-09-07 16:45:07 +0100150 throw armnn::Exception(fmt::format(
151 "Not every input has its tensor shape specified: expected={0}, got={1}",
152 numInputBindings, numInputShapes));
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000153 }
telsoa01c577f2c2018-08-31 09:22:23 +0100154
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000155 for (size_t i = 0; i < numInputShapes; i++)
156 {
157 inputShapes[params.m_InputBindings[i]] = params.m_InputShapes[i];
158 }
159 }
telsoa01c577f2c2018-08-31 09:22:23 +0100160
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000161 std::vector<std::string> requestedOutputs = params.m_OutputBindings;
162 armnn::INetworkPtr network{nullptr, [](armnn::INetwork *){}};
163
164 {
165 ARMNN_SCOPED_HEAP_PROFILING("Parsing");
166 // Handle text and binary input differently by calling the corresponding parser function
167 network = (params.m_IsModelBinary ?
168 parser->CreateNetworkFromBinaryFile(modelPath.c_str(), inputShapes, requestedOutputs) :
169 parser->CreateNetworkFromTextFile(modelPath.c_str(), inputShapes, requestedOutputs));
170 }
171
172 for (const std::string& inputLayerName : params.m_InputBindings)
173 {
174 inputBindings.push_back(parser->GetNetworkInputBindingInfo(inputLayerName));
175 }
176
177 for (const std::string& outputLayerName : params.m_OutputBindings)
178 {
179 outputBindings.push_back(parser->GetNetworkOutputBindingInfo(outputLayerName));
180 }
181
182 return network;
telsoa01c577f2c2018-08-31 09:22:23 +0100183 }
184};
185
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000186#if defined(ARMNN_SERIALIZER)
187template <>
Derek Lamberti0028d1b2019-02-20 13:57:42 +0000188struct CreateNetworkImpl<armnnDeserializer::IDeserializer>
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000189{
190public:
Derek Lamberti0028d1b2019-02-20 13:57:42 +0000191 using IParser = armnnDeserializer::IDeserializer;
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000192 using Params = InferenceModelInternal::Params;
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000193
194 static armnn::INetworkPtr Create(const Params& params,
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100195 std::vector<armnn::BindingPointInfo>& inputBindings,
196 std::vector<armnn::BindingPointInfo>& outputBindings)
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000197 {
198 auto parser(IParser::Create());
Narumol Prangnawaratac2770a2020-04-01 16:51:23 +0100199 ARMNN_ASSERT(parser);
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000200
201 armnn::INetworkPtr network{nullptr, [](armnn::INetwork *){}};
202
203 {
204 ARMNN_SCOPED_HEAP_PROFILING("Parsing");
Derek Lamberti2b183fb2019-02-18 16:36:57 +0000205
Francis Murtagh532a29d2020-06-29 11:50:01 +0100206 std::error_code errorCode;
207 fs::path pathToFile(params.m_ModelPath);
208 if (!fs::exists(pathToFile, errorCode))
Derek Lamberti2b183fb2019-02-18 16:36:57 +0000209 {
James Ward08f40162020-09-07 16:45:07 +0100210 throw armnn::FileNotFoundException(fmt::format("Cannot find the file ({0}) errorCode: {1} {2}",
211 params.m_ModelPath,
212 errorCode.message(),
Derek Lamberti2b183fb2019-02-18 16:36:57 +0000213 CHECK_LOCATION().AsString()));
214 }
215 std::ifstream file(params.m_ModelPath, std::ios::binary);
216
217 network = parser->CreateNetworkFromBinary(file);
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000218 }
219
Matthew Sloyan80c6b142020-09-08 12:00:32 +0100220 unsigned int subgraphId = armnn::numeric_cast<unsigned int>(params.m_SubgraphId);
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000221
222 for (const std::string& inputLayerName : params.m_InputBindings)
223 {
Derek Lamberti8ddae332019-02-21 16:29:43 +0000224 armnnDeserializer::BindingPointInfo inputBinding =
Derek Lambertiff05cc52019-04-26 13:05:17 +0100225 parser->GetNetworkInputBindingInfo(subgraphId, inputLayerName);
Derek Lamberti8ddae332019-02-21 16:29:43 +0000226 inputBindings.push_back(std::make_pair(inputBinding.m_BindingId, inputBinding.m_TensorInfo));
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000227 }
228
229 for (const std::string& outputLayerName : params.m_OutputBindings)
230 {
Derek Lamberti8ddae332019-02-21 16:29:43 +0000231 armnnDeserializer::BindingPointInfo outputBinding =
Derek Lambertiff05cc52019-04-26 13:05:17 +0100232 parser->GetNetworkOutputBindingInfo(subgraphId, outputLayerName);
Derek Lamberti8ddae332019-02-21 16:29:43 +0000233 outputBindings.push_back(std::make_pair(outputBinding.m_BindingId, outputBinding.m_TensorInfo));
Aron Virginas-Tar64e4ccb2019-02-12 11:27:53 +0000234 }
235
236 return network;
237 }
238};
239#endif
240
telsoa01c577f2c2018-08-31 09:22:23 +0100241#if defined(ARMNN_TF_LITE_PARSER)
242template <>
243struct CreateNetworkImpl<armnnTfLiteParser::ITfLiteParser>
244{
245public:
246 using IParser = armnnTfLiteParser::ITfLiteParser;
247 using Params = InferenceModelInternal::Params;
telsoa01c577f2c2018-08-31 09:22:23 +0100248
249 static armnn::INetworkPtr Create(const Params& params,
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100250 std::vector<armnn::BindingPointInfo>& inputBindings,
251 std::vector<armnn::BindingPointInfo>& outputBindings)
telsoa01c577f2c2018-08-31 09:22:23 +0100252 {
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000253 const std::string& modelPath = params.m_ModelPath;
telsoa01c577f2c2018-08-31 09:22:23 +0100254
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000255 // Create a network from a file on disk
Derek Lamberti132563c2019-12-02 16:06:40 +0000256 IParser::TfLiteParserOptions options;
257 options.m_StandInLayerForUnsupported = params.m_ParseUnsupported;
Sadik Armagana9c2ce12020-07-14 10:02:22 +0100258 options.m_InferAndValidate = params.m_InferOutputShape;
Derek Lamberti132563c2019-12-02 16:06:40 +0000259 auto parser(IParser::Create(options));
telsoa01c577f2c2018-08-31 09:22:23 +0100260
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000261 armnn::INetworkPtr network{nullptr, [](armnn::INetwork *){}};
telsoa01c577f2c2018-08-31 09:22:23 +0100262
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000263 {
264 ARMNN_SCOPED_HEAP_PROFILING("Parsing");
265 network = parser->CreateNetworkFromBinaryFile(modelPath.c_str());
266 }
telsoa01c577f2c2018-08-31 09:22:23 +0100267
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000268 for (const std::string& inputLayerName : params.m_InputBindings)
269 {
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100270 armnn::BindingPointInfo inputBinding =
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000271 parser->GetNetworkInputBindingInfo(params.m_SubgraphId, inputLayerName);
272 inputBindings.push_back(inputBinding);
273 }
274
275 for (const std::string& outputLayerName : params.m_OutputBindings)
276 {
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100277 armnn::BindingPointInfo outputBinding =
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000278 parser->GetNetworkOutputBindingInfo(params.m_SubgraphId, outputLayerName);
279 outputBindings.push_back(outputBinding);
280 }
281
282 return network;
telsoa01c577f2c2018-08-31 09:22:23 +0100283 }
284};
285#endif
286
287#if defined(ARMNN_ONNX_PARSER)
288template <>
289struct CreateNetworkImpl<armnnOnnxParser::IOnnxParser>
290{
291public:
292 using IParser = armnnOnnxParser::IOnnxParser;
293 using Params = InferenceModelInternal::Params;
294 using BindingPointInfo = InferenceModelInternal::BindingPointInfo;
295
296 static armnn::INetworkPtr Create(const Params& params,
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000297 std::vector<BindingPointInfo>& inputBindings,
298 std::vector<BindingPointInfo>& outputBindings)
telsoa01c577f2c2018-08-31 09:22:23 +0100299 {
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000300 const std::string& modelPath = params.m_ModelPath;
telsoa01c577f2c2018-08-31 09:22:23 +0100301
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000302 // Create a network from a file on disk
303 auto parser(IParser::Create());
telsoa01c577f2c2018-08-31 09:22:23 +0100304
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000305 armnn::INetworkPtr network{nullptr, [](armnn::INetwork *){}};
telsoa01c577f2c2018-08-31 09:22:23 +0100306
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000307 {
308 ARMNN_SCOPED_HEAP_PROFILING("Parsing");
309 network = (params.m_IsModelBinary ?
310 parser->CreateNetworkFromBinaryFile(modelPath.c_str()) :
311 parser->CreateNetworkFromTextFile(modelPath.c_str()));
312 }
telsoa01c577f2c2018-08-31 09:22:23 +0100313
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000314 for (const std::string& inputLayerName : params.m_InputBindings)
315 {
316 BindingPointInfo inputBinding = parser->GetNetworkInputBindingInfo(inputLayerName);
317 inputBindings.push_back(inputBinding);
318 }
319
320 for (const std::string& outputLayerName : params.m_OutputBindings)
321 {
322 BindingPointInfo outputBinding = parser->GetNetworkOutputBindingInfo(outputLayerName);
323 outputBindings.push_back(outputBinding);
324 }
325
326 return network;
telsoa01c577f2c2018-08-31 09:22:23 +0100327 }
328};
329#endif
telsoa014fcda012018-03-09 14:13:49 +0000330
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000331
telsoa014fcda012018-03-09 14:13:49 +0000332
333template <typename IParser, typename TDataType>
334class InferenceModel
335{
336public:
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000337 using DataType = TDataType;
338 using Params = InferenceModelInternal::Params;
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000339 using QuantizationParams = InferenceModelInternal::QuantizationParams;
Finn Williamsf806c4d2021-02-22 15:13:12 +0000340 using TContainer
341 = mapbox::util::variant<std::vector<float>, std::vector<int>, std::vector<unsigned char>, std::vector<int8_t>>;
telsoa014fcda012018-03-09 14:13:49 +0000342
343 struct CommandLineOptions
344 {
345 std::string m_ModelDir;
Aron Virginas-Tar339bcae2019-01-31 16:44:26 +0000346 std::vector<std::string> m_ComputeDevices;
Matteo Martincigh00dda4a2019-08-14 11:42:30 +0100347 std::string m_DynamicBackendsPath;
surmeh013537c2c2018-05-18 16:31:43 +0100348 bool m_VisualizePostOptimizationModel;
telsoa01c577f2c2018-08-31 09:22:23 +0100349 bool m_EnableFp16TurboMode;
Narumol Prangnawaratd8cc8112020-03-24 13:54:05 +0000350 bool m_EnableBf16TurboMode;
Pablo Tello507f39d2019-04-15 15:44:39 +0100351 std::string m_Labels;
Aron Virginas-Tar339bcae2019-01-31 16:44:26 +0000352
353 std::vector<armnn::BackendId> GetComputeDevicesAsBackendIds()
354 {
355 std::vector<armnn::BackendId> backendIds;
356 std::copy(m_ComputeDevices.begin(), m_ComputeDevices.end(), std::back_inserter(backendIds));
357 return backendIds;
358 }
telsoa014fcda012018-03-09 14:13:49 +0000359 };
360
James Wardc89829f2020-10-12 14:17:36 +0100361 static void AddCommandLineOptions(cxxopts::Options& options,
362 CommandLineOptions& cLineOptions, std::vector<std::string>& required)
telsoa014fcda012018-03-09 14:13:49 +0000363 {
Aron Virginas-Tar339bcae2019-01-31 16:44:26 +0000364 const std::vector<std::string> defaultComputes = { "CpuAcc", "CpuRef" };
David Beckf0b48452018-10-19 15:20:56 +0100365
Aron Virginas-Tar5cc8e562018-10-23 15:14:46 +0100366 const std::string backendsMessage = "Which device to run layers on by default. Possible choices: "
367 + armnn::BackendRegistryInstance().GetBackendIdsAsString();
368
James Wardc89829f2020-10-12 14:17:36 +0100369 options
370 .allow_unrecognised_options()
371 .add_options()
Nikhil Raj6dd178f2021-04-02 22:04:39 +0100372 ("m,model-dir", "Path to directory containing model files (.prototxt/.tflite)",
James Wardc89829f2020-10-12 14:17:36 +0100373 cxxopts::value<std::string>(cLineOptions.m_ModelDir))
374 ("c,compute", backendsMessage.c_str(),
375 cxxopts::value<std::vector<std::string>>(cLineOptions.m_ComputeDevices)->default_value("CpuRef"))
376 ("b,dynamic-backends-path",
377 "Path where to load any available dynamic backend from. "
378 "If left empty (the default), dynamic backends will not be used.",
379 cxxopts::value(cLineOptions.m_DynamicBackendsPath))
380 ("l,labels",
381 "Text file containing one image filename - correct label pair per line, "
382 "used to test the accuracy of the network.", cxxopts::value<std::string>(cLineOptions.m_Labels))
383 ("v,visualize-optimized-model",
384 "Produce a dot file useful for visualizing the graph post optimization."
385 "The file will have the same name as the model with the .dot extention.",
386 cxxopts::value<bool>(cLineOptions.m_VisualizePostOptimizationModel)->default_value("false"))
387 ("fp16-turbo-mode",
388 "If this option is enabled FP32 layers, weights and biases will be converted "
389 "to FP16 where the backend supports it.",
390 cxxopts::value<bool>(cLineOptions.m_EnableFp16TurboMode)->default_value("false"))
391 ("bf16-turbo-mode",
392 "If this option is enabled FP32 layers, weights and biases will be converted "
393 "to BF16 where the backend supports it.",
394 cxxopts::value<bool>(cLineOptions.m_EnableBf16TurboMode)->default_value("false"));
395
396 required.emplace_back("model-dir");
telsoa014fcda012018-03-09 14:13:49 +0000397 }
398
Matthew Bentham3e68b972019-04-09 13:10:46 +0100399 InferenceModel(const Params& params,
400 bool enableProfiling,
Matteo Martincigh00dda4a2019-08-14 11:42:30 +0100401 const std::string& dynamicBackendsPath,
Matthew Bentham3e68b972019-04-09 13:10:46 +0100402 const std::shared_ptr<armnn::IRuntime>& runtime = nullptr)
403 : m_EnableProfiling(enableProfiling)
Matteo Martincigh00dda4a2019-08-14 11:42:30 +0100404 , m_DynamicBackendsPath(dynamicBackendsPath)
telsoa014fcda012018-03-09 14:13:49 +0000405 {
telsoa01c577f2c2018-08-31 09:22:23 +0100406 if (runtime)
telsoa014fcda012018-03-09 14:13:49 +0000407 {
telsoa01c577f2c2018-08-31 09:22:23 +0100408 m_Runtime = runtime;
telsoa014fcda012018-03-09 14:13:49 +0000409 }
telsoa01c577f2c2018-08-31 09:22:23 +0100410 else
telsoa014fcda012018-03-09 14:13:49 +0000411 {
telsoa01c577f2c2018-08-31 09:22:23 +0100412 armnn::IRuntime::CreationOptions options;
Nina Drozd549ae372018-09-10 14:26:44 +0100413 options.m_EnableGpuProfiling = m_EnableProfiling;
Matteo Martincigh00dda4a2019-08-14 11:42:30 +0100414 options.m_DynamicBackendsPath = m_DynamicBackendsPath;
telsoa01c577f2c2018-08-31 09:22:23 +0100415 m_Runtime = std::move(armnn::IRuntime::Create(options));
surmeh013537c2c2018-05-18 16:31:43 +0100416 }
telsoa014fcda012018-03-09 14:13:49 +0000417
Aron Virginas-Tar5cc8e562018-10-23 15:14:46 +0100418 std::string invalidBackends;
Aron Virginas-Tar339bcae2019-01-31 16:44:26 +0000419 if (!CheckRequestedBackendsAreValid(params.m_ComputeDevices, armnn::Optional<std::string&>(invalidBackends)))
Aron Virginas-Tar5cc8e562018-10-23 15:14:46 +0100420 {
421 throw armnn::Exception("Some backend IDs are invalid: " + invalidBackends);
422 }
423
Matteo Martincigh00dda4a2019-08-14 11:42:30 +0100424 armnn::IOptimizedNetworkPtr optNet{nullptr, [](armnn::IOptimizedNetwork*){}};
surmeh013537c2c2018-05-18 16:31:43 +0100425 {
Finn Williams4422cec2021-03-22 17:51:06 +0000426 const auto parsing_start_time = armnn::GetTimeNow();
427 armnn::INetworkPtr network = CreateNetworkImpl<IParser>::Create(params, m_InputBindings, m_OutputBindings);
428
429 ARMNN_LOG(info) << "Network parsing time: " << std::setprecision(2)
430 << std::fixed << armnn::GetTimeDuration(parsing_start_time).count() << " ms\n";
431
surmeh013537c2c2018-05-18 16:31:43 +0100432 ARMNN_SCOPED_HEAP_PROFILING("Optimizing");
telsoa01c577f2c2018-08-31 09:22:23 +0100433
434 armnn::OptimizerOptions options;
435 options.m_ReduceFp32ToFp16 = params.m_EnableFp16TurboMode;
Narumol Prangnawaratd8cc8112020-03-24 13:54:05 +0000436 options.m_ReduceFp32ToBf16 = params.m_EnableBf16TurboMode;
Matthew Jackson54658b92019-08-27 15:35:59 +0100437 options.m_Debug = params.m_PrintIntermediateLayers;
telsoa01c577f2c2018-08-31 09:22:23 +0100438
Sadik Armagana25886e2020-09-15 17:17:08 +0100439 armnn::BackendOptions gpuAcc("GpuAcc",
440 {
Matthew Sloyan42432112021-01-08 10:30:51 +0000441 { "FastMathEnabled", params.m_EnableFastMath },
442 { "SaveCachedNetwork", params.m_SaveCachedNetwork },
Finn Williams40646322021-02-11 16:16:42 +0000443 { "CachedNetworkFilePath", params.m_CachedNetworkFilePath },
444 { "MLGOTuningFilePath", params.m_MLGOTuningFilePath }
Sadik Armagana25886e2020-09-15 17:17:08 +0100445 });
Finn Williams40646322021-02-11 16:16:42 +0000446
Sadik Armagana25886e2020-09-15 17:17:08 +0100447 armnn::BackendOptions cpuAcc("CpuAcc",
448 {
Matthew Sloyan0a7dc6b2021-02-10 16:50:53 +0000449 { "FastMathEnabled", params.m_EnableFastMath },
450 { "NumberOfThreads", params.m_NumberOfThreads }
Sadik Armagana25886e2020-09-15 17:17:08 +0100451 });
452 options.m_ModelOptions.push_back(gpuAcc);
453 options.m_ModelOptions.push_back(cpuAcc);
454
alered01a7227ac2020-05-07 14:58:29 +0100455 const auto optimization_start_time = armnn::GetTimeNow();
Aron Virginas-Tar339bcae2019-01-31 16:44:26 +0000456 optNet = armnn::Optimize(*network, params.m_ComputeDevices, m_Runtime->GetDeviceSpec(), options);
alered01a7227ac2020-05-07 14:58:29 +0100457
458 ARMNN_LOG(info) << "Optimization time: " << std::setprecision(2)
459 << std::fixed << armnn::GetTimeDuration(optimization_start_time).count() << " ms\n";
460
telsoa01c577f2c2018-08-31 09:22:23 +0100461 if (!optNet)
462 {
463 throw armnn::Exception("Optimize returned nullptr");
464 }
Finn Williams4422cec2021-03-22 17:51:06 +0000465
466
surmeh013537c2c2018-05-18 16:31:43 +0100467 }
telsoa014fcda012018-03-09 14:13:49 +0000468
surmeh013537c2c2018-05-18 16:31:43 +0100469 if (params.m_VisualizePostOptimizationModel)
470 {
Francis Murtagh532a29d2020-06-29 11:50:01 +0100471 fs::path filename = params.m_ModelPath;
surmeh013537c2c2018-05-18 16:31:43 +0100472 filename.replace_extension("dot");
Rob Hughes9e10c2b2019-07-23 15:37:19 +0100473 std::fstream file(filename.c_str(), std::ios_base::out);
surmeh013537c2c2018-05-18 16:31:43 +0100474 optNet->SerializeToDot(file);
475 }
476
477 armnn::Status ret;
478 {
479 ARMNN_SCOPED_HEAP_PROFILING("LoadNetwork");
Matthew Sloyan4f29f152021-01-18 16:10:20 +0000480
481 const auto loading_start_time = armnn::GetTimeNow();
Francis Murtagh73d3e2e2021-04-29 14:23:04 +0100482 armnn::INetworkProperties networkProperties(params.m_AsyncEnabled,
483 armnn::MemorySource::Undefined,
484 armnn::MemorySource::Undefined);
Sadik Armagana04a9d72021-04-27 10:02:10 +0100485 std::string errorMessage;
486 ret = m_Runtime->LoadNetwork(m_NetworkIdentifier, std::move(optNet), errorMessage, networkProperties);
Matthew Sloyan4f29f152021-01-18 16:10:20 +0000487
488 ARMNN_LOG(info) << "Network loading time: " << std::setprecision(2)
489 << std::fixed << armnn::GetTimeDuration(loading_start_time).count() << " ms\n";
surmeh013537c2c2018-05-18 16:31:43 +0100490 }
491
telsoa014fcda012018-03-09 14:13:49 +0000492 if (ret == armnn::Status::Failure)
493 {
494 throw armnn::Exception("IRuntime::LoadNetwork failed");
495 }
496 }
497
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000498 void CheckInputIndexIsValid(unsigned int inputIndex) const
telsoa014fcda012018-03-09 14:13:49 +0000499 {
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000500 if (m_InputBindings.size() < inputIndex + 1)
501 {
James Ward08f40162020-09-07 16:45:07 +0100502 throw armnn::Exception(fmt::format("Input index out of range: {}", inputIndex));
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000503 }
telsoa014fcda012018-03-09 14:13:49 +0000504 }
505
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000506 void CheckOutputIndexIsValid(unsigned int outputIndex) const
telsoa014fcda012018-03-09 14:13:49 +0000507 {
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000508 if (m_OutputBindings.size() < outputIndex + 1)
509 {
James Ward08f40162020-09-07 16:45:07 +0100510 throw armnn::Exception(fmt::format("Output index out of range: {}", outputIndex));
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000511 }
512 }
513
Aron Virginas-Tarc82c8732019-10-24 17:07:43 +0100514 unsigned int GetInputSize(unsigned int inputIndex = 0u) const
515 {
516 CheckInputIndexIsValid(inputIndex);
517 return m_InputBindings[inputIndex].second.GetNumElements();
518 }
519
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000520 unsigned int GetOutputSize(unsigned int outputIndex = 0u) const
521 {
522 CheckOutputIndexIsValid(outputIndex);
523 return m_OutputBindings[outputIndex].second.GetNumElements();
524 }
525
James Conroy7b4886f2019-04-11 10:23:58 +0100526 std::chrono::duration<double, std::milli> Run(
527 const std::vector<TContainer>& inputContainers,
528 std::vector<TContainer>& outputContainers)
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000529 {
Ferran Balaguerc602f292019-02-08 17:09:55 +0000530 for (unsigned int i = 0; i < outputContainers.size(); ++i)
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000531 {
532 const unsigned int expectedOutputDataSize = GetOutputSize(i);
Ferran Balaguerc602f292019-02-08 17:09:55 +0000533
James Ward6d9f5c52020-09-28 11:56:35 +0100534 mapbox::util::apply_visitor([expectedOutputDataSize, i](auto&& value)
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000535 {
Matthew Sloyan80c6b142020-09-08 12:00:32 +0100536 const unsigned int actualOutputDataSize = armnn::numeric_cast<unsigned int>(value.size());
Ferran Balaguerc602f292019-02-08 17:09:55 +0000537 if (actualOutputDataSize < expectedOutputDataSize)
538 {
Matthew Sloyan80c6b142020-09-08 12:00:32 +0100539 unsigned int outputIndex = i;
Ferran Balaguerc602f292019-02-08 17:09:55 +0000540 throw armnn::Exception(
James Ward08f40162020-09-07 16:45:07 +0100541 fmt::format("Not enough data for output #{0}: expected "
542 "{1} elements, got {2}", outputIndex, expectedOutputDataSize, actualOutputDataSize));
Ferran Balaguerc602f292019-02-08 17:09:55 +0000543 }
544 },
545 outputContainers[i]);
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000546 }
telsoa01c577f2c2018-08-31 09:22:23 +0100547
548 std::shared_ptr<armnn::IProfiler> profiler = m_Runtime->GetProfiler(m_NetworkIdentifier);
549 if (profiler)
550 {
551 profiler->EnableProfiling(m_EnableProfiling);
552 }
553
James Conroy7b4886f2019-04-11 10:23:58 +0100554 // Start timer to record inference time in EnqueueWorkload (in milliseconds)
alered01a7227ac2020-05-07 14:58:29 +0100555 const auto start_time = armnn::GetTimeNow();
James Conroy7b4886f2019-04-11 10:23:58 +0100556
telsoa014fcda012018-03-09 14:13:49 +0000557 armnn::Status ret = m_Runtime->EnqueueWorkload(m_NetworkIdentifier,
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000558 MakeInputTensors(inputContainers),
559 MakeOutputTensors(outputContainers));
alered01a7227ac2020-05-07 14:58:29 +0100560 const auto duration = armnn::GetTimeDuration(start_time);
James Conroy7b4886f2019-04-11 10:23:58 +0100561
Sadik Armagan2b7a1582018-09-05 16:33:58 +0100562 // if profiling is enabled print out the results
563 if (profiler && profiler->IsProfilingEnabled())
564 {
565 profiler->Print(std::cout);
566 }
567
telsoa014fcda012018-03-09 14:13:49 +0000568 if (ret == armnn::Status::Failure)
569 {
570 throw armnn::Exception("IRuntime::EnqueueWorkload failed");
571 }
James Conroy7b4886f2019-04-11 10:23:58 +0100572 else
573 {
alered01a7227ac2020-05-07 14:58:29 +0100574 return duration;
James Conroy7b4886f2019-04-11 10:23:58 +0100575 }
telsoa014fcda012018-03-09 14:13:49 +0000576 }
577
Sadik Armagana04a9d72021-04-27 10:02:10 +0100578 std::tuple<armnn::profiling::ProfilingGuid, std::chrono::duration<double, std::milli>> RunAsync(
579 armnn::experimental::IWorkingMemHandle& workingMemHandleRef,
580 const std::vector<TContainer>& inputContainers,
581 std::vector<TContainer>& outputContainers)
582 {
583 for (unsigned int i = 0; i < outputContainers.size(); ++i)
584 {
585 const unsigned int expectedOutputDataSize = GetOutputSize(i);
586
587 mapbox::util::apply_visitor([expectedOutputDataSize, i](auto&& value)
588 {
589 const unsigned int actualOutputDataSize = armnn::numeric_cast<unsigned int>(value.size());
590 if (actualOutputDataSize < expectedOutputDataSize)
591 {
592 unsigned int outputIndex = i;
593 throw armnn::Exception(
594 fmt::format("Not enough data for output #{0}: expected "
595 "{1} elements, got {2}", outputIndex, expectedOutputDataSize, actualOutputDataSize));
596 }
597 },
598 outputContainers[i]);
599 }
600
601 std::shared_ptr<armnn::IProfiler> profiler = m_Runtime->GetProfiler(m_NetworkIdentifier);
602 if (profiler)
603 {
604 profiler->EnableProfiling(m_EnableProfiling);
605 }
606
607 // Start timer to record inference time in EnqueueWorkload (in milliseconds)
608 const auto start_time = armnn::GetTimeNow();
609
610 armnn::Status ret = m_Runtime->Execute(workingMemHandleRef,
611 MakeInputTensors(inputContainers),
612 MakeOutputTensors(outputContainers));
613 auto inferenceID = workingMemHandleRef.GetInferenceId();
614
615 const auto duration = armnn::GetTimeDuration(start_time);
616
617 // if profiling is enabled print out the results
618 if (profiler && profiler->IsProfilingEnabled())
619 {
620 profiler->Print(std::cout);
621 }
622
623 if (ret == armnn::Status::Failure)
624 {
625 throw armnn::Exception(
626 fmt::format("IRuntime::Execute asynchronously failed for network #{0} on inference #{1}",
627 m_NetworkIdentifier, inferenceID));
628 }
629 else
630 {
631 return std::make_tuple(inferenceID, duration);
632 }
633 }
634
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100635 const armnn::BindingPointInfo& GetInputBindingInfo(unsigned int inputIndex = 0u) const
telsoa01c577f2c2018-08-31 09:22:23 +0100636 {
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000637 CheckInputIndexIsValid(inputIndex);
638 return m_InputBindings[inputIndex];
telsoa01c577f2c2018-08-31 09:22:23 +0100639 }
640
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100641 const std::vector<armnn::BindingPointInfo>& GetInputBindingInfos() const
telsoa01c577f2c2018-08-31 09:22:23 +0100642 {
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000643 return m_InputBindings;
telsoa01c577f2c2018-08-31 09:22:23 +0100644 }
645
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100646 const armnn::BindingPointInfo& GetOutputBindingInfo(unsigned int outputIndex = 0u) const
telsoa01c577f2c2018-08-31 09:22:23 +0100647 {
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000648 CheckOutputIndexIsValid(outputIndex);
649 return m_OutputBindings[outputIndex];
650 }
651
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100652 const std::vector<armnn::BindingPointInfo>& GetOutputBindingInfos() const
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000653 {
654 return m_OutputBindings;
655 }
656
657 QuantizationParams GetQuantizationParams(unsigned int outputIndex = 0u) const
658 {
659 CheckOutputIndexIsValid(outputIndex);
660 return std::make_pair(m_OutputBindings[outputIndex].second.GetQuantizationScale(),
661 m_OutputBindings[outputIndex].second.GetQuantizationOffset());
662 }
663
Narumol Prangnawarat4628d052019-02-25 17:26:05 +0000664 QuantizationParams GetInputQuantizationParams(unsigned int inputIndex = 0u) const
665 {
666 CheckInputIndexIsValid(inputIndex);
667 return std::make_pair(m_InputBindings[inputIndex].second.GetQuantizationScale(),
668 m_InputBindings[inputIndex].second.GetQuantizationOffset());
669 }
670
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000671 std::vector<QuantizationParams> GetAllQuantizationParams() const
672 {
673 std::vector<QuantizationParams> quantizationParams;
674 for (unsigned int i = 0u; i < m_OutputBindings.size(); i++)
675 {
676 quantizationParams.push_back(GetQuantizationParams(i));
677 }
678 return quantizationParams;
telsoa01c577f2c2018-08-31 09:22:23 +0100679 }
680
Sadik Armagana04a9d72021-04-27 10:02:10 +0100681 std::unique_ptr<armnn::experimental::IWorkingMemHandle> CreateWorkingMemHandle()
682 {
683 return m_Runtime->CreateWorkingMemHandle(m_NetworkIdentifier);
684 }
685
telsoa014fcda012018-03-09 14:13:49 +0000686private:
telsoa01c577f2c2018-08-31 09:22:23 +0100687 armnn::NetworkId m_NetworkIdentifier;
688 std::shared_ptr<armnn::IRuntime> m_Runtime;
689
Jim Flynnb4d7eae2019-05-01 14:44:27 +0100690 std::vector<armnn::BindingPointInfo> m_InputBindings;
691 std::vector<armnn::BindingPointInfo> m_OutputBindings;
telsoa01c577f2c2018-08-31 09:22:23 +0100692 bool m_EnableProfiling;
Matteo Martincigh00dda4a2019-08-14 11:42:30 +0100693 std::string m_DynamicBackendsPath;
telsoa01c577f2c2018-08-31 09:22:23 +0100694
telsoa014fcda012018-03-09 14:13:49 +0000695 template<typename TContainer>
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000696 armnn::InputTensors MakeInputTensors(const std::vector<TContainer>& inputDataContainers)
telsoa014fcda012018-03-09 14:13:49 +0000697 {
Jim Flynn2fd61002019-05-03 12:54:26 +0100698 return armnnUtils::MakeInputTensors(m_InputBindings, inputDataContainers);
telsoa014fcda012018-03-09 14:13:49 +0000699 }
700
701 template<typename TContainer>
Aron Virginas-Tar7cf0eaa2019-01-24 17:05:36 +0000702 armnn::OutputTensors MakeOutputTensors(std::vector<TContainer>& outputDataContainers)
telsoa014fcda012018-03-09 14:13:49 +0000703 {
Jim Flynn2fd61002019-05-03 12:54:26 +0100704 return armnnUtils::MakeOutputTensors(m_OutputBindings, outputDataContainers);
telsoa014fcda012018-03-09 14:13:49 +0000705 }
Ferran Balaguerc602f292019-02-08 17:09:55 +0000706};