package easyfl.pb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Operate (OperateRequest, OperateResponse)

  client_service.proto:52

  message OperateRequest

  client_service.proto:12

  • OperationType type = 1

    Operation type: train or test

  • bytes model = 2

    Model parameters for client to start next round of training

  • int32 data_index = 3

    Data index for selecting data partition for training. Optional, depends on the data loading type of client.

  • optional OperateConfig config = 4

    Configs for executing operation

  message OperateResponse

  client_service.proto:47

  • optional Status status = 1

• rpc Upload (UploadRequest, UploadResponse)

  server_service.proto:60

  message UploadRequest

  server_service.proto:6

  • string task_id = 1

  • int32 round_id = 2

  • string client_id = 3

  • optional UploadContent content = 4

  message UploadResponse

  server_service.proto:31

  • optional Status status = 1

• rpc Run (RunRequest, RunResponse)

  server_service.proto:61

  message RunRequest

  server_service.proto:35

  • bytes model = 1

  • repeated Client clients = 2

    Optional, run server with provided clients.

  • string etcd_addresses = 3

    [Deprecated] Optional, run server with client addresses getting from etcd.

  message RunResponse

  server_service.proto:43

  • optional Status status = 1

• rpc Stop (StopRequest, StopResponse)

  server_service.proto:62

  message StopRequest

  server_service.proto:47

  (message has no fields)

  message StopResponse

  server_service.proto:49

  • optional Status status = 1

• rpc TrackTaskMetric (TrackTaskMetricRequest, TrackTaskMetricResponse)

  tracking_service.proto:105

  message TrackTaskMetricRequest

  tracking_service.proto:6

  • optional TaskMetric task_metric = 1

  message TrackTaskMetricResponse

  tracking_service.proto:10

  • optional Status status = 1

• rpc TrackRoundMetric (TrackRoundMetricRequest, TrackRoundMetricResponse)

  tracking_service.proto:106

  message TrackRoundMetricRequest

  tracking_service.proto:14

  • optional RoundMetric round_metric = 1

  message TrackRoundMetricResponse

  tracking_service.proto:18

  • optional Status status = 1

• rpc TrackClientMetric (TrackClientMetricRequest, TrackClientMetricResponse)

  tracking_service.proto:107

  message TrackClientMetricRequest

  tracking_service.proto:22

  • repeated ClientMetric client_metrics = 1

  message TrackClientMetricResponse

  tracking_service.proto:26

  • optional Status status = 1

• rpc TrackClientTrainMetric (TrackClientTrainMetricRequest, TrackClientTrainMetricResponse)

  tracking_service.proto:109

  message TrackClientTrainMetricRequest

  tracking_service.proto:31

  • string task_id = 1

  • int32 round_id = 2

  • string client_id = 3

  • repeated float train_loss = 4

  • float train_time = 5

  • float train_upload_time = 6

  • float train_download_size = 7

  • float train_upload_size = 8

  message TrackClientTrainMetricResponse

  tracking_service.proto:42

  • optional Status status = 1

• rpc TrackClientTestMetric (TrackClientTestMetricRequest, TrackClientTestMetricResponse)

  tracking_service.proto:110

  message TrackClientTestMetricRequest

  tracking_service.proto:46

  • string task_id = 1

  • int32 round_id = 2

  • string client_id = 3

  • float test_accuracy = 4

  • float test_loss = 5

  • float test_time = 6

  • float test_upload_time = 7

  • float test_download_size = 8

  message TrackClientTestMetricResponse

  tracking_service.proto:57

  • optional Status status = 1

• rpc GetRoundMetrics (GetRoundMetricsRequest, GetRoundMetricsResponse)

  tracking_service.proto:112

  message GetRoundMetricsRequest

  tracking_service.proto:77

  • string task_id = 1

  • repeated int32 rounds = 2

    empty list means get all rounds;

  message GetRoundMetricsResponse

  tracking_service.proto:83

  • string task_id = 1

  • int32 round_id = 2

  • repeated RoundMetric metrics = 3

  • optional Status status = 4

• rpc GetClientMetrics (GetClientMetricsRequest, GetClientMetricsResponse)

  tracking_service.proto:113

  message GetClientMetricsRequest

  tracking_service.proto:90

  • string task_id = 1

  • int32 round_id = 2

  • repeated string client_ids = 3

  message GetClientMetricsResponse

  tracking_service.proto:96

  • string task_id = 1

  • int32 round_id = 2

  • repeated ClientMetric metrics = 3

  • optional Status status = 4

• rpc GetRoundTrainTestTime (GetRoundTrainTestTimeRequest, GetRoundTrainTestTimeResponse)

  tracking_service.proto:114

  message GetRoundTrainTestTimeRequest

  tracking_service.proto:61

  • string task_id = 1

  • int32 rounds = 2

  • int32 interval = 3

  message GetRoundTrainTestTimeResponse

  tracking_service.proto:72

  • repeated TrainTestTime train_test_times = 1

  • optional Status status = 2

Used in: RunRequest

• string client_id = 1

• string address = 2

• int32 index = 3

Used in: GetClientMetricsResponse, TrackClientMetricRequest, UploadContent

• string task_id = 1

• int32 round_id = 2

• string client_id = 3

• repeated float train_accuracy = 4

• repeated float train_loss = 5

• float test_accuracy = 6

• float test_loss = 7

• float train_time = 8

• float test_time = 9

• float train_upload_time = 10

• float test_upload_time = 11

• float train_upload_size = 12

• float train_download_size = 13

• float test_upload_size = 14

• float test_download_size = 15

• string extra = 16

Used in: UploadContent

• DATA_TYPE_PARAMS = 0

  Model parameters or gradients

• DATA_TYPE_PERFORMANCE = 1

  Performance

Used in: OperateRequest

• int32 batch_size = 1

• int32 local_epoch = 2

• int64 seed = 3

• optional Optimizer optimizer = 4

• bool local_test = 5

  Whether execute test before uploading model.

• string task_id = 6

  task id for current operation

• int32 round_id = 7

  round id for current operation

• bool track = 8

  whether to track clients

• int32 test_batch_size = 9

  testing batch size

Used in: OperateRequest

• OP_TYPE_TRAIN = 0

• OP_TYPE_TEST = 1

Used in: OperateConfig

• string type = 1

• float lr = 2

• float momentum = 3

• float accuracy = 1

• float loss = 2

Used in: GetRoundMetricsResponse, TrackRoundMetricRequest

• string task_id = 1

• int32 round_id = 2

• float test_accuracy = 3

• float test_loss = 4

• float round_time = 5

• float train_time = 6

• float test_time = 7

• float train_distribute_time = 8

• float test_distribute_time = 9

• float train_upload_size = 10

• float train_download_size = 11

• float test_upload_size = 12

• float test_download_size = 13

• string extra = 14

Used in: GetClientMetricsResponse, GetRoundMetricsResponse, GetRoundTrainTestTimeResponse, OperateResponse, RunResponse, StopResponse, TrackClientMetricResponse, TrackClientTestMetricResponse, TrackClientTrainMetricResponse, TrackRoundMetricResponse, TrackTaskMetricResponse, UploadResponse

• StatusCode code = 1

• string message = 2

Used in: Status

• SC_OK = 0

• SC_UNKNOWN = 1

• SC_INVALID_REQUEST = 2

• SC_DEADLINE_EXCEEDED = 3

• SC_NOT_FOUND = 4

• SC_ALREADY_EXISTS = 5

Used in: TrackTaskMetricRequest

• string task_id = 1

• string configuration = 2

Used in: GetRoundTrainTestTimeResponse

• int32 round_id = 1

• float time = 2

Used in: UploadRequest

• bytes data = 1

  Data is the marshaled data, value depends on data type.

• DataType type = 2

  Type of data.

• int64 data_size = 3

  optional, number of data point

• optional ClientMetric metric = 4

  optional, client metric

• bytes extra = 99

  optional, extra upload content