Convolution Layer node. More...

#include <ConvolutionLayerNode.h>

Collaboration diagram for ConvolutionLayerNode:

Public Member Functions
	ConvolutionLayerNode (PadStrideInfo info, unsigned int num_groups=1, ConvolutionMethod method=ConvolutionMethod::Default, FastMathHint fast_math_hint=FastMathHint::Disabled, QuantizationInfo out_quant_info=QuantizationInfo())
	Constructor. More...

void	set_convolution_method (ConvolutionMethod method)
	Sets the convolution layer method to use. More...

ConvolutionMethod	convolution_method () const
	Convolution layer method accessor. More...

void	set_fast_math_hint (FastMathHint hint)
	Sets the fast math fast hint. More...

FastMathHint	fast_math_hint () const
	Fast math hint accessor. More...

PadStrideInfo	convolution_info () const
	Convolution metadata accessor. More...

unsigned int	num_groups () const
	Number of groups in convolution accessor. More...

ActivationLayerInfo	fused_activation () const
	Returns fused activation. More...

void	set_fused_activation (ActivationLayerInfo fused_activation)
	Sets fused activation. More...

void	set_convolution_info (PadStrideInfo info)
	Sets convolution info. 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 Member Functions
static TensorDescriptor	compute_output_descriptor (const TensorDescriptor &input_descriptor, const TensorDescriptor &weights_descriptor, const PadStrideInfo &info)
	Computes convolution output descriptor. More...

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

Detailed Description

Convolution Layer node.

Definition at line 34 of file ConvolutionLayerNode.h.

Constructor & Destructor Documentation

◆ ConvolutionLayerNode()

ConvolutionLayerNode	(	PadStrideInfo	info,
		unsigned int	num_groups = `1`,
		ConvolutionMethod	method = `ConvolutionMethod::Default`,
		FastMathHint	fast_math_hint = `FastMathHint::Disabled`,
		QuantizationInfo	out_quant_info = `QuantizationInfo()`
	)

Constructor.

Parameters

[in]	info	Convolution layer attributes
[in]	num_groups	(Optional) Number of groups (Defaults to 1)
[in]	method	(Optional) Convolution method to use
[in]	fast_math_hint	(Optional) Fast math hint
[in]	out_quant_info	(Optional) Output quantization info

Definition at line 35 of file ConvolutionLayerNode.cpp.

     : _info(std::move(info)),
       _num_groups(num_groups),
       _method(method),
       _fast_math_hint(fast_math_hint),
       _out_quant_info(std::move(out_quant_info)),
       _fused_activation()
 {
     _input_edges.resize(3, EmptyEdgeID);
     _outputs.resize(1, 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 155 of file ConvolutionLayerNode.cpp.

 {
     v.visit(*this);
 }

References INodeVisitor::visit().

◆ compute_output_descriptor()

TensorDescriptor compute_output_descriptor	(	const TensorDescriptor &	input_descriptor,
		const TensorDescriptor &	weights_descriptor,
		const PadStrideInfo &	info
	)

static

Computes convolution output descriptor.

Parameters

[in]	input_descriptor	Input descriptor
[in]	weights_descriptor	Weights descriptor
[in]	info	Convolution operation attributes

Returns: Output descriptor

Definition at line 96 of file ConvolutionLayerNode.cpp.

 {
     unsigned int output_width  = 0;
     unsigned int output_height = 0;
  
     const unsigned int input_width   = get_dimension_size(input_descriptor, DataLayoutDimension::WIDTH);
     const unsigned int input_height  = get_dimension_size(input_descriptor, DataLayoutDimension::HEIGHT);
     const unsigned int kernel_width  = get_dimension_size(weights_descriptor, DataLayoutDimension::WIDTH);
     const unsigned int kernel_height = get_dimension_size(weights_descriptor, DataLayoutDimension::HEIGHT);
  
     std::tie(output_width, output_height) =
         scaled_dimensions(input_width, input_height, kernel_width, kernel_height, info);
  
     const DataLayout data_layout       = input_descriptor.layout;
     TensorDescriptor output_descriptor = input_descriptor;
     output_descriptor.shape.set(get_dimension_idx(data_layout, DataLayoutDimension::WIDTH), output_width);
     output_descriptor.shape.set(get_dimension_idx(data_layout, DataLayoutDimension::HEIGHT), output_height);
     output_descriptor.shape.set(get_dimension_idx(data_layout, DataLayoutDimension::CHANNEL),
                                 weights_descriptor.shape[3]);
  
     return output_descriptor;
 }

References arm_compute::CHANNEL, arm_compute::cpu::data_layout, arm_compute::graph::get_dimension_idx(), arm_compute::graph::get_dimension_size(), arm_compute::HEIGHT, arm_compute::test::validation::info, TensorDescriptor::layout, arm_compute::scaled_dimensions(), TensorShape::set(), TensorDescriptor::shape, and arm_compute::WIDTH.

Referenced by ConvolutionLayerNode::configure_output().

◆ 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 133 of file ConvolutionLayerNode.cpp.

 {
     ARM_COMPUTE_UNUSED(idx);
     const Tensor *src     = input(0);
     const Tensor *weights = input(1);
  
     ARM_COMPUTE_ERROR_ON(src == nullptr || weights == nullptr);
  
     TensorDescriptor output_info = compute_output_descriptor(src->desc(), weights->desc(), _info);
     if (!_out_quant_info.empty())
     {
         output_info.quant_info = _out_quant_info;
     }
  
     return output_info;
 }

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_UNUSED, ConvolutionLayerNode::compute_output_descriptor(), Tensor::desc(), QuantizationInfo::empty(), INode::input(), arm_compute::test::validation::output_info, and arm_compute::test::validation::src.

Referenced by ConvolutionLayerNode::forward_descriptors().

◆ convolution_info()

PadStrideInfo convolution_info ( ) const

Convolution metadata accessor.

Returns: Convolution information

Definition at line 71 of file ConvolutionLayerNode.cpp.

 {
     return _info;
 }

Referenced by arm_compute::graph::backends::detail::create_convolution_layer(), and arm_compute::graph::backends::detail::validate_convolution_layer().

◆ convolution_method()

ConvolutionMethod convolution_method ( ) const

Convolution layer method accessor.

Note: This is an indication on which convolution layer implementation to use, if it fails to be created the library's heuristic approach will be used

Returns: Convolution layer method to be used by the node

Definition at line 56 of file ConvolutionLayerNode.cpp.

 {
     return _method;
 }

Referenced by arm_compute::graph::backends::detail::create_convolution_layer(), arm_compute::graph::backends::detail::validate_convolution_layer(), and DotGraphVisitor::visit().

◆ fast_math_hint()

FastMathHint fast_math_hint ( ) const

Fast math hint accessor.

Returns: Fast math hint to be used by the node

Definition at line 66 of file ConvolutionLayerNode.cpp.

 {
     return _fast_math_hint;
 }

Referenced by arm_compute::graph::backends::detail::create_convolution_layer(), and arm_compute::graph::backends::detail::validate_convolution_layer().

◆ 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 121 of file ConvolutionLayerNode.cpp.

 {
     if ((input_id(0) != NullTensorID) && (input_id(1) != 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, ConvolutionLayerNode::configure_output(), arm_compute::test::validation::dst, INode::input_id(), arm_compute::graph::NullTensorID, INode::output(), and INode::output_id().

◆ fused_activation()

ActivationLayerInfo fused_activation ( ) const

Returns fused activation.

Returns: Fused activation

Definition at line 81 of file ConvolutionLayerNode.cpp.

 {
     return _fused_activation;
 }

Referenced by arm_compute::graph::backends::detail::create_convolution_layer(), and ConvolutionLayerNode::set_fused_activation().

◆ num_groups()

unsigned int num_groups ( ) const

Number of groups in convolution accessor.

Returns: Number of groups in convolution

Definition at line 76 of file ConvolutionLayerNode.cpp.

 {
     return _num_groups;
 }

Referenced by arm_compute::graph::backends::detail::create_convolution_layer(), and arm_compute::graph::backends::detail::validate_convolution_layer().

◆ set_convolution_info()

void set_convolution_info ( PadStrideInfo info )

Sets convolution info.

Parameters

[in] info Convolution info to set

Definition at line 91 of file ConvolutionLayerNode.cpp.

 {
     _info = info;
 }

References arm_compute::test::validation::info.

◆ set_convolution_method()

void set_convolution_method ( ConvolutionMethod method )

Sets the convolution layer method to use.

Parameters

[in] method Method to use for convolution

Definition at line 51 of file ConvolutionLayerNode.cpp.

 {
     _method = method;
 }

◆ set_fast_math_hint()

void set_fast_math_hint ( FastMathHint hint )

Sets the fast math fast hint.

Parameters

[in] hint Hint to use for convolution

Definition at line 61 of file ConvolutionLayerNode.cpp.

 {
     _fast_math_hint = hint;
 }

◆ set_fused_activation()

void set_fused_activation ( ActivationLayerInfo fused_activation )

Sets fused activation.

Parameters

[in] fused_activation Fused activation to set

Definition at line 86 of file ConvolutionLayerNode.cpp.

 {
     _fused_activation = fused_activation;
 }

References ConvolutionLayerNode::fused_activation().

◆ type()

NodeType type ( ) const

overridevirtual

Returns node's type.

Returns: Node's type

Implements INode.

Definition at line 150 of file ConvolutionLayerNode.cpp.

 {
     return ConvolutionLayerNode::node_type;
 }

References ConvolutionLayerNode::node_type.

Field Documentation

◆ node_type

constexpr NodeType node_type = NodeType::ConvolutionLayer

staticconstexpr

Definition at line 117 of file ConvolutionLayerNode.h.

Referenced by ConvolutionLayerNode::type().

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConvolutionLayerNode()

Member Function Documentation

◆ accept()

◆ compute_output_descriptor()

◆ configure_output()

◆ convolution_info()

◆ convolution_method()

◆ fast_math_hint()

◆ forward_descriptors()

◆ fused_activation()

◆ num_groups()

◆ set_convolution_info()

◆ set_convolution_method()

◆ set_fast_math_hint()

◆ set_fused_activation()

◆ type()

Field Documentation

◆ node_type