Sadik Armagan | 3c24f43 | 2020-10-19 17:35:30 +0100 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2020 Arm Ltd and Contributors. All rights reserved. |
| 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | |
| 6 | #pragma once |
| 7 | |
| 8 | #include <armnn/ArmNN.hpp> |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 9 | #include <armnn/Logging.hpp> |
| 10 | #include <armnn/Optional.hpp> |
Sadik Armagan | 3c24f43 | 2020-10-19 17:35:30 +0100 | [diff] [blame] | 11 | |
| 12 | #include <set> |
| 13 | #include <string> |
| 14 | #include <vector> |
| 15 | |
| 16 | namespace armnnDelegate |
| 17 | { |
| 18 | |
| 19 | class DelegateOptions |
| 20 | { |
| 21 | public: |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 22 | DelegateOptions(armnn::Compute computeDevice, |
| 23 | const std::vector<armnn::BackendOptions>& backendOptions = {}, |
| 24 | armnn::Optional<armnn::LogSeverity> logSeverityLevel = armnn::EmptyOptional()); |
Sadik Armagan | 3c24f43 | 2020-10-19 17:35:30 +0100 | [diff] [blame] | 25 | |
Sadik Armagan | 4189cc5 | 2020-11-11 18:01:48 +0000 | [diff] [blame] | 26 | DelegateOptions(const std::vector<armnn::BackendId>& backends, |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 27 | const std::vector<armnn::BackendOptions>& backendOptions = {}, |
| 28 | armnn::Optional<armnn::LogSeverity> logSeverityLevel = armnn::EmptyOptional()); |
Sadik Armagan | 3c24f43 | 2020-10-19 17:35:30 +0100 | [diff] [blame] | 29 | |
Narumol Prangnawarat | 0b51d5a | 2021-01-20 15:58:29 +0000 | [diff] [blame^] | 30 | DelegateOptions(armnn::Compute computeDevice, |
| 31 | const armnn::OptimizerOptions& optimizerOptions, |
| 32 | const armnn::INetworkProperties& networkProperties = armnn::INetworkProperties(), |
| 33 | const armnn::Optional<armnn::LogSeverity>& logSeverityLevel = armnn::EmptyOptional(), |
| 34 | const armnn::Optional<armnn::DebugCallbackFunction>& func = armnn::EmptyOptional()); |
| 35 | |
| 36 | DelegateOptions(const std::vector<armnn::BackendId>& backends, |
| 37 | const armnn::OptimizerOptions& optimizerOptions, |
| 38 | const armnn::INetworkProperties& networkProperties = armnn::INetworkProperties(), |
| 39 | const armnn::Optional<armnn::LogSeverity>& logSeverityLevel = armnn::EmptyOptional(), |
| 40 | const armnn::Optional<armnn::DebugCallbackFunction>& func = armnn::EmptyOptional()); |
| 41 | |
Sadik Armagan | 3c24f43 | 2020-10-19 17:35:30 +0100 | [diff] [blame] | 42 | const std::vector<armnn::BackendId>& GetBackends() const { return m_Backends; } |
| 43 | |
| 44 | void SetBackends(const std::vector<armnn::BackendId>& backends) { m_Backends = backends; } |
| 45 | |
Sadik Armagan | 4189cc5 | 2020-11-11 18:01:48 +0000 | [diff] [blame] | 46 | const std::vector<armnn::BackendOptions>& GetBackendOptions() const { return m_BackendOptions; } |
| 47 | |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 48 | /// Appends a backend option to the list of backend options |
| 49 | void AddBackendOption(const armnn::BackendOptions& option) { m_BackendOptions.push_back(option); } |
| 50 | |
| 51 | /// Sets the severity level for logging within ArmNN that will be used on creation of the delegate |
| 52 | void SetLoggingSeverity(const armnn::LogSeverity& level) { m_LoggingSeverity = level; } |
| 53 | void SetLoggingSeverity(const std::string& level) { m_LoggingSeverity = armnn::StringToLogLevel(level); } |
| 54 | |
| 55 | /// Returns the severity level for logging within ArmNN |
| 56 | armnn::LogSeverity GetLoggingSeverity() { return m_LoggingSeverity.value(); } |
| 57 | |
| 58 | bool IsLoggingEnabled() { return m_LoggingSeverity.has_value(); } |
| 59 | |
Narumol Prangnawarat | 0b51d5a | 2021-01-20 15:58:29 +0000 | [diff] [blame^] | 60 | const armnn::OptimizerOptions& GetOptimizerOptions() const { return m_OptimizerOptions; } |
| 61 | |
| 62 | const armnn::Optional<armnn::DebugCallbackFunction>& GetDebugCallbackFunction() const |
| 63 | { return m_DebugCallbackFunc; } |
| 64 | |
| 65 | const armnn::INetworkProperties& GetNetworkProperties() const { return m_NetworkProperties; }; |
| 66 | |
Sadik Armagan | 3c24f43 | 2020-10-19 17:35:30 +0100 | [diff] [blame] | 67 | private: |
| 68 | /// Which backend to run Delegate on. |
| 69 | /// Examples of possible values are: CpuRef, CpuAcc, GpuAcc. |
| 70 | /// CpuRef as default. |
| 71 | std::vector<armnn::BackendId> m_Backends = { armnn::Compute::CpuRef }; |
Sadik Armagan | 4189cc5 | 2020-11-11 18:01:48 +0000 | [diff] [blame] | 72 | |
| 73 | /// Pass backend specific options to Delegate |
| 74 | /// |
| 75 | /// For example, tuning can be enabled on GpuAcc like below |
| 76 | /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 77 | /// m_BackendOptions.emplace_back( |
| 78 | /// BackendOptions{"GpuAcc", |
| 79 | /// { |
| 80 | /// {"TuningLevel", 2}, |
| 81 | /// {"TuningFile", filename} |
| 82 | /// } |
| 83 | /// }); |
| 84 | /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 85 | /// The following backend options are available: |
| 86 | /// GpuAcc: |
| 87 | /// "TuningLevel" : int [0..3] (0=UseOnly(default) | 1=RapidTuning | 2=NormalTuning | 3=ExhaustiveTuning) |
| 88 | /// "TuningFile" : string [filenameString] |
| 89 | /// "KernelProfilingEnabled" : bool [true | false] |
| 90 | std::vector<armnn::BackendOptions> m_BackendOptions; |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 91 | |
Narumol Prangnawarat | 0b51d5a | 2021-01-20 15:58:29 +0000 | [diff] [blame^] | 92 | /// OptimizerOptions |
| 93 | /// Reduce Fp32 data to Fp16 for faster processing |
| 94 | /// bool m_ReduceFp32ToFp16; |
| 95 | /// Add debug data for easier troubleshooting |
| 96 | /// bool m_Debug; |
| 97 | /// Reduce Fp32 data to Bf16 for faster processing |
| 98 | /// bool m_ReduceFp32ToBf16; |
| 99 | /// Infer output size when not available |
| 100 | /// ShapeInferenceMethod m_shapeInferenceMethod; |
| 101 | /// Enable Import |
| 102 | /// bool m_ImportEnabled; |
| 103 | /// Enable Model Options |
| 104 | /// ModelOptions m_ModelOptions; |
| 105 | armnn::OptimizerOptions m_OptimizerOptions; |
| 106 | |
| 107 | /// Network properties to enable memory import |
| 108 | armnn::INetworkProperties m_NetworkProperties; |
| 109 | |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 110 | /// Severity level for logging within ArmNN that will be used on creation of the delegate |
| 111 | armnn::Optional<armnn::LogSeverity> m_LoggingSeverity; |
Narumol Prangnawarat | 0b51d5a | 2021-01-20 15:58:29 +0000 | [diff] [blame^] | 112 | |
| 113 | /// A callback function to debug layers performing custom computations on intermediate tensors. |
| 114 | /// If a function is not registered, and debug is enabled in OptimizerOptions, |
| 115 | /// debug will print information of the intermediate tensors. |
| 116 | armnn::Optional<armnn::DebugCallbackFunction> m_DebugCallbackFunc; |
Sadik Armagan | 3c24f43 | 2020-10-19 17:35:30 +0100 | [diff] [blame] | 117 | }; |
| 118 | |
| 119 | } // namespace armnnDelegate |