MLCE-37: Adds PermuteNode support in graph

Change-Id: Iaa93a497e7913c27f2fd09e974125cda5f04bc4b
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/142463
Reviewed-by: Anthony Barbier <anthony.barbier@arm.com>
Tested-by: Jenkins <bsgcomp@arm.com>

11 files changed, 178 insertions, 0 deletions

diff --git a/arm_compute/graph/GraphBuilder.h b/arm_compute/graph/GraphBuilder.h
index a2f7618876..43670f4022 100644
--- a/arm_compute/graph/GraphBuilder.h
+++ b/arm_compute/graph/GraphBuilder.h
@@ -239,6 +239,18 @@ public:
      * @return Node ID of the created node, EmptyNodeID in case of error
      */
     static NodeID add_normalization_node(Graph &g, NodeParams params, NodeIdxPair input, NormalizationLayerInfo norm_info);
+    /** Adds a permute layer node to the graph
+     *
+     * @param[in] g      Graph to add the node to
+     * @param[in] params Common node parameters
+     * @param[in] input  Input to the reshape layer node as a NodeID-Index pair
+     * @param[in] perm   Permutation vector
+     * @param[in] layout (Optional) Data layout to assign to permuted tensor.
+     *                    If UNKNOWN then the input's layout will be used.
+     *
+     * @return Node ID of the created node, EmptyNodeID in case of error
+     */
+    static NodeID add_permute_node(Graph &g, NodeParams params, NodeIdxPair input, PermutationVector perm, DataLayout layout = DataLayout::UNKNOWN);
     /** Adds a pooling layer node to the graph
      *
      * @param[in] g         Graph to add the node to
diff --git a/arm_compute/graph/INodeVisitor.h b/arm_compute/graph/INodeVisitor.h
index ad390ad760..a21c9b2d48 100644
--- a/arm_compute/graph/INodeVisitor.h
+++ b/arm_compute/graph/INodeVisitor.h
@@ -101,6 +101,11 @@ public:
      * @param[in] n Node to visit.
      */
     virtual void visit(OutputNode &n) = 0;
+    /** Visit PermuteLayerNode.
+     *
+     * @param[in] n Node to visit.
+     */
+    virtual void visit(PermuteLayerNode &n) = 0;
     /** Visit PoolingLayerNode.
      *
      * @param[in] n Node to visit.
@@ -188,6 +193,10 @@ public:
     {
         default_visit();
     }
+    virtual void visit(PermuteLayerNode &n) override
+    {
+        default_visit();
+    }
     virtual void visit(PoolingLayerNode &n) override
     {
         default_visit();
diff --git a/arm_compute/graph/TypePrinter.h b/arm_compute/graph/TypePrinter.h
index 7c0bd8cfdd..9117864130 100644
--- a/arm_compute/graph/TypePrinter.h
+++ b/arm_compute/graph/TypePrinter.h
@@ -95,6 +95,9 @@ inline ::std::ostream &operator<<(::std::ostream &os, const NodeType &node_type)
         case NodeType::NormalizationLayer:
             os << "NormalizationLayer";
             break;
+        case NodeType::PermuteLayer:
+            os << "PermuteLayer";
+            break;
         case NodeType::PoolingLayer:
             os << "PoolingLayer";
             break;
diff --git a/arm_compute/graph/Types.h b/arm_compute/graph/Types.h
index ee0bf429ad..2df9998fcf 100644
--- a/arm_compute/graph/Types.h
+++ b/arm_compute/graph/Types.h
@@ -44,6 +44,7 @@ using arm_compute::DataLayout;
 using arm_compute::DataLayoutDimension;
 using arm_compute::TensorShape;
 using arm_compute::Size2D;
+using arm_compute::PermutationVector;
 
 using arm_compute::ActivationLayerInfo;
 using arm_compute::NormType;
@@ -140,6 +141,7 @@ enum class NodeType
     FlattenLayer,
     FullyConnectedLayer,
     NormalizationLayer,
+    PermuteLayer,
     PoolingLayer,
     ReshapeLayer,
     ResizeLayer,
diff --git a/arm_compute/graph/backends/FunctionHelpers.h b/arm_compute/graph/backends/FunctionHelpers.h
index b7c9c579de..5739773dfc 100644
--- a/arm_compute/graph/backends/FunctionHelpers.h
+++ b/arm_compute/graph/backends/FunctionHelpers.h
@@ -591,6 +591,43 @@ std::unique_ptr<IFunction> create_normalization_layer(NormalizationLayerNode &no
     return std::move(func);
 }
 
+/** Create a backend permute layer function
+ *
+ * @tparam PermuteLayerFunction Backend permute function
+ * @tparam TargetInfo           Target-specific information
+ *
+ * @param[in] node Node to create the backend function for
+ *
+ * @return Backend permute layer function
+ */
+template <typename PermuteLayerFunction, typename TargetInfo>
+std::unique_ptr<IFunction> create_permute_layer(PermuteLayerNode &node)
+{
+    validate_node<TargetInfo>(node, 1 /* expected inputs */, 1 /* expected outputs */);
+
+    // Extract IO and info
+    typename TargetInfo::TensorType *input  = get_backing_tensor<TargetInfo>(node.input(0));
+    typename TargetInfo::TensorType *output = get_backing_tensor<TargetInfo>(node.output(0));
+    const PermutationVector         &perm   = node.permutation_vector();
+    ARM_COMPUTE_ERROR_ON(input == nullptr);
+    ARM_COMPUTE_ERROR_ON(output == nullptr);
+
+    // Create and configure function
+    auto func = support::cpp14::make_unique<PermuteLayerFunction>();
+    func->configure(input, output, perm);
+
+    // Log info
+    ARM_COMPUTE_LOG_GRAPH_INFO("Instantiated " << node.type()
+                               << " Target " << TargetInfo::TargetType
+                               << " Data Type: " << input->info()->data_type()
+                               << " Input shape: " << input->info()->tensor_shape()
+                               << " Output shape: " << output->info()->tensor_shape()
+                               << " Permutation vector: " << perm
+                               << std::endl);
+
+    return std::move(func);
+}
+
 /** Create a backend pooling layer function
  *
  * @tparam PoolingLayerFunction Backend pooling function
diff --git a/arm_compute/graph/backends/ValidateHelpers.h b/arm_compute/graph/backends/ValidateHelpers.h
index ae52593b03..ec84399ac6 100644
--- a/arm_compute/graph/backends/ValidateHelpers.h
+++ b/arm_compute/graph/backends/ValidateHelpers.h
@@ -175,6 +175,29 @@ Status validate_depthwise_convolution_layer(DepthwiseConvolutionLayerNode &node)
 
     return Status{};
 }
+
+/** Validates a permute layer node
+ *
+ * @tparam PermuteLayer Permute layer type
+ *
+ * @param[in] node Node to validate
+ *
+ * @return Status
+ */
+template <typename PermuteLayer>
+Status validate_permute_layer(PermuteLayerNode &node)
+{
+    ARM_COMPUTE_LOG_GRAPH_VERBOSE("Validating PermuteLayer node with ID : " << node.id() << " and Name: " << node.name() << std::endl);
+    ARM_COMPUTE_RETURN_ERROR_ON(node.num_inputs() != 1);
+    ARM_COMPUTE_RETURN_ERROR_ON(node.num_outputs() != 1);
+
+    // Extract IO and info
+    arm_compute::ITensorInfo *input  = get_backing_tensor_info(node.input(0));
+    arm_compute::ITensorInfo *output = get_backing_tensor_info(node.output(0));
+    const PermutationVector &perm   = node.permutation_vector();
+
+    return PermuteLayer::validate(input, output, perm);
+}
 } // namespace detail
 } // namespace backends
 } // namespace graph
diff --git a/arm_compute/graph/frontend/Layers.h b/arm_compute/graph/frontend/Layers.h
index 0a1a0cf1e4..cf80dd9f4e 100644
--- a/arm_compute/graph/frontend/Layers.h
+++ b/arm_compute/graph/frontend/Layers.h
@@ -445,6 +445,33 @@ private:
     NormalizationLayerInfo _norm_info;
 };
 
+/** Permute Layer */
+class PermuteLayer final : public ILayer
+{
+public:
+    /** Construct a permute layer.
+     *
+     * @param[in] perm   Permutation vector.
+     * @param[in] layout (Optional) Data layout to assign to permuted tensor.
+     *                   If UNKNOWN then the input's layout will be used.
+     */
+    PermuteLayer(PermutationVector perm, DataLayout layout = DataLayout::UNKNOWN)
+        : _perm(perm), _layout(layout)
+    {
+    }
+
+    NodeID create_layer(IStream &s) override
+    {
+        NodeParams  common_params = { name(), s.hints().target_hint };
+        NodeIdxPair input         = { s.tail_node(), 0 };
+        return GraphBuilder::add_permute_node(s.graph(), common_params, input, _perm, _layout);
+    }
+
+private:
+    PermutationVector _perm;
+    DataLayout        _layout;
+};
+
 /** Pooling Layer */
 class PoolingLayer final : public ILayer
 {
diff --git a/arm_compute/graph/frontend/Types.h b/arm_compute/graph/frontend/Types.h
index f9d4952765..8f6312f318 100644
--- a/arm_compute/graph/frontend/Types.h
+++ b/arm_compute/graph/frontend/Types.h
@@ -36,6 +36,7 @@ namespace frontend
 using graph::DataType;
 using graph::DataLayout;
 using graph::TensorShape;
+using graph::PermutationVector;
 
 using graph::ActivationLayerInfo;
 using graph::NormalizationLayerInfo;
diff --git a/arm_compute/graph/nodes/Nodes.h b/arm_compute/graph/nodes/Nodes.h
index f2e751e15f..8a85159896 100644
--- a/arm_compute/graph/nodes/Nodes.h
+++ b/arm_compute/graph/nodes/Nodes.h
@@ -39,6 +39,7 @@
 #include "arm_compute/graph/nodes/InputNode.h"
 #include "arm_compute/graph/nodes/NormalizationLayerNode.h"
 #include "arm_compute/graph/nodes/OutputNode.h"
+#include "arm_compute/graph/nodes/PermuteLayerNode.h"
 #include "arm_compute/graph/nodes/PoolingLayerNode.h"
 #include "arm_compute/graph/nodes/ReshapeLayerNode.h"
 #include "arm_compute/graph/nodes/ResizeLayerNode.h"
diff --git a/arm_compute/graph/nodes/NodesFwd.h b/arm_compute/graph/nodes/NodesFwd.h
index a0a9146dc4..a6393e7210 100644
--- a/arm_compute/graph/nodes/NodesFwd.h
+++ b/arm_compute/graph/nodes/NodesFwd.h
@@ -45,6 +45,7 @@ class FullyConnectedLayerNode;
 class InputNode;
 class NormalizationLayerNode;
 class OutputNode;
+class PermuteLayerNode;
 class PoolingLayerNode;
 class ReshapeLayerNode;
 class ResizeLayerNode;
diff --git a/arm_compute/graph/nodes/PermuteLayerNode.h b/arm_compute/graph/nodes/PermuteLayerNode.h
new file mode 100644
index 0000000000..b400926e9b
--- /dev/null
+++ b/arm_compute/graph/nodes/PermuteLayerNode.h
@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2018 ARM Limited.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+#ifndef __ARM_COMPUTE_GRAPH_PERMUTE_LAYER_NODE_H__
+#define __ARM_COMPUTE_GRAPH_PERMUTE_LAYER_NODE_H__
+
+#include "arm_compute/graph/INode.h"
+
+namespace arm_compute
+{
+namespace graph
+{
+/** Permute Layer node */
+class PermuteLayerNode final : public INode
+{
+public:
+    /** Constructor
+     *
+     * @param[in] perm   Permutation vector
+     * @param[in] layout (Optional) Data layout to assign to permuted tensor.
+     *                   If UNKNOWN then the input's layout will be used.
+     */
+    PermuteLayerNode(PermutationVector perm, DataLayout layout = DataLayout::UNKNOWN);
+    /** Permutation vector accessor
+     *
+     * @return Permutation vector
+     */
+    const PermutationVector &permutation_vector() const;
+
+    // Inherited overridden methods:
+    NodeType         type() const override;
+    bool             forward_descriptors() override;
+    TensorDescriptor configure_output(size_t idx) const override;
+    void accept(INodeVisitor &v) override;
+
+private:
+    PermutationVector _perm;
+    DataLayout        _layout;
+};
+} // namespace graph
+} // namespace arm_compute
+#endif /* __ARM_COMPUTE_GRAPH_PERMUTE_LAYER_NODE_H__ */