framework.proto 3.8 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
Y
Yi Wang 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15

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. */

syntax = "proto2";
Y
Yu Yang 已提交
16
option optimize_for = LITE_RUNTIME;
17
package paddle.framework.proto;
Y
Yi Wang 已提交
18 19 20 21 22 23 24 25

enum AttrType {
  INT = 0;
  FLOAT = 1;
  STRING = 2;
  INTS = 3;
  FLOATS = 4;
  STRINGS = 5;
Y
Yu Yang 已提交
26 27 28
  BOOLEAN = 6;
  BOOLEANS = 7;
  BLOCK = 8;
29
  LONG = 9;
Y
Yi Wang 已提交
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
}

// OpDesc describes an instance of a C++ framework::OperatorBase
// derived class type.
message OpDesc {

  message Attr {
    required string name = 1;
    required AttrType type = 2;
    optional int32 i = 3;
    optional float f = 4;
    optional string s = 5;
    repeated int32 ints = 6;
    repeated float floats = 7;
    repeated string strings = 8;
D
dangqingqing 已提交
45
    optional bool b = 10;
46
    repeated bool bools = 11;
D
dangqingqing 已提交
47
    optional int32 block_idx = 12;
48
    optional int64 l = 13;
Y
Yi Wang 已提交
49 50 51
  };

  message Var {
52 53
    required string parameter = 1;
    repeated string arguments = 2;
Y
Yi Wang 已提交
54 55 56 57 58 59
  };

  required string type = 3;
  repeated Var inputs = 1;
  repeated Var outputs = 2;
  repeated Attr attrs = 4;
Y
Yang Yang 已提交
60
  optional bool is_target = 5 [ default = false ];
Y
Yi Wang 已提交
61 62 63 64 65 66 67 68 69
};

// OpProto describes a C++ framework::OperatorBase derived class.
message OpProto {

  // VarProto describes the C++ type framework::Variable.
  message Var {
    required string name = 1;
    required string comment = 2;
Y
Yu Yang 已提交
70

Y
Yi Wang 已提交
71 72
    optional bool duplicable = 3 [ default = false ];
    optional bool intermediate = 4 [ default = false ];
Y
Yang Yang 已提交
73
    optional bool dispensable = 5 [ default = false ];
Y
Yi Wang 已提交
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
  }

  // AttrProto describes the C++ type Attribute.
  message Attr {
    required string name = 1;
    required AttrType type = 2;
    required string comment = 3;
    // If that attribute is generated, it means the Paddle third
    // language binding has responsibility to fill that
    // attribute. End-User should not set that attribute.
    optional bool generated = 4 [ default = false ];
  }

  required string type = 1;
  repeated Var inputs = 2;
  repeated Var outputs = 3;
  repeated Attr attrs = 4;
  required string comment = 5;
}
Q
qiaolongfei 已提交
93 94 95 96 97 98 99 100 101 102 103

enum DataType {
  BOOL = 0;
  INT16 = 1;
  INT32 = 2;
  INT64 = 3;
  FP16 = 4;
  FP32 = 5;
  FP64 = 6;
}

Y
Yu Yang 已提交
104
message TensorDesc {
Q
qiaolongfei 已提交
105
  required DataType data_type = 1;
106
  repeated int64 dims = 2; // [UNK, 640, 480] is saved as [-1, 640, 480]
Y
Yu Yang 已提交
107 108 109 110 111
}

message LoDTensorDesc {
  required TensorDesc tensor = 1;
  optional int32 lod_level = 2 [ default = 0 ];
Q
qiaolongfei 已提交
112 113
}

Y
Yu Yang 已提交
114 115 116 117 118
message LoDTensorArrayDesc {
  required TensorDesc tensor = 1;
  optional int32 lod_level = 2 [ default = 0 ];
}

F
fengjiayi 已提交
119
message ReaderDesc { repeated LoDTensorDesc lod_tensor = 1; }
F
fengjiayi 已提交
120

Q
qiaolongfei 已提交
121
message VarDesc {
Y
Yu Yang 已提交
122 123 124
  enum VarType {
    LOD_TENSOR = 1;
    SELECTED_ROWS = 2;
Y
Yu Yang 已提交
125 126
    FEED_MINIBATCH = 3;
    FETCH_LIST = 4;
Y
Yu Yang 已提交
127
    STEP_SCOPES = 5;
Y
Yu Yang 已提交
128
    LOD_RANK_TABLE = 6;
Y
Yu Yang 已提交
129
    LOD_TENSOR_ARRAY = 7;
Y
Yang Yu 已提交
130
    PLACE_LIST = 8;
F
fengjiayi 已提交
131
    READER = 9;
Y
Yu Yang 已提交
132
  }
Q
qiaolongfei 已提交
133
  required string name = 1;
Y
Yu Yang 已提交
134
  required VarType type = 2;
F
fengjiayi 已提交
135 136 137
  optional bool persistable = 3 [ default = false ];
  optional LoDTensorDesc lod_tensor = 4;
  optional TensorDesc selected_rows = 5;
Y
Yu Yang 已提交
138
  optional LoDTensorArrayDesc tensor_array = 6;
F
fengjiayi 已提交
139
  optional ReaderDesc reader = 7;
Q
qiaolongfei 已提交
140
}
141 142 143 144 145 146 147 148

message BlockDesc {
  required int32 idx = 1;
  required int32 parent_idx = 2;
  repeated VarDesc vars = 3;
  repeated OpDesc ops = 4;
}

Y
Yi Wang 已提交
149 150 151
// Please refer to
// https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/program.md
// for more details.
152
message ProgramDesc { repeated BlockDesc blocks = 1; }