Softmax Layer node. More...

#include <SoftmaxLayerNode.h>

Collaboration diagram for SoftmaxLayerNode:

Public Member Functions
	SoftmaxLayerNode (float beta=1.f)
	Constructor. More...

float	beta () const
	Beta parameter accessor. More...

NodeType	type () const override
	Returns node's type. More...

bool	forward_descriptors () override
	Forwards descriptor information to outputs if possible. More...

TensorDescriptor	configure_output (size_t idx) const override
	Calculates output configuration. More...

void	accept (INodeVisitor &v) override
	Accepts a node visitor. More...

Public Member Functions inherited from INode
	INode ()
	Constructor. More...

virtual	~INode ()=default
	Destructor. More...

	INode (const INode &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...

INode &	operator= (const INode &)=delete
	Prevent instances of this class from being copy assigned (As this class contains pointers) More...

	INode (INode &&)=default
	Allow instances of this class to be moved. More...

INode &	operator= (INode &&)=default
	Allow instances of this class to be move assigned. More...

virtual Status	validate () const
	Validate node. More...

std::string	name () const
	Returns node's name. More...

NodeID	id () const
	Returns node's ID. More...

const Graph *	graph () const
	Returns node's Graph. More...

Graph *	graph ()
	Returns node's Graph. More...

void	set_graph (Graph *g)
	Sets the graph that this node is registered to. More...

void	set_id (NodeID id)
	Sets the node id. More...

void	set_common_node_parameters (NodeParams common_params)
	Sets common node parameters. More...

void	set_requested_target (Target target)
	Sets target preference. More...

void	set_assigned_target (Target target)
	Sets the final execution target. More...

void	set_output_tensor (TensorID tid, size_t idx)
	Sets the output tensor of at a given index. More...

const std::vector< TensorID > &	inputs () const
	Returns inputs of the node. More...

const std::vector< TensorID > &	outputs () const
	Returns outputs of the node. More...

const std::vector< EdgeID > &	input_edges () const
	Returns input edge set. More...

const std::set< EdgeID > &	output_edges () const
	Returns output edge set. More...

TensorID	input_id (size_t idx) const
	Returns the tensor ID of a given input of the node. More...

TensorID	output_id (size_t idx) const
	Returns the tensor ID of a given output of the node. More...

Tensor *	input (size_t idx) const
	Returns the tensor of a given input of the node. More...

Tensor *	output (size_t idx) const
	Returns the tensor of a given output of the node. More...

EdgeID	input_edge_id (size_t idx) const
	Returns the edge ID of a given input of the node. More...

Edge *	input_edge (size_t idx) const
	Returns the edge of a given input of the node. More...

size_t	num_inputs () const
	Returns number of inputs of the node. More...

size_t	num_outputs () const
	Returns number of outputs of the node. More...

NodeParams	common_node_params () const
	Returns common node parameters. More...

Target	requested_target () const
	Returns requested target for this node. More...

Target	assigned_target () const
	Returns assigned target for this node. More...

Static Public Attributes
static constexpr NodeType	node_type = NodeType::SoftmaxLayer

Detailed Description

Softmax Layer node.

Definition at line 34 of file SoftmaxLayerNode.h.

Constructor & Destructor Documentation

◆ SoftmaxLayerNode()

SoftmaxLayerNode ( float beta = 1.f )

Constructor.

Parameters

[in] beta (Optional) Beta parameter. Defaults to 1

Definition at line 34 of file SoftmaxLayerNode.cpp.

                                              : _beta(beta)
 {
     _input_edges.resize(1, EmptyEdgeID);
     _outputs.resize(1, NullTensorID);
 }

References arm_compute::graph::EmptyEdgeID, and arm_compute::graph::NullTensorID.

Member Function Documentation

◆ accept()

void accept ( INodeVisitor & v )

overridevirtual

Accepts a node visitor.

Parameters

[in] v Visitor to accept

Implements INode.

Definition at line 76 of file SoftmaxLayerNode.cpp.

 {
     v.visit(*this);
 }

References INodeVisitor::visit().

◆ beta()

float beta ( ) const

Beta parameter accessor.

Returns: Beta parameter

Definition at line 40 of file SoftmaxLayerNode.cpp.

 {
     return _beta;
 }

Referenced by arm_compute::graph::backends::detail::create_softmax_layer().

◆ configure_output()

TensorDescriptor configure_output ( size_t idx ) const

overridevirtual

Calculates output configuration.

Parameters

[in] idx Output index to configure

Returns: Output descriptor configuration

Implements INode.

Definition at line 57 of file SoftmaxLayerNode.cpp.

 {
     ARM_COMPUTE_UNUSED(idx);
     ARM_COMPUTE_ERROR_ON(idx >= _outputs.size());
  
     const Tensor *src = input(0);
     ARM_COMPUTE_ERROR_ON(src == nullptr);
  
     TensorDescriptor out_desc = src->desc();
     out_desc.quant_info       = get_softmax_output_quantization_info(out_desc.data_type, false);
  
     return out_desc;
 }

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_UNUSED, TensorDescriptor::data_type, arm_compute::get_softmax_output_quantization_info(), INode::input(), TensorDescriptor::quant_info, and arm_compute::test::validation::src.

Referenced by SoftmaxLayerNode::forward_descriptors().

◆ forward_descriptors()

bool forward_descriptors ( )

overridevirtual

Forwards descriptor information to outputs if possible.

Returns: True if descriptor information could be forwarded otherwise false

Implements INode.

Definition at line 45 of file SoftmaxLayerNode.cpp.

 {
     if ((input_id(0) != NullTensorID) && (output_id(0) != NullTensorID))
     {
         Tensor *dst = output(0);
         ARM_COMPUTE_ERROR_ON(dst == nullptr);
         dst->desc() = configure_output(0);
         return true;
     }
     return false;
 }

References ARM_COMPUTE_ERROR_ON, SoftmaxLayerNode::configure_output(), arm_compute::test::validation::dst, INode::input_id(), arm_compute::graph::NullTensorID, INode::output(), and INode::output_id().

◆ type()

NodeType type ( ) const

overridevirtual

Returns node's type.

Returns: Node's type

Implements INode.

Definition at line 71 of file SoftmaxLayerNode.cpp.

 {
     return NodeType::SoftmaxLayer;
 }

References arm_compute::graph::SoftmaxLayer.

Referenced by arm_compute::graph::backends::detail::create_softmax_layer().

Field Documentation

◆ node_type

constexpr NodeType node_type = NodeType::SoftmaxLayer

staticconstexpr

Definition at line 55 of file SoftmaxLayerNode.h.

The documentation for this class was generated from the following files:

arm_compute/graph/nodes/SoftmaxLayerNode.h
src/graph/nodes/SoftmaxLayerNode.cpp

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SoftmaxLayerNode()

Member Function Documentation

◆ accept()

◆ beta()

◆ configure_output()

◆ forward_descriptors()

◆ type()

Field Documentation

◆ node_type