send_recv.proto 2.4 KB
Newer Older
Y
Yancey 已提交
1 2 3
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve. Licensed under
the Apache License, Version 2.0 (the "License"); you may not use this file
except in compliance with the License.
L
Luo Tao 已提交
4
You may obtain a copy of the License at
武毅 已提交
5

L
Luo Tao 已提交
6
    http://www.apache.org/licenses/LICENSE-2.0
武毅 已提交
7

L
Luo Tao 已提交
8 9 10 11 12
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. */
武毅 已提交
13 14 15 16 17

syntax = "proto3";
package sendrecv;

service SendRecvService {
18
  // For parameter server round-robin like hashing, do not split tensors.
武毅 已提交
19
  // Send and recv only one tensor
T
typhoonzero 已提交
20
  // TODO(typhoonzero): add streaming API
T
typhoonzero 已提交
21 22
  rpc SendVariable(VariableMessage) returns (VoidMessage) {}
  // Argument VariableMessage for GetVariable should only contain varname.
T
typhoonzero 已提交
23
  rpc GetVariable(VariableMessage) returns (VariableMessage) {}
Y
Yancey1989 已提交
24
  // pre-fetch variable by given variable name and Ids
25
  rpc PrefetchVariable(VariableMessage) returns (VariableMessage) {}
武毅 已提交
26 27 28 29 30 31
}

// VariableMessage is serialized paddle variable message.
// It can be:
// LoDTensor
// SelectedRows
Y
Yancey 已提交
32 33 34
enum VarType {
  LOD_TENSOR = 0;
  SELECTED_ROWS = 1;
T
typhoonzero 已提交
35
  NCCL_ID = 2;
Y
Yancey 已提交
36 37
}

38 39 40
// NOTICE(gongwb):don't modify this proto if you are not
//   not familar with how we serialize in sendrecvop_utils.h
//   and deserilize it in  variable_response.h.
武毅 已提交
41
message VariableMessage {
42 43 44 45 46 47 48 49 50 51 52 53
  enum Type {
    // Pod Types
    BOOL = 0;
    INT16 = 1;
    INT32 = 2;
    INT64 = 3;
    FP16 = 4;
    FP32 = 5;
    FP64 = 6;
  }

  message LodData { repeated int64 lod_data = 1; }
武毅 已提交
54
  string varname = 1;
Y
Yancey 已提交
55 56
  // TODO(Yancey1989): reference framework::proto::VarDesc::VarType
  VarType type = 2;
57 58 59 60 61 62 63 64
  // bool persistable is not needed for sending.
  // tensor info:
  Type data_type = 3;
  repeated int64 dims = 4;

  // lod details:
  int64 lod_level = 5;
  repeated LodData lod = 6;
65 66
  // selected_rows height, aka. original dim0
  int64 slr_height = 7;
67
  // tensor data
68
  bytes serialized = 8;
69
  // selected_rows data
70
  bytes rows = 9;
Y
Yancey1989 已提交
71
  // Look up table block execution output variable name.
Y
Yancey1989 已提交
72
  string out_varname = 10;
73 74 75 76
  // If true, the ps server will start profiling, the ps
  // server stops profiling and generates a profile to /tmp/profile_ps_*
  // when profile switches from true to false.
  bool profile = 11;
武毅 已提交
77 78
}

武毅 已提交
79
message VoidMessage {}