compiler/luci/import/include/luci/Import/CircleReader.h

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *    http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __LUCI_IMPORT_GRAPHREADER_H__
  18 #define __LUCI_IMPORT_GRAPHREADER_H__
  19
  20 #include <mio/circle/schema_generated.h>
  21
  22 #include <luci/IR/AttrFusedActFunc.h>
  23 #include <luci/IR/AttrPadding.h>
  24 #include <luci/IR/CircleNode.h>
  25 #include <luci/IR/CircleQuantParam.h>
  26 #include <luci/IR/SparsityParam.h>
  27
  28 #include <loco.h>
  29
  30 #include <map>
  31 #include <memory>
  32 #include <string>
  33 #include <vector>
  34
  35 namespace luci
  36 {
  37
  38 bool is_valid(const circle::OperatorCodeT &opcode);
  39 bool is_custom(const circle::OperatorCodeT &opcode);
  40 std::string opcode_name(const circle::OperatorCodeT &opcode);
  41 const char *tensor_name(const circle::TensorT &tensor);
  42 const circle::QuantizationParametersT *tensor_quantization(const circle::TensorT &tensor);
  43
  44 loco::DataType luci_datatype(circle::TensorType type);
  45 FusedActFunc luci_actfunc(const circle::ActivationFunctionType type);
  46 Padding luci_padding(const circle::Padding padding);
  47 MirrorPadMode luci_mirrorpad_mode(const circle::MirrorPadMode mode);
  48 luci::CircleFullyConnected::WeightsFormat
  49 luci_weights_format(const circle::FullyConnectedOptionsWeightsFormat weights_format);
  50 std::unique_ptr<CircleQuantParam>
  51 luci_quantparam(const circle::QuantizationParametersT *quantization);
  52
  53 /// @brief Copy common tensor attributes such as name, type, etc. to node.
  54 void copy_tensor_attributes(const circle::TensorT &tensor, CircleNode *node);
  55
  56 /**
  57  * @brief Loads Circle file and provides helpers to access attributes
  58  */
  59 class CircleReader
  60 {
  61 private:
  62   using CircleBuffers_t = std::vector<std::unique_ptr<circle::BufferT>>;
  63   using CircleTensors_t = std::vector<std::unique_ptr<circle::TensorT>>;
  64   using CircleOperators_t = std::vector<std::unique_ptr<circle::OperatorT>>;
  65   using CircleOperatorCodes_t = std::vector<std::unique_ptr<circle::OperatorCodeT>>;
  66   using CircleMetadata_t = std::vector<std::unique_ptr<circle::MetadataT>>;
  67
  68   using CircleSubGraphsPtr_t = flatbuffers::Vector<flatbuffers::Offset<circle::SubGraph>>;
  69   using CircleTensorsPtr_t = flatbuffers::Vector<flatbuffers::Offset<circle::Tensor>>;
  70
  71 public:
  72   CircleReader() = default;
  73
  74 public:
  75   const CircleOperatorCodes_t &opcodes() const { return _model->operator_codes; }
  76   const CircleBuffers_t &buffers() const { return _model->buffers; }
  77   const CircleTensors_t &tensors() const { return _current_subgraph->tensors; }
  78   const CircleOperators_t &operators() const { return _current_subgraph->operators; }
  79   const std::vector<int32_t> &inputs() const { return _current_subgraph->inputs; }
  80   const std::vector<int32_t> &outputs() const { return _current_subgraph->outputs; }
  81   const std::string &name() const { return _current_subgraph->name; }
  82   const circle::DataFormat &data_format() const { return _current_subgraph->data_format; }
  83   const CircleMetadata_t &metadata() const { return _model->metadata; }
  84
  85   const CircleTensorsPtr_t *tensors_ptr() const { return _tensors_ptr; }
  86
  87   uint32_t num_subgraph() const { return _model->subgraphs.size(); }
  88
  89   circle::BuiltinOperator builtin_code(const circle::OperatorT &op) const;
  90   std::string opcode_name(const circle::OperatorT &op) const;
  91
  92 public:
  93   bool parse(const circle::Model *model);
  94   bool select_subgraph(uint32_t subgraph);
  95
  96 private:
  97   std::unique_ptr<const circle::ModelT> _model;
  98   const circle::SubGraphT *_current_subgraph{nullptr};
  99
 100   const circle::Model *_model_ptr{nullptr};
 101   const CircleTensorsPtr_t *_tensors_ptr{nullptr};
 102 };
 103
 104 } // namespace luci
 105
 106 #endif // __LUCI_IMPORT_GRAPHREADER_H__