summaryrefslogtreecommitdiff
path: root/compiler/tfinfo-v2/include/tfinfo-v2/TensorSignature.h
blob: f26d0354abea9b17782a65b03cc7d5e0c235f39e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
 * Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __TFINFO_V2_TENSORSIGNATURE_H__
#define __TFINFO_V2_TENSORSIGNATURE_H__

#include <map>
#include <vector>
#include <memory>
#include <string>
#include <stdexcept>

namespace tfinfo
{
inline namespace v2
{

/**
 * @brief Supported Data Types
 */
enum class DataType
{
  UNKNOWN,

  FLOAT32, // IEEE 32-bit floating point
  /* To be added */
};

/**
 * @brief Class to represent axis and size of dims.
 *        User should enter axis and size of dim(s) when input tensor(s) contain(s) unknown dim(s).
 *        Such axis and size of dim(s) will be stored in ShapeHint.
 */
class ShapeHint
{
  using AxisHint = uint32_t;
  using SizeHint = uint64_t;

public:
  ShapeHint() = default;

  void add(AxisHint axis, SizeHint size)
  {
    if (_dims.find(axis) != _dims.end())
      throw std::runtime_error("dim value already exists");

    _dims[axis] = size;
  }

  std::map<AxisHint, SizeHint>::const_iterator cbegin() const { return _dims.cbegin(); }

  std::map<AxisHint, SizeHint>::const_iterator cend() const { return _dims.cend(); }

  bool empty() { return _dims.size() == 0; }

  size_t size() { return _dims.size(); }

private:
  std::map<AxisHint, SizeHint> _dims;
};

using TensorName = std::string;

/**
 * @brief Class to store input and output tensor information
 */
class TensorSignature final
{
public:
  enum class Kind
  {
    Input,
    Output
  };

  TensorSignature(const Kind kind, const std::string &name) : _kind(kind), _tensor_name()
  {
    // tensor name can be a form of "placeholder:0" or "placeholder".
    // If tensor index is omitted, ":0" is appended
    auto pos = name.find(":");
    if (pos == std::string::npos)
      _tensor_name.assign(name + ":0");
    else
      _tensor_name.assign(name);
  }

  TensorSignature(const Kind kind, const std::string &name, const ShapeHint &shape_hint)
      : TensorSignature(kind, name)
  {
    _shape_hint = shape_hint;
  }

public:
  Kind kind() const { return _kind; }

  const TensorName &name() { return _tensor_name; }

  ShapeHint &shapeHint() { return _shape_hint; }

private:
  Kind _kind;
  std::string _tensor_name;
  ShapeHint _shape_hint;
};

using TensorSignatures = std::vector<std::unique_ptr<TensorSignature>>;

} // namespace v2
} // namespace tfinfo

#endif // __TFINFO_V2_TENSORSIGNATURE_H__