From 6940dd720ebb6b3d1df8ca203ab696daefe58189 Mon Sep 17 00:00:00 2001 From: Jim Flynn Date: Fri, 20 Mar 2020 12:25:56 +0000 Subject: renamed Documentation folder 20.02 and added .nojekyll file Signed-off-by: Jim Flynn --- ...backends_2_i_backend_internal_8hpp_source.xhtml | 160 +++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 20.02/include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml (limited to '20.02/include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml') diff --git a/20.02/include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml b/20.02/include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml new file mode 100644 index 0000000000..0a9aef1fbd --- /dev/null +++ b/20.02/include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml @@ -0,0 +1,160 @@ + + + + + + + + + + + + + +ArmNN: include/armnn/backends/IBackendInternal.hpp Source File + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  20.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
IBackendInternal.hpp
+
+
+Go to the documentation of this file.
1 //
2 // Copyright © 2017 Arm Ltd. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 
6 #pragma once
7 
8 #include <armnn/Types.hpp>
9 #include <armnn/IRuntime.hpp>
10 #include <armnn/Deprecated.hpp>
11 
12 #include <ISubgraphViewConverter.hpp>
13 #include <SubgraphView.hpp>
14 #include <optimizations/Optimization.hpp>
15 
16 #include "IBackendContext.hpp"
17 #include "armnn/backends/profiling/IBackendProfiling.hpp"
18 #include "armnn/backends/profiling/IBackendProfilingContext.hpp"
19 #include "IMemoryManager.hpp"
20 #include "ITensorHandleFactory.hpp"
21 #include "OptimizationViews.hpp"
22 
23 #include <vector>
24 #include <memory>
25 
26 namespace armnn
27 {
28 class IWorkloadFactory;
29 class IMemoryManager;
30 class ILayerSupport;
31 
32 struct BackendVersion
33 {
34  uint32_t m_Major;
35  uint32_t m_Minor;
36 
37  constexpr BackendVersion()
38  : m_Major(0)
39  , m_Minor(0)
40  {}
41  constexpr BackendVersion(uint32_t major, uint32_t minor)
42  : m_Major(major)
43  , m_Minor(minor)
44  {}
45 
46  bool operator==(const BackendVersion& other) const
47  {
48  return this == &other ||
49  (this->m_Major == other.m_Major &&
50  this->m_Minor == other.m_Minor);
51  }
52 
53  bool operator<=(const BackendVersion& other) const
54  {
55  return this->m_Major < other.m_Major ||
56  (this->m_Major == other.m_Major &&
57  this->m_Minor <= other.m_Minor);
58  }
59 };
60 
61 inline std::ostream& operator<<(std::ostream& os, const BackendVersion& backendVersion)
62 {
63  os << "[" << backendVersion.m_Major << "." << backendVersion.m_Minor << "]";
64 
65  return os;
66 }
67 
68 class IBackendInternal : public IBackend
69 {
70 protected:
71  /// Creation must be done through a specific
72  /// backend interface.
73  IBackendInternal() = default;
74 
75 public:
76  /// Allow backends created by the factory function
77  /// to be destroyed through IBackendInternal.
78  ~IBackendInternal() override = default;
79 
80  using IWorkloadFactoryPtr = std::unique_ptr<IWorkloadFactory>;
81  using IBackendContextPtr = std::unique_ptr<IBackendContext>;
82  /// This is the bridge between backend and backend profiling we'll keep it in the backend namespace.
83  using IBackendProfilingContextPtr = std::shared_ptr<armnn::profiling::IBackendProfilingContext>;
84  using IBackendProfilingPtr = std::unique_ptr<armnn::profiling::IBackendProfiling>;
85  using OptimizationPtr = std::unique_ptr<Optimization>;
86  using Optimizations = std::vector<OptimizationPtr>;
87  using ILayerSupportSharedPtr = std::shared_ptr<ILayerSupport>;
88 
89  using IMemoryManagerUniquePtr = std::unique_ptr<IMemoryManager>;
90  using IMemoryManagerSharedPtr = std::shared_ptr<IMemoryManager>;
91 
92  using GraphUniquePtr = std::unique_ptr<Graph>;
93  using SubgraphViewUniquePtr = std::unique_ptr<SubgraphView>;
94 
95  ARMNN_NO_DEPRECATE_WARN_BEGIN
96  using ISubGraphConverterPtr ARMNN_DEPRECATED_MSG("This type is no longer supported")
97  = std::unique_ptr<ISubGraphConverter>;
98  using SubGraphUniquePtr ARMNN_DEPRECATED_MSG("SubGraph is deprecated, use SubgraphView instead")
99  = std::unique_ptr<SubGraph>;
100 
101  ARMNN_DEPRECATED_MSG("This method is no longer supported")
102  virtual ISubGraphConverterPtr CreateSubGraphConverter(const std::shared_ptr<SubGraph>& subGraph) const;
103 
104  ARMNN_DEPRECATED_MSG("Use \"OptimizationViews OptimizeSubgraphView(const SubgraphView&)\" instead")
105  virtual Optimizations GetOptimizations() const;
106 
107  ARMNN_DEPRECATED_MSG("Use \"OptimizationViews OptimizeSubgraphView(const SubgraphView&)\" instead")
108  virtual SubGraphUniquePtr OptimizeSubGraph(const SubGraph& subGraph, bool& optimizationAttempted) const;
109  ARMNN_NO_DEPRECATE_WARN_END
110 
111  virtual IMemoryManagerUniquePtr CreateMemoryManager() const;
112 
113  virtual IWorkloadFactoryPtr CreateWorkloadFactory(
114  const IMemoryManagerSharedPtr& memoryManager = nullptr) const = 0;
115 
116  virtual IWorkloadFactoryPtr CreateWorkloadFactory(
117  class TensorHandleFactoryRegistry& tensorHandleFactoryRegistry) const;
118 
119  /// Create the runtime context of the backend
120  ///
121  /// Implementations may return a default-constructed IBackendContextPtr if
122  /// no context is needed at runtime.
123  /// Implementations must throw BackendUnavailableException if the backend
124  /// cannot be used (for example, necessary accelerator hardware is not present).
125  /// The default implementation always returns a default-constructed pointer.
126  virtual IBackendContextPtr CreateBackendContext(const IRuntime::CreationOptions&) const;
127 
128  /// Create context specifically used for profiling interaction from backends.
129  virtual IBackendProfilingContextPtr CreateBackendProfilingContext(const IRuntime::CreationOptions& creationOptions,
130  IBackendProfilingPtr& backendProfiling);
131 
132  virtual ILayerSupportSharedPtr GetLayerSupport() const = 0;
133 
134  virtual OptimizationViews OptimizeSubgraphView(const SubgraphView& subgraph) const;
135 
136  bool SupportsTensorAllocatorAPI() const;
137 
138  ITensorHandleFactory::FactoryId GetBackwardCompatibleFavoriteHandleFactory();
139 
140  /// (Optional) Returns a vector of supported TensorHandleFactory ids in preference order.
141  virtual std::vector<ITensorHandleFactory::FactoryId> GetHandleFactoryPreferences() const;
142 
143  /// (Optional) Register TensorHandleFactories
144  /// Either this method or CreateMemoryManager() and
145  /// IWorkloadFactory::CreateTensor()/IWorkloadFactory::CreateSubtensor() methods must be implemented.
146  virtual void RegisterTensorHandleFactories(class TensorHandleFactoryRegistry& /*registry*/) {}
147 
148  /// Returns the version of the Backend API
149  static constexpr BackendVersion GetApiVersion() { return BackendVersion(1, 0); }
150 };
151 
152 using IBackendInternalUniquePtr = std::unique_ptr<IBackendInternal>;
153 
154 } // namespace armnn
armnn::IBackendInternal::IWorkloadFactoryPtr
std::unique_ptr< IWorkloadFactory > IWorkloadFactoryPtr
Definition: IBackendInternal.hpp:80
+
armnn::IBackendInternal::Optimizations
std::vector< OptimizationPtr > Optimizations
Definition: IBackendInternal.hpp:86
+ +
armnn::BackendVersion::operator<=
bool operator<=(const BackendVersion &other) const
Definition: IBackendInternal.hpp:53
+ +
armnn::IBackendInternal::OptimizationPtr
std::unique_ptr< Optimization > OptimizationPtr
Definition: IBackendInternal.hpp:85
+
armnn::BackendVersion::BackendVersion
constexpr BackendVersion(uint32_t major, uint32_t minor)
Definition: IBackendInternal.hpp:41
+
ARMNN_NO_DEPRECATE_WARN_BEGIN
#define ARMNN_NO_DEPRECATE_WARN_BEGIN
Definition: Deprecated.hpp:33
+ +
armnn::IBackend
Each backend should implement an IBackend.
Definition: Types.hpp:147
+
armnn::operator<<
std::ostream & operator<<(std::ostream &os, const std::vector< Compute > &compute)
Deprecated function that will be removed together with the Compute enum.
Definition: BackendId.hpp:47
+
IRuntime.hpp
+ +
SubgraphView.hpp
+
armnn
Copyright (c) 2020 ARM Limited.
Definition: 00_introduction.dox:25
+
armnn::IBackendInternal::IMemoryManagerUniquePtr
std::unique_ptr< IMemoryManager > IMemoryManagerUniquePtr
Definition: IBackendInternal.hpp:89
+ +
armnn::IBackendInternal::SubgraphViewUniquePtr
std::unique_ptr< SubgraphView > SubgraphViewUniquePtr
Definition: IBackendInternal.hpp:93
+
armnn::SubgraphView
The SubgraphView class represents a subgraph of a Graph.
Definition: SubgraphView.hpp:23
+ + +
armnn::IBackendInternal::GetApiVersion
static constexpr BackendVersion GetApiVersion()
Returns the version of the Backend API.
Definition: IBackendInternal.hpp:149
+
armnn::IBackendInternal::IBackendProfilingPtr
std::unique_ptr< armnn::profiling::IBackendProfiling > IBackendProfilingPtr
Definition: IBackendInternal.hpp:84
+
armnn::FactoryId
ITensorHandleFactory::FactoryId FactoryId
Definition: ClTensorHandleFactory.cpp:20
+
ARMNN_NO_DEPRECATE_WARN_END
#define ARMNN_NO_DEPRECATE_WARN_END
Definition: Deprecated.hpp:34
+
armnn::IBackendInternal::IMemoryManagerSharedPtr
std::shared_ptr< IMemoryManager > IMemoryManagerSharedPtr
Definition: IBackendInternal.hpp:90
+
Types.hpp
+
IBackendProfilingContext.hpp
+ +
ISubgraphViewConverter.hpp
+ + +
armnn::BackendVersion::operator==
bool operator==(const BackendVersion &other) const
Definition: IBackendInternal.hpp:46
+
armnn::IBackendInternal::ILayerSupportSharedPtr
std::shared_ptr< ILayerSupport > ILayerSupportSharedPtr
Definition: IBackendInternal.hpp:87
+
Deprecated.hpp
+
armnn::IBackendInternal::instead
std::unique_ptr< SubGraph > instead
Definition: IBackendInternal.hpp:99
+
IBackendProfiling.hpp
+ + +
ARMNN_DEPRECATED_MSG
#define ARMNN_DEPRECATED_MSG(message)
Definition: Deprecated.hpp:43
+
armnn::IBackendInternal::GraphUniquePtr
std::unique_ptr< Graph > GraphUniquePtr
Definition: IBackendInternal.hpp:92
+
armnn::IBackendInternalUniquePtr
std::unique_ptr< IBackendInternal > IBackendInternalUniquePtr
Definition: BackendRegistry.hpp:18
+
Optimization.hpp
+ + +
armnn::IBackendInternal::IBackendProfilingContextPtr
std::shared_ptr< armnn::profiling::IBackendProfilingContext > IBackendProfilingContextPtr
This is the bridge between backend and backend profiling we&#39;ll keep it in the backend namespace...
Definition: IBackendInternal.hpp:83
+
armnn::IBackendInternal::IBackendContextPtr
std::unique_ptr< IBackendContext > IBackendContextPtr
Definition: IBackendInternal.hpp:81
+
+
+ + + + -- cgit v1.2.1