ArmNN
 24.08
SoftmaxLayer.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 
9 namespace armnn
10 {
11 
12 /// This layer represents a softmax operation.
13 class SoftmaxLayer : public LayerWithParameters<SoftmaxDescriptor>
14 {
15 public:
16  /// Makes a workload for the Softmax 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  SoftmaxLayer* Clone(Graph& graph) const override;
25 
26  /// Check if the input tensor shape(s)
27  /// will lead to a valid configuration of @ref SoftmaxLayer.
28  /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
29  void ValidateTensorShapesFromInputs() override;
30 
31  void ExecuteStrategy(IStrategy& strategy) const override;
32 
33 
34 protected:
35  /// Constructor to create a SoftmaxLayer.
36  /// @param [in] param SoftmaxDescriptor to configure the softmax operation.
37  /// @param [in] name Optional name for the layer.
38  SoftmaxLayer(const SoftmaxDescriptor& param, const char* name);
39 
40  /// Default destructor
41  ~SoftmaxLayer() = default;
42 };
43 
44 } // namespace
armnn::IStrategy
Definition: IStrategy.hpp:16
armnn::SoftmaxLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Softmax type.
Definition: SoftmaxLayer.cpp:21
armnn::LayerWithParameters
Definition: LayerWithParameters.hpp:14
armnn::SoftmaxLayer::ExecuteStrategy
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
Definition: SoftmaxLayer.cpp:54
armnn::IWorkloadFactory
Definition: WorkloadFactory.hpp:22
armnn::SoftmaxLayer::Clone
SoftmaxLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: SoftmaxLayer.cpp:29
LayerWithParameters.hpp
armnn::SoftmaxLayer::SoftmaxLayer
SoftmaxLayer(const SoftmaxDescriptor &param, const char *name)
Constructor to create a SoftmaxLayer.
Definition: SoftmaxLayer.cpp:16
armnn::SoftmaxLayer::~SoftmaxLayer
~SoftmaxLayer()=default
Default destructor.
armnn::SoftmaxLayer
This layer represents a softmax operation.
Definition: SoftmaxLayer.hpp:13
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
armnn::SoftmaxLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of SoftmaxLayer.
Definition: SoftmaxLayer.cpp:34
armnn::Graph
Definition: Graph.hpp:30
armnn::SoftmaxDescriptor
A SoftmaxDescriptor for the SoftmaxLayer.
Definition: Descriptors.hpp:177