// Copyright (c) 2020 PaddlePaddle Authors. 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. syntax = "proto2"; package paddle.distributed; option cc_generic_services = true; option cc_enable_arenas = true; message FsClientParameter { enum FsApiType { HDFS = 0; AFS = 1; } optional FsApiType fs_type = 1 [ default = HDFS ]; optional string uri = 2; // such as afs://xxx.afs.com:9902 optional string user = 3; // user_name to access fs optional string passwd = 4; // password optional int32 buffer_size = 5; // buffer for read/write optional string hadoop_bin = 51; optional string afs_conf = 101; } message PSParameter { optional string worker_class = 1; optional string server_class = 2; optional string instance_class = 3; optional string init_gflags = 4 [ default = "" ]; optional WorkerParameter worker_param = 101; optional ServerParameter server_param = 102; repeated DownpourTrainerParameter trainer_param = 301; optional FsClientParameter fs_client_param = 501; } message WorkerParameter { optional DownpourWorkerParameter downpour_worker_param = 1; } message DownpourWorkerParameter { repeated TableParameter downpour_table_param = 1; } message DownpourServerParameter { repeated TableParameter downpour_table_param = 1; optional ServerServiceParameter service_param = 2; } message ServerParameter { optional DownpourServerParameter downpour_server_param = 1; } message DownpourTrainerParameter { repeated DenseTableParameter dense_table = 1; repeated SparseTableParameter sparse_table = 2; optional int32 push_sparse_per_batch = 3; optional int32 push_dense_per_batch = 4; repeated string skip_op = 5; repeated ProgramConfig program_config = 6; } message DenseTableParameter { optional int32 table_id = 1; repeated string dense_variable_name = 2; repeated string dense_gradient_variable_name = 3; optional int32 fea_dim = 4; } message SparseTableParameter { optional int32 table_id = 1; optional int32 feature_dim = 2; repeated string slot_key = 3; repeated string slot_value = 4; repeated string slot_gradient = 5; } message ServerServiceParameter { optional string server_class = 1 [ default = "BrpcPsServer" ]; optional string client_class = 2 [ default = "BrpcPsClient" ]; optional string service_class = 3 [ default = "BrpcPsService" ]; optional uint32 start_server_port = 4 [ default = 0 ]; // will find a avaliable port from it optional uint32 server_thread_num = 5 [ default = 12 ]; } message ProgramConfig { required string program_id = 1; repeated int32 push_sparse_table_id = 2; repeated int32 push_dense_table_id = 3; repeated int32 pull_sparse_table_id = 4; repeated int32 pull_dense_table_id = 5; } enum TableType { PS_SPARSE_TABLE = 0; PS_DENSE_TABLE = 1; PS_OTHER_TABLE = 2; } message TableParameter { optional uint64 table_id = 1; optional string table_class = 2; optional uint64 shard_num = 3 [ default = 1000 ]; optional TableAccessorParameter accessor = 4; optional TensorAccessorParameter tensor = 5; optional CommonAccessorParameter common = 6; optional TableType type = 7; optional bool compress_in_save = 8 [ default = true ]; optional GraphParameter graph_parameter = 9; // for cache model optional bool enable_sparse_table_cache = 10 [ default = true ]; optional double sparse_table_cache_rate = 11 [ default = 0.00055 ]; optional uint32 sparse_table_cache_file_num = 12 [ default = 16 ]; optional bool enable_revert = 13 [ default = true ]; optional float shard_merge_rate = 14 [ default = 1.0 ]; } message TableAccessorParameter { optional string accessor_class = 1; optional uint32 fea_dim = 4 [ default = 11 ]; // field size of one value optional uint32 embedx_dim = 5 [ default = 8 ]; // embedx feature size optional uint32 embedx_threshold = 6 [ default = 10 ]; // embedx feature create threshold optional CtrAccessorParameter ctr_accessor_param = 7; repeated TableAccessorSaveParameter table_accessor_save_param = 8; optional SparseCommonSGDRuleParameter embed_sgd_param = 10; optional SparseCommonSGDRuleParameter embedx_sgd_param = 11; optional GraphSGDParameter graph_sgd_param = 12; } message GraphSGDParameter { optional uint32 nodeid_slot = 1 [ default = 9008 ]; optional float feature_learning_rate = 2 [ default = 0.05 ]; } message CtrAccessorParameter { optional float nonclk_coeff = 1 [ default = 0.1 ]; // to calculate show_click_score optional float click_coeff = 2 [ default = 1 ]; // to calculate show_click_score optional float base_threshold = 3 [ default = 1.5 ]; // show_click_score > base_threshold, this feature can be saved optional float delta_threshold = 4 [ default = 0.25 ]; // delta_score > delta_threshold, this feature can be saved optional float delta_keep_days = 5 [ default = 16 ]; // unseen_day < delta_keep_days, this feature can be saved optional float show_click_decay_rate = 6 [ default = 0.98 ]; // show/click will update to show/click * show_click_decay_rate after a day optional float delete_threshold = 7 [ default = 0.8 ]; // threshold to shrink a feasign optional float delete_after_unseen_days = 8 [ default = 30 ]; // unseen_day > delete_after_unseen_days, this feature // will be delete in shrink_model optional int32 ssd_unseenday_threshold = 9 [ default = 1 ]; // threshold to save ssd optional bool show_scale = 10 [ default = true ]; } message TensorAccessorParameter { optional string feed_var_name = 1; optional string fetch_var_name = 2; optional int64 startup_program_id = 3; optional int64 main_program_id = 4; optional string tensor_table_class = 6; } message CommonAccessorParameter { optional string name = 1; optional string table_name = 2; repeated string attributes = 3; repeated string params = 4; repeated uint32 dims = 5; repeated string initializers = 6; optional string entry = 7; optional int32 trainer_num = 8; optional bool sync = 9; optional uint32 table_num = 10; optional uint32 table_dim = 11; } message TableAccessorSaveParameter { optional uint32 param = 1; optional string converter = 2; optional string deconverter = 3; } message SparseCommonSGDRuleParameter { optional string name = 1; optional SparseNaiveSGDRuleParameter naive = 2; optional SparseAdagradSGDRuleParameter adagrad = 3; optional SparseAdamSGDParameter adam = 4; } message SparseNaiveSGDRuleParameter { // SparseNaiveSGDRule optional double learning_rate = 1 [ default = 0.05 ]; optional double initial_range = 2 [ default = 0.0001 ]; repeated float weight_bounds = 3; } message SparseAdagradSGDRuleParameter { // SparseAdaGradSGDRule|StdAdaGradSGDRule optional double learning_rate = 1 [ default = 0.05 ]; optional double initial_g2sum = 2 [ default = 3.0 ]; optional double initial_range = 3 [ default = 0.0001 ]; repeated float weight_bounds = 4; } message SparseAdamSGDParameter { // SparseAdamSGDRule optional double learning_rate = 1 [ default = 0.001 ]; optional double initial_range = 2 [ default = 0.0001 ]; optional double beta1_decay_rate = 3 [ default = 0.9 ]; optional double beta2_decay_rate = 4 [ default = 0.999 ]; optional double ada_epsilon = 5 [ default = 1e-08 ]; repeated float weight_bounds = 6; } message GraphParameter { optional int32 task_pool_size = 1 [ default = 24 ]; repeated string edge_types = 2; repeated string node_types = 3; optional bool use_cache = 4 [ default = false ]; optional int32 cache_size_limit = 5 [ default = 100000 ]; optional int32 cache_ttl = 6 [ default = 5 ]; repeated GraphFeature graph_feature = 7; optional string table_name = 8 [ default = "" ]; optional string table_type = 9 [ default = "" ]; optional int32 shard_num = 10 [ default = 127 ]; optional int32 search_level = 11 [ default = 1 ]; optional bool build_sampler_on_cpu = 12 [ default = true ]; } message GraphFeature { repeated string name = 1; repeated string dtype = 2; repeated int32 shape = 3; } message FLParameter { optional FLStrategy fl_strategy = 1; optional FLClientInfo client_info = 2; } message FLStrategy { optional uint64 iteration_num = 1; optional uint64 client_id = 2; optional string next_state = 3 [default = "JOIN"]; optional string init_gflags = 4 [ default = "" ]; } message FLClientInfo { optional uint32 client_id = 1; optional string device_type = 2; optional int32 compute_capacity = 3; optional int32 bandwidth = 4; optional LocalTrainingResult local_training_result = 5; optional string init_gflags = 6 [ default = "" ]; } message LocalTrainingResult { optional double acc = 1; optional double loss = 2; }