This layer represents a fully connected operation. More...

#include <FullyConnectedLayer.hpp>

Inheritance diagram for FullyConnectedLayer:

Public Member Functions
virtual std::unique_ptr< IWorkload >	CreateWorkload (const IWorkloadFactory &factory) const override
	Makes a workload for the FullyConnected type. More...

FullyConnectedLayer *	Clone (Graph &graph) const override
	Creates a dynamically-allocated copy of this layer. More...

void	ValidateTensorShapesFromInputs () override
	Check if the input tensor shape(s) will lead to a valid configuration of FullyConnectedLayer. More...

std::vector< TensorShape >	InferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
	By default returns inputShapes if the number of inputs are equal to number of outputs, otherwise infers the output shapes from given input shapes and layer properties. More...

void	Accept (ILayerVisitor &visitor) const override
	Apply a visitor to this layer. More...

Public Member Functions inherited from LayerWithParameters< FullyConnectedDescriptor >
const FullyConnectedDescriptor &	GetParameters () const

void	SerializeLayerParameters (ParameterStringifyFunction &fn) const override
	Helper to serialize the layer parameters to string (currently used in DotSerializer and company). More...

Public Member Functions inherited from Layer
	Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)

	Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, DataLayout layout, const char *name)

const std::string &	GetNameStr () const

const OutputHandler &	GetOutputHandler (unsigned int i=0) const

OutputHandler &	GetOutputHandler (unsigned int i=0)

const std::vector< InputSlot > &	GetInputSlots () const

const std::vector< OutputSlot > &	GetOutputSlots () const

std::vector< InputSlot >::iterator	BeginInputSlots ()

std::vector< InputSlot >::iterator	EndInputSlots ()

std::vector< OutputSlot >::iterator	BeginOutputSlots ()

std::vector< OutputSlot >::iterator	EndOutputSlots ()

bool	IsOutputUnconnected ()

void	ResetPriority () const

LayerPriority	GetPriority () const

LayerType	GetType () const

DataType	GetDataType () const

const BackendId &	GetBackendId () const

void	SetBackendId (const BackendId &id)

virtual void	CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)

void	VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const

virtual void	ReleaseConstantData ()

template<typename Op >
void	OperateOnConstantTensors (Op op)

const char *	GetName () const override
	Returns the name of the layer. More...

unsigned int	GetNumInputSlots () const override
	Returns the number of connectable input slots. More...

unsigned int	GetNumOutputSlots () const override
	Returns the number of connectable output slots. More...

const InputSlot &	GetInputSlot (unsigned int index) const override
	Get a const input slot handle by slot index. More...

InputSlot &	GetInputSlot (unsigned int index) override
	Get the input slot handle by slot index. More...

const OutputSlot &	GetOutputSlot (unsigned int index=0) const override
	Get the const output slot handle by slot index. More...

OutputSlot &	GetOutputSlot (unsigned int index=0) override
	Get the output slot handle by slot index. More...

void	SetGuid (LayerGuid guid)

LayerGuid	GetGuid () const final
	Returns the unique id of the layer. More...

void	AddRelatedLayerName (const std::string layerName)

const std::list< std::string > &	GetRelatedLayerNames ()

virtual void	Reparent (Graph &dest, std::list< Layer *>::const_iterator iterator)=0

void	BackendSelectionHint (Optional< BackendId > backend) final
	Provide a hint for the optimizer as to which backend to prefer for this layer. More...

Optional< BackendId >	GetBackendHint () const

Public Attributes
std::unique_ptr< ScopedCpuTensorHandle >	m_Weight
	A unique pointer to store Weight values. More...

std::unique_ptr< ScopedCpuTensorHandle >	m_Bias
	A unique pointer to store Bias values. More...

Protected Member Functions
	FullyConnectedLayer (const FullyConnectedDescriptor &param, const char *name)
	Constructor to create a FullyConnectedLayer. More...

	~FullyConnectedLayer ()=default
	Default destructor. More...

ConstantTensors	GetConstantTensorsByRef () override
	Retrieve the handles to the constant values stored by the layer. More...

Protected Member Functions inherited from LayerWithParameters< FullyConnectedDescriptor >
	LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const FullyConnectedDescriptor &param, const char *name)

	~LayerWithParameters ()=default

WorkloadInfo	PrepInfoAndDesc (QueueDescriptor &descriptor) const
	Helper function to reduce duplication in *LayerCreateWorkload. More...

Protected Member Functions inherited from Layer
virtual	~Layer ()=default

template<typename QueueDescriptor >
void	CollectQueueDescriptorInputs (QueueDescriptor &descriptor, WorkloadInfo &info) const

template<typename QueueDescriptor >
void	CollectQueueDescriptorOutputs (QueueDescriptor &descriptor, WorkloadInfo &info) const

template<typename QueueDescriptor >
WorkloadInfo	PrepInfoAndDesc (QueueDescriptor &descriptor) const
	Helper function to reduce duplication in *LayerCreateWorkload. More...

template<typename LayerType , typename ... Params>
LayerType *	CloneBase (Graph &graph, Params &&... params) const

Protected Member Functions inherited from IConnectableLayer
	~IConnectableLayer ()
	Objects are not deletable via the handle. More...

Additional Inherited Members
Public Types inherited from LayerWithParameters< FullyConnectedDescriptor >
using	DescriptorType = FullyConnectedDescriptor

Protected Types inherited from Layer
using	ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>

Protected Attributes inherited from LayerWithParameters< FullyConnectedDescriptor >
FullyConnectedDescriptor	m_Param
	The parameters for the layer (not including tensor-valued weights etc.). More...

Protected Attributes inherited from Layer
std::vector< OutputHandler >	m_OutputHandlers

Detailed Description

This layer represents a fully connected operation.

Definition at line 15 of file FullyConnectedLayer.hpp.

Constructor & Destructor Documentation

◆ FullyConnectedLayer()

FullyConnectedLayer	(	const FullyConnectedDescriptor &	param,
		const char *	name
	)

protected

Constructor to create a FullyConnectedLayer.

Parameters

[in]	param	FullyConnectedDescriptor to configure the fully connected operation.
[in]	name	Optional name for the layer.

Definition at line 17 of file FullyConnectedLayer.cpp.

     : LayerWithParameters(1, 1, LayerType::FullyConnected, param, name)
 {
 }

◆ ~FullyConnectedLayer()

~FullyConnectedLayer ( )

protecteddefault

Default destructor.

Member Function Documentation

◆ Accept()

void Accept ( ILayerVisitor & visitor ) const

overridevirtual

Apply a visitor to this layer.

Implements IConnectableLayer.

Definition at line 88 of file FullyConnectedLayer.cpp.

References Layer::GetName(), LayerWithParameters< FullyConnectedDescriptor >::GetParameters(), FullyConnectedLayer::m_Bias, FullyConnectedLayer::m_Weight, and ILayerVisitor::VisitFullyConnectedLayer().

 {
     ConstTensor weightsTensor(m_Weight->GetTensorInfo(), m_Weight->Map(true));
     Optional<ConstTensor> optionalBiasTensor = EmptyOptional();
 
     if (GetParameters().m_BiasEnabled)
     {
         ConstTensor biasTensor(m_Bias->GetTensorInfo(), m_Bias->GetConstTensor<void>());
         optionalBiasTensor = Optional<ConstTensor>(biasTensor);
     }
 
     visitor.VisitFullyConnectedLayer(this, GetParameters(), weightsTensor, optionalBiasTensor, GetName());
 }

◆ Clone()

FullyConnectedLayer * Clone ( Graph & graph ) const

overridevirtual

Creates a dynamically-allocated copy of this layer.

Parameters

[in] graph The graph into which this layer is being cloned.

Implements Layer.

Definition at line 38 of file FullyConnectedLayer.cpp.

References Layer::GetName(), FullyConnectedLayer::m_Bias, LayerWithParameters< FullyConnectedDescriptor >::m_Param, and FullyConnectedLayer::m_Weight.

 {
     auto layer = CloneBase<FullyConnectedLayer>(graph, m_Param, GetName());
 
     layer->m_Weight = m_Weight ? std::make_unique<ScopedCpuTensorHandle>(*m_Weight) : nullptr;
     if (layer->m_Param.m_BiasEnabled)
     {
         layer->m_Bias = m_Bias ? std::make_unique<ScopedCpuTensorHandle>(*m_Bias) : nullptr;
     }
 
     return std::move(layer);
 }

◆ CreateWorkload()

std::unique_ptr< IWorkload > CreateWorkload ( const IWorkloadFactory & factory ) const

overridevirtual

Makes a workload for the FullyConnected type.

Parameters

[in]	graph	The graph where this layer can be found.
[in]	factory	The workload factory which will create the workload.

Returns: A pointer to the created workload, or nullptr if not created.

Implements Layer.

Definition at line 22 of file FullyConnectedLayer.cpp.

References IWorkloadFactory::CreateFullyConnected(), FullyConnectedLayer::m_Bias, FullyConnectedQueueDescriptor::m_Bias, FullyConnectedDescriptor::m_BiasEnabled, LayerWithParameters< FullyConnectedDescriptor >::m_Param, FullyConnectedLayer::m_Weight, FullyConnectedQueueDescriptor::m_Weight, and LayerWithParameters< FullyConnectedDescriptor >::PrepInfoAndDesc().

 {
     // on this level constant data should not be released..
     BOOST_ASSERT_MSG(m_Weight != nullptr, "FullyConnectedLayer: Weights data should not be null.");
 
     FullyConnectedQueueDescriptor descriptor;
 
     descriptor.m_Weight = m_Weight.get();
     if (m_Param.m_BiasEnabled)
     {
         BOOST_ASSERT_MSG(m_Bias != nullptr, "FullyConnectedLayer: Bias data should not be null.");
         descriptor.m_Bias = m_Bias.get();
     }
     return factory.CreateFullyConnected(descriptor, PrepInfoAndDesc(descriptor));
 }

◆ GetConstantTensorsByRef()

Layer::ConstantTensors GetConstantTensorsByRef ( )

overrideprotectedvirtual

Retrieve the handles to the constant values stored by the layer.

Returns: A vector of the constant tensors stored by this layer.

Reimplemented from Layer.

Definition at line 83 of file FullyConnectedLayer.cpp.

References FullyConnectedLayer::m_Bias, and FullyConnectedLayer::m_Weight.

 {
     return {m_Weight, m_Bias};
 }

◆ InferOutputShapes()

std::vector< TensorShape > InferOutputShapes ( const std::vector< TensorShape > & inputShapes ) const

overridevirtual

By default returns inputShapes if the number of inputs are equal to number of outputs, otherwise infers the output shapes from given input shapes and layer properties.

Parameters

[in] inputShapes The input shapes layer has.

Returns: A vector to the inferred output shape.

Reimplemented from Layer.

Definition at line 51 of file FullyConnectedLayer.cpp.

References LayerWithParameters< FullyConnectedDescriptor >::m_Param, and FullyConnectedDescriptor::m_TransposeWeightMatrix.

Referenced by FullyConnectedLayer::ValidateTensorShapesFromInputs().

 {
     BOOST_ASSERT(inputShapes.size() == 2);
     const TensorShape& inputShape = inputShapes[0];
     const TensorShape weightShape = inputShapes[1];
 
     // Output for FC is [1, w[1]].
     unsigned int batches = inputShape[0];
     unsigned int dimIdx = m_Param.m_TransposeWeightMatrix ? 0 : 1;
 
     return std::vector<TensorShape>({ TensorShape({batches, weightShape[dimIdx]})});
 }

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )

overridevirtual

Check if the input tensor shape(s) will lead to a valid configuration of FullyConnectedLayer.

Implements Layer.

Definition at line 64 of file FullyConnectedLayer.cpp.

References CHECK_LOCATION, InputSlot::GetConnection(), Layer::GetInputSlot(), Layer::GetOutputSlot(), TensorInfo::GetShape(), IOutputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), FullyConnectedLayer::InferOutputShapes(), FullyConnectedLayer::m_Weight, and Layer::VerifyLayerConnections().

 {
     VerifyLayerConnections(1, CHECK_LOCATION());
 
     // check if we m_Weight data is not nullptr
     BOOST_ASSERT_MSG(m_Weight != nullptr, "FullyConnectedLayer: Weights data should not be null.");
 
     auto inferredShapes = InferOutputShapes({
         GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape(),
         m_Weight->GetTensorInfo().GetShape() });
 
     BOOST_ASSERT(inferredShapes.size() == 1);
 
     ConditionalThrowIfNotEqual<LayerValidationException>(
         "FullyConnectedLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
         GetOutputSlot(0).GetTensorInfo().GetShape(),
         inferredShapes[0]);
 }

Member Data Documentation

◆ m_Bias

std::unique_ptr<ScopedCpuTensorHandle> m_Bias

A unique pointer to store Bias values.

Definition at line 21 of file FullyConnectedLayer.hpp.

Referenced by FullyConnectedLayer::Accept(), BOOST_AUTO_TEST_CASE(), FullyConnectedLayer::Clone(), FullyConnectedLayer::CreateWorkload(), and FullyConnectedLayer::GetConstantTensorsByRef().

◆ m_Weight

std::unique_ptr<ScopedCpuTensorHandle> m_Weight

A unique pointer to store Weight values.

Definition at line 19 of file FullyConnectedLayer.hpp.

Referenced by FullyConnectedLayer::Accept(), Network::AddElementwiseUnaryLayer(), BOOST_AUTO_TEST_CASE(), FullyConnectedLayer::Clone(), FullyConnectedLayer::CreateWorkload(), FullyConnectedLayer::GetConstantTensorsByRef(), and FullyConnectedLayer::ValidateTensorShapesFromInputs().

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

src/armnn/layers/FullyConnectedLayer.hpp
src/armnn/layers/FullyConnectedLayer.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FullyConnectedLayer()

◆ ~FullyConnectedLayer()

Member Function Documentation

◆ Accept()

◆ Clone()

◆ CreateWorkload()

◆ GetConstantTensorsByRef()

◆ InferOutputShapes()

◆ ValidateTensorShapesFromInputs()

Member Data Documentation

◆ m_Bias

◆ m_Weight