ArmNN
 24.08
BatchMatMulLayer.hpp
Go to the documentation of this file.
1 //
2 // Copyright © 2022 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 
6 #pragma once
7 
9 
10 namespace armnn
11 {
12 
13 class BatchMatMulLayer : public LayerWithParameters<BatchMatMulDescriptor>
14 {
15 public:
16  /// Makes a workload for the BatchMatMul type.
17  /// @param [in] graph The graph where this layer can be found.
18  /// @param [in] factory The workload factory which will create the workload.
19  /// @return A pointer to the created workload, or nullptr if not created.
20  virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory &factory) const override;
21 
22  /// Creates a dynamically-allocated copy of this layer.
23  /// @param [in] graph The graph into which this layer is being cloned.
24  BatchMatMulLayer* Clone(Graph &graph) const override;
25 
26  /// Infers the output shape from the given input shapes.
27  /// @param [in] inputShapes The vector of input shapes for BatchMatMul.
28  /// @return A vector of inferred output shape.
29  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
30 
31  /// Check if the input tensor shapes
32  /// will lead to a valid configuration of @ref BatchMatMulLayer.
33  /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
34  void ValidateTensorShapesFromInputs() override;
35 
36 protected:
37  /// Constructor to create a BatchMatMulLayer.
38  /// @param [in] param BatchMatMulDescriptor to configure optional parameters for batch matrix multiplication
39  /// @param [in] name Optional name for the layer
40  BatchMatMulLayer(const BatchMatMulDescriptor& param, const char* name);
41 
42  /// Default destructor
43  ~BatchMatMulLayer() = default;
44 };
45 
46 }
armnn::BatchMatMulLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shapes will lead to a valid configuration of BatchMatMulLayer.
Definition: BatchMatMulLayer.cpp:97
armnn::BatchMatMulLayer::Clone
BatchMatMulLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: BatchMatMulLayer.cpp:26
armnn::LayerWithParameters
Definition: LayerWithParameters.hpp:14
armnn::IWorkloadFactory
Definition: WorkloadFactory.hpp:22
armnn::BatchMatMulLayer::InferOutputShapes
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
Infers the output shape from the given input shapes.
Definition: BatchMatMulLayer.cpp:33
armnn::BatchMatMulLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the BatchMatMul type.
Definition: BatchMatMulLayer.cpp:18
armnn::BatchMatMulDescriptor
A BatchMatMulDescriptor for the BatchMatMul operator.
Definition: Descriptors.hpp:1584
LayerWithParameters.hpp
armnn::BatchMatMulLayer
Definition: BatchMatMulLayer.hpp:13
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
armnn::BatchMatMulLayer::BatchMatMulLayer
BatchMatMulLayer(const BatchMatMulDescriptor &param, const char *name)
Constructor to create a BatchMatMulLayer.
Definition: BatchMatMulLayer.cpp:14
armnn::BatchMatMulLayer::~BatchMatMulLayer
~BatchMatMulLayer()=default
Default destructor.
armnn::Graph
Definition: Graph.hpp:30