From 6940dd720ebb6b3d1df8ca203ab696daefe58189 Mon Sep 17 00:00:00 2001 From: Jim Flynn Date: Fri, 20 Mar 2020 12:25:56 +0000 Subject: renamed Documentation folder 20.02 and added .nojekyll file Signed-off-by: Jim Flynn --- ...assarmnn_1_1_detection_post_process_layer.xhtml | 613 +++++++++++++++++++++ 1 file changed, 613 insertions(+) create mode 100644 20.02/classarmnn_1_1_detection_post_process_layer.xhtml (limited to '20.02/classarmnn_1_1_detection_post_process_layer.xhtml') diff --git a/20.02/classarmnn_1_1_detection_post_process_layer.xhtml b/20.02/classarmnn_1_1_detection_post_process_layer.xhtml new file mode 100644 index 0000000000..89b41587fc --- /dev/null +++ b/20.02/classarmnn_1_1_detection_post_process_layer.xhtml @@ -0,0 +1,613 @@ + + + + + + + + + + + + + +ArmNN: DetectionPostProcessLayer Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  20.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
DetectionPostProcessLayer Class Reference
+
+
+ +

This layer represents a detection postprocess operator. + More...

+ +

#include <DetectionPostProcessLayer.hpp>

+
+Inheritance diagram for DetectionPostProcessLayer:
+
+
+ + +LayerWithParameters< DetectionPostProcessDescriptor > +Layer +IConnectableLayer + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the DetectionPostProcess type. More...
 
DetectionPostProcessLayerClone (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 DetectionPostProcessLayer. More...
 
void Accept (ILayerVisitor &visitor) const override
 Apply a visitor to this layer. More...
 
- Public Member Functions inherited from LayerWithParameters< DetectionPostProcessDescriptor >
const DetectionPostProcessDescriptorGetParameters () 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 OutputHandlerGetOutputHandler (unsigned int i=0) const
 
OutputHandlerGetOutputHandler (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 BackendIdGetBackendId () 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
 
std::vector< TensorShapeInferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
 Infer the shape of the output(s) based on the provided input shape(s) More...
 
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 InputSlotGetInputSlot (unsigned int index) const override
 Get a const input slot handle by slot index. More...
 
InputSlotGetInputSlot (unsigned int index) override
 Get the input slot handle by slot index. More...
 
const OutputSlotGetOutputSlot (unsigned int index=0) const override
 Get the const output slot handle by slot index. More...
 
OutputSlotGetOutputSlot (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< BackendIdGetBackendHint () const
 
+ + + + +

+Public Attributes

std::unique_ptr< ScopedCpuTensorHandlem_Anchors
 A unique pointer to store Anchor values. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

 DetectionPostProcessLayer (const DetectionPostProcessDescriptor &param, const char *name)
 Constructor to create a DetectionPostProcessLayer. More...
 
 ~DetectionPostProcessLayer ()=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< DetectionPostProcessDescriptor >
 LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const DetectionPostProcessDescriptor &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>
LayerTypeCloneBase (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< DetectionPostProcessDescriptor >
using DescriptorType = DetectionPostProcessDescriptor
 
- Protected Types inherited from Layer
using ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>
 
- Protected Attributes inherited from LayerWithParameters< DetectionPostProcessDescriptor >
DetectionPostProcessDescriptor m_Param
 The parameters for the layer (not including tensor-valued weights etc.). More...
 
- Protected Attributes inherited from Layer
std::vector< OutputHandlerm_OutputHandlers
 
+

Detailed Description

+

This layer represents a detection postprocess operator.

+ +

Definition at line 16 of file DetectionPostProcessLayer.hpp.

+

Constructor & Destructor Documentation

+ +

◆ DetectionPostProcessLayer()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
DetectionPostProcessLayer (const DetectionPostProcessDescriptorparam,
const char * name 
)
+
+protected
+
+ +

Constructor to create a DetectionPostProcessLayer.

+
Parameters
+ + + +
[in]paramDetectionPostProcessDescriptor to configure the detection postprocess.
[in]nameOptional name for the layer.
+
+
+ +

Definition at line 18 of file DetectionPostProcessLayer.cpp.

+
20 {
21 }
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const DetectionPostProcessDescriptor &param, const char *name)
+ +
+
+
+ +

◆ ~DetectionPostProcessLayer()

+ +
+
+ + + + + +
+ + + + + + + +
~DetectionPostProcessLayer ()
+
+protecteddefault
+
+ +

Default destructor.

+ +
+
+

Member Function Documentation

+ +

◆ Accept()

+ +
+
+ + + + + +
+ + + + + + + + +
void Accept (ILayerVisitorvisitor) const
+
+overridevirtual
+
+ +

Apply a visitor to this layer.

+ +

Implements IConnectableLayer.

+ +

Definition at line 75 of file DetectionPostProcessLayer.cpp.

+ +

References Layer::GetName(), LayerWithParameters< DetectionPostProcessDescriptor >::GetParameters(), DetectionPostProcessLayer::m_Anchors, and ILayerVisitor::VisitDetectionPostProcessLayer().

+
76 {
77  ConstTensor anchorTensor(m_Anchors->GetTensorInfo(), m_Anchors->GetConstTensor<void>());
78  visitor.VisitDetectionPostProcessLayer(this, GetParameters(), anchorTensor, GetName());
79 }
const DetectionPostProcessDescriptor & GetParameters() const
+
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
+
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:305
+
+
+
+ +

◆ Clone()

+ +
+
+ + + + + +
+ + + + + + + + +
DetectionPostProcessLayer * Clone (Graphgraph) const
+
+overridevirtual
+
+ +

Creates a dynamically-allocated copy of this layer.

+
Parameters
+ + +
[in]graphThe graph into which this layer is being cloned.
+
+
+ +

Implements Layer.

+ +

Definition at line 30 of file DetectionPostProcessLayer.cpp.

+ +

References Layer::GetName(), DetectionPostProcessLayer::m_Anchors, and LayerWithParameters< DetectionPostProcessDescriptor >::m_Param.

+
31 {
32  auto layer = CloneBase<DetectionPostProcessLayer>(graph, m_Param, GetName());
33  layer->m_Anchors = m_Anchors ? std::make_unique<ScopedCpuTensorHandle>(*m_Anchors) : nullptr;
34  return std::move(layer);
35 }
DetectionPostProcessDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
+
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
+
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:305
+
+
+
+ +

◆ CreateWorkload()

+ +
+
+ + + + + +
+ + + + + + + + +
std::unique_ptr< IWorkload > CreateWorkload (const IWorkloadFactoryfactory) const
+
+overridevirtual
+
+ +

Makes a workload for the DetectionPostProcess type.

+
Parameters
+ + + +
[in]graphThe graph where this layer can be found.
[in]factoryThe workload factory which will create the workload.
+
+
+
Returns
A pointer to the created workload, or nullptr if not created.
+ +

Implements Layer.

+ +

Definition at line 23 of file DetectionPostProcessLayer.cpp.

+ +

References IWorkloadFactory::CreateDetectionPostProcess(), DetectionPostProcessLayer::m_Anchors, DetectionPostProcessQueueDescriptor::m_Anchors, and LayerWithParameters< DetectionPostProcessDescriptor >::PrepInfoAndDesc().

+
24 {
25  DetectionPostProcessQueueDescriptor descriptor;
26  descriptor.m_Anchors = m_Anchors.get();
27  return factory.CreateDetectionPostProcess(descriptor, PrepInfoAndDesc(descriptor));
28 }
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
+
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *LayerCreateWorkload.
+
+
+
+ +

◆ 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 70 of file DetectionPostProcessLayer.cpp.

+ +

References DetectionPostProcessLayer::m_Anchors.

+
71 {
72  return { m_Anchors };
73 }
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
+
+
+
+ +

◆ ValidateTensorShapesFromInputs()

+ +
+
+ + + + + +
+ + + + + + + +
void ValidateTensorShapesFromInputs ()
+
+overridevirtual
+
+ +

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

+ +

Implements Layer.

+ +

Definition at line 37 of file DetectionPostProcessLayer.cpp.

+ +

References CHECK_LOCATION, Layer::GetNumOutputSlots(), Layer::GetOutputSlot(), TensorInfo::GetShape(), OutputSlot::GetTensorInfo(), DetectionPostProcessLayer::m_Anchors, DetectionPostProcessDescriptor::m_MaxClassesPerDetection, DetectionPostProcessDescriptor::m_MaxDetections, LayerWithParameters< DetectionPostProcessDescriptor >::m_Param, and Layer::VerifyLayerConnections().

+
38 {
40 
41  // on this level constant data should not be released.
42  BOOST_ASSERT_MSG(m_Anchors != nullptr, "DetectionPostProcessLayer: Anchors data should not be null.");
43 
44  BOOST_ASSERT_MSG(GetNumOutputSlots() == 4, "DetectionPostProcessLayer: The layer should return 4 outputs.");
45 
46  unsigned int detectedBoxes = m_Param.m_MaxDetections * m_Param.m_MaxClassesPerDetection;
47 
48  const TensorShape& inferredDetectionBoxes = TensorShape({ 1, detectedBoxes, 4 });
49  const TensorShape& inferredDetectionScores = TensorShape({ 1, detectedBoxes });
50  const TensorShape& inferredNumberDetections = TensorShape({ 1 });
51 
52  ConditionalThrowIfNotEqual<LayerValidationException>(
53  "DetectionPostProcessLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
55  inferredDetectionBoxes);
56  ConditionalThrowIfNotEqual<LayerValidationException>(
57  "DetectionPostProcessLayer: TensorShape set on OutputSlot[1] does not match the inferred shape.",
59  inferredDetectionScores);
60  ConditionalThrowIfNotEqual<LayerValidationException>(
61  "DetectionPostProcessLayer: TensorShape set on OutputSlot[2] does not match the inferred shape.",
63  inferredDetectionScores);
64  ConditionalThrowIfNotEqual<LayerValidationException>(
65  "DetectionPostProcessLayer: TensorShape set on OutputSlot[3] does not match the inferred shape.",
67  inferredNumberDetections);
68 }
DetectionPostProcessDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
+
const TensorShape & GetShape() const
Definition: Tensor.hpp:88
+
unsigned int GetNumOutputSlots() const override
Returns the number of connectable output slots.
Definition: Layer.hpp:308
+
uint32_t m_MaxClassesPerDetection
Maximum numbers of classes per detection, used in Fast NMS.
+
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:338
+
uint32_t m_MaxDetections
Maximum numbers of detections.
+
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
+
#define CHECK_LOCATION()
Definition: Exceptions.hpp:192
+
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:312
+
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:63
+
+
+
+

Member Data Documentation

+ +

◆ m_Anchors

+ + +
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1