patch/23.02/include_2armnn_2backends_2_optimization_views_8hpp_source.xhtml

 //
 // Copyright © 2017, 2019, 2021-2022 Arm Ltd and Contributors. All rights reserved.
 // SPDX-License-Identifier: MIT
 //

 #pragma once

 #include <armnn/BackendOptions.hpp>
 #include <armnn/Deprecated.hpp>
 #include <armnn/INetwork.hpp>
 #include <armnn/backends/SubgraphView.hpp>
 #include <vector>
 #include "Graph.hpp"

 namespace armnn
 {

 class OptimizationViews
 {
 public:
     OptimizationViews(const NetworkOptions& networkOptions = {}) : m_INetwork(INetwork::Create(networkOptions)) {}
     OptimizationViews(const OptimizationViews&) = delete;
     OptimizationViews& operator=(const OptimizationViews&) = delete;
     OptimizationViews(OptimizationViews&&) = default;
     OptimizationViews& operator=(OptimizationViews&&) = default;

     struct SubstitutionPair
     {
         /// Subgraph of Layers from the original graph which should be replaced
         SubgraphView m_SubstitutableSubgraph;

         /// A subgraph of new layers which will replace layers in m_SubstitutableSubgraph
         SubgraphView m_ReplacementSubgraph;
     };

     using Subgraphs = std::vector<SubgraphView>;
     using Substitutions = std::vector<SubstitutionPair>;

     void AddSubstitution(SubstitutionPair&& substitution)
     {
         m_SuccesfulOptimizations.emplace_back(substitution);
     }

     void AddFailedSubgraph(SubgraphView&& subgraph)
     {
         m_FailedOptimizations.emplace_back(subgraph);
     }

     void AddUntouchedSubgraph(SubgraphView&& subgraph)
     {
         m_UntouchedSubgraphs.emplace_back(subgraph);
     }

     const Substitutions& GetSubstitutions() const { return m_SuccesfulOptimizations; }
     const Subgraphs& GetFailedSubgraphs() const { return m_FailedOptimizations; }
     const Subgraphs& GetUntouchedSubgraphs() const { return m_UntouchedSubgraphs; }

     Substitutions& GetSubstitutions() { return m_SuccesfulOptimizations; }
     Subgraphs& GetFailedSubgraphs() { return m_FailedOptimizations; }
     Subgraphs& GetUntouchedSubgraphs() { return m_UntouchedSubgraphs; }

     bool Validate(const SubgraphView& originalSubgraph) const;

     ARMNN_DEPRECATED_MSG_REMOVAL_DATE("GetGraph is deprecated. Use GetINetwork instead.", "23.08")
     Graph& GetGraph() { return m_Graph; }

     INetwork* GetINetwork() { return m_INetwork.get(); }
     INetwork& GetINetworkRef() { return *m_INetwork; }

 private:
     Substitutions m_SuccesfulOptimizations;     ///< Proposed substitutions from successful optimizations
     Subgraphs m_FailedOptimizations;            ///< Subgraphs from the original subgraph which cannot be supported
     Subgraphs m_UntouchedSubgraphs;             ///< Subgraphs from the original subgraph which remain unmodified

     /// Graph object used only as a container for any layer generated by the optimization process
     Graph m_Graph;

     /// INetworkPtr object used only as a container for any layer generated by the optimization process
     /// Also, can use to AddPrecompiledLayer to the SubstitutionPair
     /// Use in favour of m_Graph which depreciates in 23.08
     INetworkPtr m_INetwork = INetwork::Create();
 };

 } //namespace armnn
armnn::INetwork::Create
static INetworkPtr Create(const NetworkOptions &networkOptions={})
Definition: Network.cpp:452

-armnn::OptimizationViews::OptimizationViews
OptimizationViews(const NetworkOptions &networkOptions={})
Definition: OptimizationViews.hpp:21

-armnn::OptimizationViews::GetINetwork
INetwork * GetINetwork()
Definition: OptimizationViews.hpp:67

-armnn::OptimizationViews::GetUntouchedSubgraphs
Subgraphs & GetUntouchedSubgraphs()
Definition: OptimizationViews.hpp:60

-armnn::OptimizationViews::AddSubstitution
void AddSubstitution(SubstitutionPair &&substitution)
Definition: OptimizationViews.hpp:39

-armnn::INetwork
Main network class which provides the interface for building up a neural network. ...
Definition: INetwork.hpp:260

-armnn::OptimizationViews
Definition: OptimizationViews.hpp:18

-SubgraphView.hpp

-armnn::NetworkOptions
std::vector< BackendOptions > NetworkOptions
Definition: BackendOptions.hpp:16

-armnn::OptimizationViews::Subgraphs
std::vector< SubgraphView > Subgraphs
Definition: OptimizationViews.hpp:36

-armnn::OptimizationViews::operator=
OptimizationViews & operator=(const OptimizationViews &)=delete

-armnn::OptimizationViews::Substitutions
std::vector< SubstitutionPair > Substitutions
Definition: OptimizationViews.hpp:37

-armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6

-armnn::OptimizationViews::SubstitutionPair::m_SubstitutableSubgraph
SubgraphView m_SubstitutableSubgraph
Subgraph of Layers from the original graph which should be replaced.
Definition: OptimizationViews.hpp:30

-armnn::OptimizationViews::GetINetworkRef
INetwork & GetINetworkRef()
Definition: OptimizationViews.hpp:68

-BackendOptions.hpp

-armnn::SubgraphView
The SubgraphView class represents a subgraph of a Graph.
Definition: SubgraphView.hpp:31

-armnn::OptimizationViews::SubstitutionPair
Definition: OptimizationViews.hpp:27

-Graph.hpp

-armnn::OptimizationViews::GetUntouchedSubgraphs
const Subgraphs & GetUntouchedSubgraphs() const
Definition: OptimizationViews.hpp:56

-armnn::OptimizationViews::GetFailedSubgraphs
const Subgraphs & GetFailedSubgraphs() const
Definition: OptimizationViews.hpp:55

-armnn::OptimizationViews::AddFailedSubgraph
void AddFailedSubgraph(SubgraphView &&subgraph)
Definition: OptimizationViews.hpp:44

-armnn::OptimizationViews::SubstitutionPair::m_ReplacementSubgraph
SubgraphView m_ReplacementSubgraph
A subgraph of new layers which will replace layers in m_SubstitutableSubgraph.
Definition: OptimizationViews.hpp:33

-armnn::OptimizationViews::Validate
bool Validate(const SubgraphView &originalSubgraph) const
Definition: OptimizationViews.cpp:11

-armnn::OptimizationViews::AddUntouchedSubgraph
void AddUntouchedSubgraph(SubgraphView &&subgraph)
Definition: OptimizationViews.hpp:49

-armnn::Graph
Definition: Graph.hpp:30

-INetwork.hpp

-ARMNN_DEPRECATED_MSG_REMOVAL_DATE
#define ARMNN_DEPRECATED_MSG_REMOVAL_DATE(message, removed_in_release)
Definition: Deprecated.hpp:44

-armnn::OptimizationViews::GetSubstitutions
const Substitutions & GetSubstitutions() const
Definition: OptimizationViews.hpp:54

-Deprecated.hpp

-armnn::OptimizationViews::GetSubstitutions
Substitutions & GetSubstitutions()
Definition: OptimizationViews.hpp:58

-armnn::OptimizationViews::GetGraph
Graph & GetGraph()
Definition: OptimizationViews.hpp:65

-armnn::INetworkPtr
std::unique_ptr< INetwork, void(*)(INetwork *network)> INetworkPtr
Definition: INetwork.hpp:252

-armnn::OptimizationViews::GetFailedSubgraphs
Subgraphs & GetFailedSubgraphs()
Definition: OptimizationViews.hpp:59

+Go to the documentation of this file. //

+ // Copyright © 2017, 2019, 2021-2022 Arm Ltd and Contributors. All rights reserved.

+ // SPDX-License-Identifier: MIT

+ //

+

+ #pragma once

+

+ #include <armnn/BackendOptions.hpp>

+ #include <armnn/Deprecated.hpp>

+ #include <armnn/INetwork.hpp>

+ #include <armnn/backends/SubgraphView.hpp>

+ #include <vector>

+ #include "Graph.hpp"

+

+ namespace armnn

+ {

+

+ class OptimizationViews

+ {

+ public:

+     OptimizationViews(const NetworkOptions& networkOptions = {}) : m_INetwork(INetwork::Create(networkOptions)) {}

+     OptimizationViews(const OptimizationViews&) = delete;

+     OptimizationViews& operator=(const OptimizationViews&) = delete;

+     OptimizationViews(OptimizationViews&&) = default;

+     OptimizationViews& operator=(OptimizationViews&&) = default;

+

+     struct SubstitutionPair

+     {

+         /// Subgraph of Layers from the original graph which should be replaced

+         SubgraphView m_SubstitutableSubgraph;

+

+         /// A subgraph of new layers which will replace layers in m_SubstitutableSubgraph

+         SubgraphView m_ReplacementSubgraph;

+     };

+

+     using Subgraphs = std::vector<SubgraphView>;

+     using Substitutions = std::vector<SubstitutionPair>;

+

+     void AddSubstitution(SubstitutionPair&& substitution)

+     {

+         m_SuccesfulOptimizations.emplace_back(substitution);

+     }

+

+     void AddFailedSubgraph(SubgraphView&& subgraph)

+     {

+         m_FailedOptimizations.emplace_back(subgraph);

+     }

+

+     void AddUntouchedSubgraph(SubgraphView&& subgraph)

+     {

+         m_UntouchedSubgraphs.emplace_back(subgraph);

+     }

+

+     const Substitutions& GetSubstitutions() const { return m_SuccesfulOptimizations; }

+     const Subgraphs& GetFailedSubgraphs() const { return m_FailedOptimizations; }

+     const Subgraphs& GetUntouchedSubgraphs() const { return m_UntouchedSubgraphs; }

+

+     Substitutions& GetSubstitutions() { return m_SuccesfulOptimizations; }

+     Subgraphs& GetFailedSubgraphs() { return m_FailedOptimizations; }

+     Subgraphs& GetUntouchedSubgraphs() { return m_UntouchedSubgraphs; }

+

+     bool Validate(const SubgraphView& originalSubgraph) const;

+

+     ARMNN_DEPRECATED_MSG_REMOVAL_DATE("GetGraph is deprecated. Use GetINetwork instead.", "23.08")

+     Graph& GetGraph() { return m_Graph; }

+

+     INetwork* GetINetwork() { return m_INetwork.get(); }

+     INetwork& GetINetworkRef() { return *m_INetwork; }

+

+ private:

+     Substitutions m_SuccesfulOptimizations;     ///< Proposed substitutions from successful optimizations

+     Subgraphs m_FailedOptimizations;            ///< Subgraphs from the original subgraph which cannot be supported

+     Subgraphs m_UntouchedSubgraphs;             ///< Subgraphs from the original subgraph which remain unmodified

+

+     /// Graph object used only as a container for any layer generated by the optimization process

+     Graph m_Graph;

+

+     /// INetworkPtr object used only as a container for any layer generated by the optimization process

+     /// Also, can use to AddPrecompiledLayer to the SubstitutionPair

+     /// Use in favour of m_Graph which depreciates in 23.08

+     INetworkPtr m_INetwork = INetwork::Create();

+ };

+

+ } //namespace armnn