COMPMID-948: Add validation to CLL2NormalizeLayer
Change-Id: I452a718a60b81da51cd3e98641fd99c86c4debab
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/129451
Tested-by: Jenkins <bsgcomp@arm.com>
Reviewed-by: Gian Marco Iodice <gianmarco.iodice@arm.com>
diff --git a/arm_compute/runtime/CL/functions/CLL2NormalizeLayer.h b/arm_compute/runtime/CL/functions/CLL2NormalizeLayer.h
index 8aea7a6..d3d34f8 100644
--- a/arm_compute/runtime/CL/functions/CLL2NormalizeLayer.h
+++ b/arm_compute/runtime/CL/functions/CLL2NormalizeLayer.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2017 ARM Limited.
+ * Copyright (c) 2017-2018 ARM Limited.
*
* SPDX-License-Identifier: MIT
*
@@ -21,8 +21,8 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
-#ifndef __ARM_COMPUTE_CLL2NORMALIZE_H__
-#define __ARM_COMPUTE_CLL2NORMALIZE_H__
+#ifndef __ARM_COMPUTE_CLL2NORMALIZELAYER_H__
+#define __ARM_COMPUTE_CLL2NORMALIZELAYER_H__
#include "arm_compute/core/CL/kernels/CLL2NormalizeLayerKernel.h"
#include "arm_compute/core/Types.h"
@@ -39,7 +39,11 @@
{
class ICLTensor;
-/** Perform reduction operation.
+/** Basic function to perform a L2 normalization on a given axis.
+ *
+ * This function runs the following kernels:
+ * -# @ref CLReductionOperation
+ * -# @ref CLL2NormalizeLayerKernel
*/
class CLL2NormalizeLayer : public IFunction
{
@@ -49,13 +53,24 @@
/** Set the input and output tensors.
*
- * @param[in] input Source tensor. Data types supported: QS8, QS16, F32.
- * @param[out] output Destination tensor. Data types supported: Same as @p input.
+ * @param[in] input Source tensor. Data types supported: F32. Data layouts supported: NCHW.
+ * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
* @param[in] axis Axis along which to reduce. Supported reduction axis : 0
- * @param[in] epsilon Lower bound value for the normalization.
+ * @param[in] epsilon (Optional) Lower bound value for the normalization.
*/
void configure(ICLTensor *input, ICLTensor *output, unsigned int axis, float epsilon = 1e-12);
+ /** Static function to check if given info will lead to a valid configuration of @ref CLL2NormalizeLayer.
+ *
+ * @param[in] input Source tensor info. Data types supported: F32. Data layouts supported: NCHW.
+ * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input.
+ * @param[in] axis Axis along which to reduce. Supported reduction axis : 0
+ * @param[in] epsilon (Optional) Lower bound value for the normalization.
+ *
+ * @return a status
+ */
+ static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int axis, float epsilon = 1e-12);
+
// Inherited methods overridden:
void run() override;
@@ -66,4 +81,4 @@
CLTensor _sumsq;
};
}
-#endif /*__ARM_COMPUTE_CLL2NORMALIZE_H__ */
+#endif /*__ARM_COMPUTE_CLL2NORMALIZELAYER_H__ */