扩展标准#

目录#

cluster.proto#

data.proto#

cluster.proto#

Proto file: secretflow/protos/secretflow/spec/extend/cluster.proto

Messages#

SFClusterConfig#

SecretFlow 集群的运行时配置。除了内在的 SFClusterDesc 外,还提供了动态网络配置

Field

Type

Description

desc

SFClusterDesc

内在属性。

public_config

SFClusterConfig.PublicConfig

动态运行时公共配置。

private_config

SFClusterConfig.PrivateConfig

动态运行时私有配置。

SFClusterConfig.PrivateConfig#

对于每个参与方都不同。对于每个参与方是私有且唯一的。

Field

Type

Description

self_party

string

none

ray_head_addr

string

none

SFClusterConfig.PublicConfig#

对所有参与方公开且共享的。

Field

Type

Description

ray_fed 配置。

SFClusterConfig.RayFedConfig

none

spu_configs

repeated SFClusterConfig.SPUConfig

none

SFClusterConfig.RayFedConfig#

每个参与方的 RayFed 集群地址。

Field

Type

Description

parties

repeated string

none

addresses

repeated string

none

listen_addresses

repeated string

none

SFClusterConfig.SPUConfig#

包含一个 SPU 设备的地址。

Field

Type

Description

name

string

应与 SFClusterDesc.devices 中的 SPU 名称匹配

parties

repeated string

none

addresses

repeated string

none

listen_addresses

repeated string

none

SFClusterDesc#

SecretFlow 集群的内在属性,包括

  • 版本信息。

  • 参与计算的各方。

  • 包括秘密设备及其配置

Field

Type

Description

sf_version

string

SecretFlow版本

py_version

string

Python 版本

parties

repeated string

参与实体. e.g. [“alice”, “bob”,…].

devices

repeated SFClusterDesc.DeviceDesc

秘密设备的描述

ray_fed 配置。

SFClusterDesc.RayFedConfig

none

SFClusterDesc.DeviceDesc#

一个秘密设备的描述。

  • PYU 不需要声明,因为它们是明文设备。

  • 配置说明:目前,您必须为不同的设备提供一个 JSON 字符串。我们将在未来规范化此部分。

    • 示例 SPU 配置:

  {
    "runtime_config": {
        "protocol": "REF2K",
        "field": "FM64"
    },
    "link_desc": {
        "connect_retry_times": 60,
        "connect_retry_interval_ms": 1000,
        "brpc_channel_protocol": "http",
        "brpc_channel_connection_type": "pooled",
        "recv_timeout_ms": 1200000,
        "http_timeout_ms": 1200000
    }
}

参考: SPU | HEU

Field

Type

Description

name

string

设备名称。

type

string

可选: SPU, HEU, TEEU.

parties

repeated string

设备组成各方。

config

string

秘密设备的特别配置。

SFClusterDesc.RayFedConfig#

Field

Type

Description

cross_silo_comm_backend

string

Indicates communication backend of RayFed. Accepted: ‘grpc’, ‘brpc_link’ Dafault is ‘grpc’

Enums#

data.proto#

Proto file: secretflow/protos/secretflow/spec/extend/data.proto

Messages#

DeviceObjectCollection#

描述设备对象集合的公共存储信息。

Field

Type

Description

objs

repeated DeviceObjectCollection.DeviceObject

none

public_info

string

任何公共信息。

DeviceObjectCollection.DeviceObject#

Field

Type

Description

type

string

可选: spu | pyu

data_ref_idxs

repeated int32

data_ref 在父级 DistData 消息中的索引。

Enums#