ArmNN
 24.08
LstmLayer.hpp
Go to the documentation of this file.
1 //
2 // Copyright © 2017 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
8 #include "LstmParameters.hpp"
9 
10 namespace armnn
11 {
12 
13 class ScopedTensorHandle;
14 
15 /// This layer represents a LSTM operation.
16 class LstmLayer : public LayerWithParameters<LstmDescriptor>
17 {
18 public:
19 
25 
26  /// Makes a workload for the LSTM type.
27  /// @param [in] graph The graph where this layer can be found.
28  /// @param [in] factory The workload factory which will create the workload.
29  /// @return A pointer to the created workload, or nullptr if not created.
30  virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;
31 
32  /// Creates a dynamically-allocated copy of this layer.
33  /// @param [in] graph The graph into which this layer is being cloned.
34  LstmLayer* Clone(Graph& graph) const override;
35 
36  /// Check if the input tensor shape(s)
37  /// will lead to a valid configuration of @ref LstmLayer.
38  /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
39  void ValidateTensorShapesFromInputs() override;
40 
41  /// By default returns inputShapes if the number of inputs are equal to number of outputs,
42  /// otherwise infers the output shapes from given input shapes and layer properties.
43  /// @param [in] inputShapes The input shapes layer has.
44  /// @return A vector to the inferred output shape.
45  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
46 
47  void ExecuteStrategy(IStrategy& strategy) const override;
48 
49 protected:
50  /// Constructor to create a LstmLayer.
51  /// @param [in] param LstmDescriptor to configure the lstm operation.
52  /// @param [in] name Optional name for the layer.
53  LstmLayer(const LstmDescriptor& param, const char* name);
54 
55  /// Default destructor
56  ~LstmLayer() = default;
57 
58  /// Retrieve the handles to the constant values stored by the layer.
59  /// @return A vector of the constant tensors stored by this layer.
61 };
62 
63 } // namespace
armnn::LstmLayer::m_ProjectionParameters
LstmOptProjectionParameters m_ProjectionParameters
Definition: LstmLayer.hpp:22
armnn::LstmLayer::Clone
LstmLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: LstmLayer.cpp:80
armnn::LstmLayer::m_LayerNormParameters
LstmOptLayerNormParameters m_LayerNormParameters
Definition: LstmLayer.hpp:24
armnn::LstmLayer::ExecuteStrategy
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
Definition: LstmLayer.cpp:402
LstmParameters.hpp
armnn::LstmLayer::GetConstantTensorsByRef
Layer::ImmutableConstantTensors GetConstantTensorsByRef() const override
Retrieve the handles to the constant values stored by the layer.
Definition: LstmLayer.cpp:368
armnn::LstmOptProjectionParameters
Definition: LstmParameters.hpp:36
armnn::IStrategy
Definition: IStrategy.hpp:16
armnn::LstmLayer::m_CifgParameters
LstmOptCifgParameters m_CifgParameters
Definition: LstmLayer.hpp:21
armnn::LayerWithParameters
Definition: LayerWithParameters.hpp:14
armnn::LstmLayer::~LstmLayer
~LstmLayer()=default
Default destructor.
armnn::IConnectableLayer::ImmutableConstantTensors
std::vector< std::reference_wrapper< const std::shared_ptr< ConstTensorHandle > >> ImmutableConstantTensors
Definition: INetwork.hpp:141
armnn::LstmLayer
This layer represents a LSTM operation.
Definition: LstmLayer.hpp:16
armnn::LstmBasicParameters
Definition: LstmParameters.hpp:54
armnn::LstmOptPeepholeParameters
Definition: LstmParameters.hpp:44
armnn::IWorkloadFactory
Definition: WorkloadFactory.hpp:22
armnn::LstmLayer::LstmLayer
LstmLayer(const LstmDescriptor &param, const char *name)
Constructor to create a LstmLayer.
Definition: LstmLayer.cpp:17
armnn::LstmOptLayerNormParameters
Definition: LstmParameters.hpp:14
LayerWithParameters.hpp
armnn::LstmLayer::m_BasicParameters
LstmBasicParameters m_BasicParameters
Definition: LstmLayer.hpp:20
armnn::LstmDescriptor
An LstmDescriptor for the LstmLayer.
Definition: Descriptors.hpp:1102
armnn::LstmLayer::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: LstmLayer.cpp:150
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
armnn::LstmLayer::m_PeepholeParameters
LstmOptPeepholeParameters m_PeepholeParameters
Definition: LstmLayer.hpp:23
armnn::LstmLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of LstmLayer.
Definition: LstmLayer.cpp:172
armnn::LstmOptCifgParameters
Definition: LstmParameters.hpp:26
armnn::Graph
Definition: Graph.hpp:30
armnn::LstmLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the LSTM type.
Definition: LstmLayer.cpp:22