inference-engine/include/builders/ie_argmax_layer.hpp

   1 // Copyright (C) 2018-2019 Intel Corporation
   2 // SPDX-License-Identifier: Apache-2.0
   3 //
   4
   5 #pragma once
   6
   7 #include <builders/ie_layer_decorator.hpp>
   8 #include <ie_network.hpp>
   9 #include <string>
  10
  11 namespace InferenceEngine {
  12 namespace Builder {
  13
  14 /**
  15  * @brief The class represents a builder for ArgMax layer
  16  */
  17 class INFERENCE_ENGINE_API_CLASS(ArgMaxLayer): public LayerDecorator {
  18 public:
  19     /**
  20      * @brief The constructor creates a builder with the name
  21      * @param name Layer name
  22      */
  23     explicit ArgMaxLayer(const std::string& name = "");
  24     /**
  25      * @brief The constructor creates a builder from generic builder
  26      * @param layer pointer to generic builder
  27      */
  28     explicit ArgMaxLayer(const Layer::Ptr& layer);
  29     /**
  30      * @brief The constructor creates a builder from generic builder
  31      * @param layer constant pointer to generic builder
  32      */
  33     explicit ArgMaxLayer(const Layer::CPtr& layer);
  34     /**
  35      * @brief Sets the name for the layer
  36      * @param name Layer name
  37      * @return reference to layer builder
  38      */
  39     ArgMaxLayer& setName(const std::string& name);
  40
  41     /**
  42      * @brief Returns port with shapes for the layer
  43      * @return Port with shapes
  44      */
  45     const Port& getPort() const;
  46     /**
  47      * @brief Sets port shapes for the layer
  48      * @param port Port with shapes
  49      * @return reference to layer builder
  50      */
  51     ArgMaxLayer& setPort(const Port& port);
  52     /**
  53      * @brief Returns axis
  54      * @return Axis
  55      */
  56     int getAxis() const;
  57     /**
  58      * @brief Sets axis
  59      * @param axis Axis
  60      * @return reference to layer builder
  61      */
  62     ArgMaxLayer& setAxis(int axis);
  63     /**
  64      * @brief Returns top K
  65      * @return Top K
  66      */
  67     size_t getTopK() const;
  68     /**
  69      * @brief Sets top K
  70      * @param topK Top K
  71      * @return reference to layer builder
  72      */
  73     ArgMaxLayer& setTopK(size_t topK);
  74     /**
  75      * @brief Returns output maximum value
  76      * @return Output maximum value
  77      */
  78     size_t getOutMaxVal() const;
  79     /**
  80      * @brief Sets output maximum value
  81      * @param size Maximum value
  82      * @return reference to layer builder
  83      */
  84     ArgMaxLayer& setOutMaxVal(size_t size);
  85 };
  86
  87 }  // namespace Builder
  88 }  // namespace InferenceEngine