ArmNN
 24.02
Convolution2dLayer.hpp
Go to the documentation of this file.
1 //
2 // Copyright © 2017,2022 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
8 
9 namespace armnn
10 {
11 
12 class ScopedTensorHandle;
13 
14 /// This layer represents a convolution 2d operation.
15 class Convolution2dLayer : public LayerWithParameters<Convolution2dDescriptor>
16 {
17 public:
18 
19  /// Makes a workload for the Convolution2d type.
20  /// @param [in] graph The graph where this layer can be found.
21  /// @param [in] factory The workload factory which will create the workload.
22  /// @return A pointer to the created workload, or nullptr if not created.
23  virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;
24 
25  /// Creates a dynamically-allocated copy of this layer.
26  /// @param [in] graph The graph into which this layer is being cloned.
27  Convolution2dLayer* Clone(Graph& graph) const override;
28 
29  /// Check if the input tensor shape(s)
30  /// will lead to a valid configuration of @ref Convolution2dLayer.
31  /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
32  void ValidateTensorShapesFromInputs() override;
33 
34  /// By default returns inputShapes if the number of inputs are equal to number of outputs,
35  /// otherwise infers the output shapes from given input shapes and layer properties.
36  /// @param [in] inputShapes The input shapes layer has.
37  /// @return A vector to the inferred output shape.
38  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
39 
40  void ExecuteStrategy(IStrategy& strategy) const override;
41 
43 
44  /// This layer does not have any data stored, weights and bias are now stored in constant layers.
45  /// We do not want to release the data in the constant layer, that is why we override with an empty function.
46  void ReleaseConstantData() override {}
47 
48 protected:
49  /// Constructor to create a Convolution2dLayer.
50  /// @param [in] param Convolution2dDescriptor to configure the convolution2d operation.
51  /// @param [in] name Optional name for the layer.
52  Convolution2dLayer(const Convolution2dDescriptor& param, const char* name);
53 
54  /// Default destructor
55  ~Convolution2dLayer() = default;
56 
57  /// Retrieve the handles to the constant values connected to the layer.
58  /// @return A vector of the constant tensors connected to the layer.
60 };
61 
62 } // namespace
armnn::Convolution2dLayer::SerializeLayerParameters
void SerializeLayerParameters(ParameterStringifyFunction &fn) const override
Helper to serialize the layer parameters to string.
Definition: Convolution2dLayer.cpp:29
armnn::Convolution2dLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of Convolution2dLayer.
Definition: Convolution2dLayer.cpp:102
armnn::IStrategy
Definition: IStrategy.hpp:16
armnn::LayerWithParameters
Definition: LayerWithParameters.hpp:14
armnn::Convolution2dLayer
This layer represents a convolution 2d operation.
Definition: Convolution2dLayer.hpp:15
armnn::IConnectableLayer::ImmutableConstantTensors
std::vector< std::reference_wrapper< const std::shared_ptr< ConstTensorHandle > >> ImmutableConstantTensors
Definition: INetwork.hpp:141
armnn::Convolution2dLayer::~Convolution2dLayer
~Convolution2dLayer()=default
Default destructor.
armnn::Convolution2dLayer::ReleaseConstantData
void ReleaseConstantData() override
This layer does not have any data stored, weights and bias are now stored in constant layers.
Definition: Convolution2dLayer.hpp:46
armnn::Convolution2dLayer::GetConstantTensorsByRef
ImmutableConstantTensors GetConstantTensorsByRef() const override
Retrieve the handles to the constant values connected to the layer.
Definition: Convolution2dLayer.cpp:122
armnn::IWorkloadFactory
Definition: WorkloadFactory.hpp:22
armnn::ParameterStringifyFunction
std::function< void(const std::string &name, const std::string &value)> ParameterStringifyFunction
Definition: SerializeLayerParameters.hpp:14
armnn::Convolution2dLayer::Convolution2dLayer
Convolution2dLayer(const Convolution2dDescriptor &param, const char *name)
Constructor to create a Convolution2dLayer.
Definition: Convolution2dLayer.cpp:23
LayerWithParameters.hpp
armnn::Convolution2dDescriptor
A Convolution2dDescriptor for the Convolution2dLayer.
Definition: Descriptors.hpp:534
armnn::Convolution2dLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Convolution2d type.
Definition: Convolution2dLayer.cpp:49
armnn::Convolution2dLayer::InferOutputShapes
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
By default returns inputShapes if the number of inputs are equal to number of outputs,...
Definition: Convolution2dLayer.cpp:64
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
armnn::Convolution2dLayer::Clone
Convolution2dLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: Convolution2dLayer.cpp:58
armnn::Graph
Definition: Graph.hpp:30
armnn::Convolution2dLayer::ExecuteStrategy
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
Definition: Convolution2dLayer.cpp:128