文档导航¶
1. 通用文档变量¶
您会在所有FATE Flow
的文档看到如下文档变量
,其含义如下:
- FATE_PROJECT_BASE:表示
FATE项目
部署目录,包含配置、fate算法包、fate客户端以及子系统:bin
,conf
,examples
,fate
,fateflow
,fateboard
,eggroll
等 - FATE_BASE:表示
FATE
的部署目录,名称fate
,包含算法包、客户端:federatedml
,fate arch
,fate client
, 通常路径为${FATE_PROJECT_BASE}/fate
- FATE_FLOW_BASE:表示
FATE Flow
的部署目录,名称fateflow
,包含fate flow server
等, 通常路径为${FATE_PROJECT_BASE}/fateflow
- FATE_BOARD_BASE:表示
FATE Board
的部署目录,名称fateboard
,包含fateboard
, 通常路径为${FATE_PROJECT_BASE}/fateboard
-
EGGROLL_HOME:表示
EggRoll
的部署目录,名称eggroll
,包含rollsite
,clustermanager
,nodemanager
等, 通常路径为${FATE_PROJECT_BASE}/eggroll
参考
FATE项目
主仓库FederatedAI/FATE部署FATE项目
,主要目录结构如下: -
FATE_VERSION:表示
FATE
的版本号,如1.7.0 - FATE_FLOW_VERSION:表示
FATE Flow
的版本号,如1.7.0 - version:一般在部署文档中,表示
FATE项目
版本号,如1.7.0
,1.6.0
- version_tag:一般在部署文档中,表示
FATE项目
版本标签,如release
,rc1
,rc10
2. 术语表¶
party
, 站点,一般物理上指一个FATE单机或者FATE集群
job
, 作业
task
, 任务, 一个作业由多个任务构成
component
, 组件,静态名称,提交作业时需要两个描述配置文件,分别描述该作业需要执行的组件列表、组件依赖关系、组件运行参数
dsl
, 指用来描述作业中组件关系的语言, 可以描述组件列表以及组件依赖关系
component_name
: 提交作业时组件的名称,一个作业可以有多个同样的组件的,但是 component_name
是不一样的,相当于类的实例, 一个component_name
对应的组件会生成一个task
运行
componet_module_name
: 组件的类名
model_alias
: 跟 component_name
类似,就是用户在 dsl 里面是可以配置输出的 model 名称的
示例:
图中 dataio_0
是 component_name
,DataIO
是 componet_module_name
,dataio
是 model_alias
party status
, 指任务中每方的执行状态,status
是由所有方的party status
推断出,如所有party status
为success
,status
才为success