package secretflow.serving

Get desktop application:
View/edit binary Protocol Buffers messages

Description for channels between joined parties

Used in: ClusterConfig, kuscia.KusciaServingConfig.PartyConfig

• string protocol = 1

  https://github.com/apache/brpc/blob/master/docs/en/client.md#protocols

• int32 rpc_timeout_ms = 2

  Max duration of RPC. -1 means wait indefinitely. Default: 2000 (ms)

• int32 connect_timeout_ms = 3

  Max duration for a connect. -1 means wait indefinitely. Default: 500 (ms)

• optional TlsConfig tls_config = 4

  TLS related config.

• int32 handshake_max_retry_cnt = 5

  When the server starts, model information from all parties will be collected. At this time, the remote servers may not have started yet, and we need to retry. And if we connect gateway,the max waiting time for each operation will be rpc_timeout_ms + handshake_retry_interval_ms. Maximum number of retries, default: 60

• int32 handshake_retry_interval_ms = 6

  time between retries, default: 5000ms

Runtime config for a serving cluster

Used in: ServingConfig

• repeated PartyDesc parties = 1

• string self_id = 2

• optional ChannelDesc channel_desc = 3

Options of a csv feature source.

Used in: FeatureSourceConfig

• string file_path = 1

  Input file path, specifies where to load data Note that this will load all of the data into memory at once

• string id_name = 2

  Id column name, associated with FeatureParam::query_datas Query datas is a subset of id column

Used in: ModelConfig

• string dm_host = 1

  datamesh host.

• optional TlsConfig tls_config = 2

  TLS related config.

Config for a feature source

Used in: ServingConfig, kuscia.KusciaServingConfig.PartyConfig

• oneof options

  • MockOptions mock_opts = 1

  • HttpOptions http_opts = 2

  • CsvOptions csv_opts = 3

empty by design

Used in: ModelConfig

(message has no fields)

Options for a http feature source which should implement the feature service spi. The defined of spi can be found in secretflow_serving/spis/batch_feature_service.proto

Used in: FeatureSourceConfig

• string endpoint = 1

• bool enable_lb = 2

  Whether to enable round robin load balancer.

• int32 connect_timeout_ms = 3

  Max duration for a connect. -1 means wait indefinitely. Default: 500 (ms)

• int32 timeout_ms = 4

  Max duration of http request. -1 means wait indefinitely. Default: 1000 (ms)

• optional TlsConfig tls_config = 5

  TLS related config.

Used in: ModelConfig

• int32 connect_timeout_ms = 1

  Max duration for a connect. -1 means wait indefinitely. Default: 60 * 1000 (ms)

• int32 timeout_ms = 2

  Max duration of http request. -1 means wait indefinitely. Default: 120 * 1000 (ms)

• optional TlsConfig tls_config = 3

  TLS related config.

Serving log level

Used in: LoggingConfig

• INVALID_LOG_LEVEL = 0

  Placeholder for proto3 default value, do not use it.

• DEBUG_LOG_LEVEL = 1

  debug

• INFO_LOG_LEVEL = 2

  info

• WARN_LOG_LEVEL = 3

  warn

• ERROR_LOG_LEVEL = 4

  error

Serving log config options

• string system_log_path = 1

  system log default value: "serving.log"

• LogLevel log_level = 2

  default value: LogLevel.INFO_LOG_LEVEL

• int32 max_log_file_size = 3

  Byte. default value: 500 * 1024 * 1024 (500MB)

• int32 max_log_file_count = 4

  default value: 10

Used in: MockOptions

• INVALID_MOCK_DATA_TYPE = 0

  Placeholder for proto3 default value, do not use it.

• MDT_RANDOM = 1

  random value for each feature

• MDT_FIXED = 2

  fixed value for each feature

Options for a mock feature source. Mock feature source will generates values(random or fixed, according to type) for the desired features.

Used in: FeatureSourceConfig

• MockDataType type = 1

  default MDT_FIXED

Config for serving model

Used in: ServingConfig, kuscia.KusciaServingConfig.PartyConfig

• string model_id = 1

  Unique id of the model package

• string base_path = 2

  Path used to cache and load model package

• string source_path = 3

  The path to the model package in the data source, where the content format may vary depending on the `source_type`

• string source_sha256 = 4

  Optional. The expect sha256 of the model package

• SourceType source_type = 5

• oneof kind

  • FileSourceMeta file_source_meta = 6

  • OSSSourceMeta oss_source_meta = 7

  • HttpSourceMeta http_source_meta = 8

  • DPSourceMeta dp_source_meta = 9

Options for a Oss model source. Serving accesses data services using the AWS S3 protocol.

Used in: ModelConfig

• string access_key = 1

  Bucket access key

• string secret_key = 2

  Bucket secret key

• bool virtual_hosted = 3

  Whether to use virtual host mode, ref: https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html Defalut: False

• string endpoint = 4

• string bucket = 5

Description for a joined party

Used in: ClusterConfig

• string id = 1

  Unique id of the party

• string address = 2

  e.g. 127.0.0.1:9001

• string listen_address = 3

  Optional. Address will be used if listen_address is empty.

Used in: ServingConfig, kuscia.KusciaServingConfig.PartyConfig

• map<string, string> feature_mapping = 1

  Optional. Feature name mapping rules. Key: source or predefined feature name Value: model feature name

• optional TlsConfig tls_config = 2

  Whether to enable tls for server

• int32 brpc_builtin_service_port = 11

  Brpc builtin service listen port Default: disable service

• int32 metrics_exposer_port = 12

  Whether `/metrics` service is enable/disable.

• int32 worker_num = 13

  Number of pthreads that server runs on. If this option <= 0, use default value. Default: #cpu-cores

• int32 max_concurrency = 14

  Server-level max number of requests processed in parallel Default: 0 (unlimited)

• int32 op_exec_worker_num = 15

  Number of pthreads that server runs to execute ops. If this option <= 0, use default value. Default: #cpu-cores

Related config of serving

• string id = 1

  Unique id of the serving service

• optional ServerConfig server_conf = 2

• optional ModelConfig model_conf = 3

• optional ClusterConfig cluster_conf = 4

• optional FeatureSourceConfig feature_source_conf = 5

Supported model source type

Used in: ModelConfig

• INVALID_SOURCE_TYPE = 0

  Placeholder for proto3 default value, do not use it.

• ST_FILE = 1

  Local filesystem

• ST_OSS = 2

  OSS/AWS S3

• ST_HTTP = 3

  Http source

• ST_DP = 4

  DataProxy source

Used in: ChannelDesc, DPSourceMeta, HttpOptions, HttpSourceMeta, ServerConfig

• string certificate_path = 1

  Certificate file path

• string private_key_path = 2

  Private key file path

• string ca_file_path = 3

  The trusted CA file to verify the peer's certificate If empty, use the system default CA files