xref: /aosp_15_r20/external/armnn/src/armnn/layers/LstmLayer.hpp (revision 89c4ff92f2867872bb9e2354d150bf0c8c502810)
1 //
2 // Copyright © 2017 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
7 #include "LayerWithParameters.hpp"
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 
20     LstmBasicParameters m_BasicParameters;
21     LstmOptCifgParameters m_CifgParameters;
22     LstmOptProjectionParameters m_ProjectionParameters;
23     LstmOptPeepholeParameters m_PeepholeParameters;
24     LstmOptLayerNormParameters m_LayerNormParameters;
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.
60     Layer::ImmutableConstantTensors GetConstantTensorsByRef() const override;
61 };
62 
63 } // namespace
64