1 /* 2 * Copyright (c) 2019-2020 Arm Limited. 3 * 4 * SPDX-License-Identifier: MIT 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to 8 * deal in the Software without restriction, including without limitation the 9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 10 * sell copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in all 14 * copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 #ifndef ARM_COMPUTE_NEGENERATEPROPOSALSLAYER_H 25 #define ARM_COMPUTE_NEGENERATEPROPOSALSLAYER_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/CPP/CPPScheduler.h" 29 #include "arm_compute/runtime/CPP/functions/CPPBoxWithNonMaximaSuppressionLimit.h" 30 #include "arm_compute/runtime/IFunction.h" 31 #include "arm_compute/runtime/MemoryGroup.h" 32 #include "arm_compute/runtime/NEON/functions/NEBoundingBoxTransform.h" 33 #include "arm_compute/runtime/NEON/functions/NEComputeAllAnchors.h" 34 #include "arm_compute/runtime/NEON/functions/NEDequantizationLayer.h" 35 #include "arm_compute/runtime/NEON/functions/NEPadLayer.h" 36 #include "arm_compute/runtime/NEON/functions/NEPermute.h" 37 #include "arm_compute/runtime/NEON/functions/NEQuantizationLayer.h" 38 #include "arm_compute/runtime/NEON/functions/NEReshapeLayer.h" 39 #include "arm_compute/runtime/Tensor.h" 40 41 namespace arm_compute 42 { 43 class ITensor; 44 45 /** Basic function to generate proposals for a RPN (Region Proposal Network) 46 * 47 * This function calls the following Neon kernels: 48 * -# @ref NEComputeAllAnchors 49 * -# @ref NEPermute x 2 50 * -# @ref NEReshapeLayer x 2 51 * -# @ref NEBoundingBoxTransform 52 * -# @ref NEPadLayerKernel 53 * -# @ref NEDequantizationLayerKernel x 2 54 * -# @ref NEQuantizationLayerKernel 55 * And the following CPP kernels: 56 * -# @ref CPPBoxWithNonMaximaSuppressionLimit 57 */ 58 class NEGenerateProposalsLayer : public IFunction 59 { 60 public: 61 /** Default constructor 62 * 63 * @param[in] memory_manager (Optional) Memory manager. 64 */ 65 NEGenerateProposalsLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr); 66 /** Prevent instances of this class from being copied (As this class contains pointers) */ 67 NEGenerateProposalsLayer(const NEGenerateProposalsLayer &) = delete; 68 /** Prevent instances of this class from being copied (As this class contains pointers) */ 69 NEGenerateProposalsLayer &operator=(const NEGenerateProposalsLayer &) = delete; 70 /** Default destructor */ 71 ~NEGenerateProposalsLayer(); 72 73 /** Set the input and output tensors. 74 * 75 * @param[in] scores Scores from convolution layer of size (W, H, A), where H and W are the height and width of the feature map, and A is the number of anchors. 76 * Data types supported: QASYMM8/F16/F32 77 * @param[in] deltas Bounding box deltas from convolution layer of size (W, H, 4*A). Data types supported: Same as @p scores 78 * @param[in] anchors Anchors tensor of size (4, A). Data types supported: QSYMM16 with scale of 0.125 if @p scores is QASYMM8, otherwise same as @p scores 79 * @param[out] proposals Box proposals output tensor of size (5, W*H*A). 80 * Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p scores is QASYMM8, otherwise same as @p scores 81 * @param[out] scores_out Box scores output tensor of size (W*H*A). Data types supported: Same as @p input 82 * @param[out] num_valid_proposals Scalar output tensor which says which of the first proposals are valid. Data types supported: U32 83 * @param[in] info Contains GenerateProposals operation information described in @ref GenerateProposalsInfo 84 * 85 * @note Only single image prediction is supported. Height and Width (and scale) of the image will be contained in the @ref GenerateProposalsInfo struct. 86 * @note Proposals contains all the proposals. Of those, only the first num_valid_proposals are valid. 87 */ 88 void configure(const ITensor *scores, const ITensor *deltas, const ITensor *anchors, ITensor *proposals, ITensor *scores_out, ITensor *num_valid_proposals, 89 const GenerateProposalsInfo &info); 90 91 /** Static function to check if given info will lead to a valid configuration of @ref NEGenerateProposalsLayer 92 * 93 * @param[in] scores Scores info from convolution layer of size (W, H, A), where H and W are the height and width of the feature map, and A is the number of anchors. 94 * Data types supported: QASYMM8/F16/F32 95 * @param[in] deltas Bounding box deltas info from convolution layer of size (W, H, 4*A). Data types supported: Same as @p scores 96 * @param[in] anchors Anchors tensor info of size (4, A). Data types supported: QSYMM16 with scale of 0.125 if @p scores is QASYMM8, otherwise same as @p scores 97 * @param[in] proposals Box proposals info output tensor of size (5, W*H*A). 98 * Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p scores is QASYMM8, otherwise same as @p scores 99 * @param[in] scores_out Box scores output tensor info of size (W*H*A). Data types supported: Same as @p input 100 * @param[in] num_valid_proposals Scalar output tensor info which says which of the first proposals are valid. Data types supported: U32 101 * @param[in] info Contains GenerateProposals operation information described in @ref GenerateProposalsInfo 102 * 103 * @return a Status 104 */ 105 static Status validate(const ITensorInfo *scores, const ITensorInfo *deltas, const ITensorInfo *anchors, const ITensorInfo *proposals, const ITensorInfo *scores_out, 106 const ITensorInfo *num_valid_proposals, 107 const GenerateProposalsInfo &info); 108 109 // Inherited methods overridden: 110 void run() override; 111 112 private: 113 // Memory group manager 114 MemoryGroup _memory_group; 115 116 // Neon kernels 117 NEPermute _permute_deltas; 118 NEReshapeLayer _flatten_deltas; 119 NEPermute _permute_scores; 120 NEReshapeLayer _flatten_scores; 121 NEComputeAllAnchors _compute_anchors; 122 NEBoundingBoxTransform _bounding_box; 123 NEPadLayer _pad; 124 NEDequantizationLayer _dequantize_anchors; 125 NEDequantizationLayer _dequantize_deltas; 126 NEQuantizationLayer _quantize_all_proposals; 127 128 // CPP functions 129 CPPBoxWithNonMaximaSuppressionLimit _cpp_nms; 130 131 bool _is_nhwc; 132 bool _is_qasymm8; 133 134 // Temporary tensors 135 Tensor _deltas_permuted; 136 Tensor _deltas_flattened; 137 Tensor _deltas_flattened_f32; 138 Tensor _scores_permuted; 139 Tensor _scores_flattened; 140 Tensor _all_anchors; 141 Tensor _all_anchors_f32; 142 Tensor _all_proposals; 143 Tensor _all_proposals_quantized; 144 Tensor _keeps_nms_unused; 145 Tensor _classes_nms_unused; 146 Tensor _proposals_4_roi_values; 147 148 // Temporary tensor pointers 149 Tensor *_all_proposals_to_use; 150 151 // Output tensor pointers 152 ITensor *_num_valid_proposals; 153 ITensor *_scores_out; 154 }; 155 } // namespace arm_compute 156 #endif /* ARM_COMPUTE_NEGENERATEPROPOSALSLAYER_H */ 157