FATE-Flow Client 命令行使用说明¶
[ENG]
用法¶
在新版的FATE Flow命令行控制台中,我们将命令拆分成了多个类,包括 job,
data, model, component
等等。所有的命令将有一个共有调用入口,您可以在命令行中键入flow
以获取所有的命令分类及其子命令。
[IN]
flow
[OUT]
Usage: flow [OPTIONS] COMMAND [ARGS]...
Fate Flow Client
Options:
-h, --help Show this message and exit.
Commands:
component Component Operations
data Data Operations
init Flow CLI Init Command
job Job Operations
model Model Operations
queue Queue Operations
table Table Operations
task Task Operations
更多信息,请查阅文档或使用flow --help
命令。
初始化¶
init
¶
介绍: Fate Flow 命令行初始化命令。用户可选择提供fate服务器配置文件路径或指定fate服务器ip地址及端口进行初始化。注意:若用户同时使用上述两种方式进行初始化,CLI将优先读取配置文件内容,而用户所配置的服务器ip地址及端口信息将被忽略。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
conf_path |
|
|
否 |
FATE服务器配置文件路径 |
2 |
ip |
|
否 |
FATE服务器ip地址 |
|
3 |
port |
|
否 |
FATE服务器端口 |
|
4 |
reset |
|
否 |
如果指定,初始化信息将被重置 |
示例:
flow init -c /data/projects/fate/python/conf/service_conf.yaml
flow init --ip 127.0.0.1 --port 9380
Job¶
submit
¶
介绍: 提交执行pipeline任务。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
conf_path |
|
|
是 |
任务配置文件路径 |
2 |
dsl_path |
|
|
否 |
DSL文件路径. 如果任务为预测任务,该字段可以不输入。另外,用户可以提供可用的自定义DSL文件用于执行预测任务。 |
示例:
flow job submit -c fate_flow/examples/test_hetero_lr_job_conf.json -d fate_flow/examples/test_hetero_lr_job_dsl.json
stop
¶
介绍: 取消或终止指定任务。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
示例:
flow job stop -j $JOB_ID
query
¶
介绍: 检索任务信息。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
否 |
Job ID |
2 |
role |
|
|
否 |
角色 |
3 |
party_id |
|
|
否 |
Party ID |
4 |
status |
|
|
否 |
任务状态 |
示例:
flow job query -r guest -p 9999 -s complete flow job query -j $JOB_ID
view
¶
介绍: 检索任务数据视图。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
否 |
Job ID |
2 |
role |
|
|
否 |
角色 |
3 |
party_id |
|
|
否 |
Party ID |
4 |
status |
|
|
否 |
任务状态 |
示例:
flow job view -r guest -p 9999 flow job view -j $JOB_ID -s complete
config
¶
介绍: 下载指定任务的配置文件到指定目录。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
role |
|
|
是 |
角色 |
3 |
party_id |
|
|
是 |
Party ID |
4 |
output_path |
|
|
是 |
输出目录 |
示例:
flow job config -j $JOB_ID -r host -p 10000 --output-path ./examples/
log
¶
介绍: 下载指定任务的日志文件到指定目录。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
output_path |
|
|
是 |
输出目录 |
示例:
flow job log -j JOB_ID --output-path ./examples/
list
¶
介绍: 展示任务列表。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
limit |
|
|
否 |
返回数量限制(默认:10) |
示例:
flow job list
flow job list -l 30
dsl
¶
介绍: 预测DSL文件生成器。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
cpn_list |
|
否 |
用户指定组件名列表 |
|
2 |
cpn_path |
|
否 |
用户指定带有组件名列表的文件路径 |
|
3 |
train_dsl_path |
|
是 |
训练dsl文件路径 |
|
4 |
output_path |
|
|
否 |
输出目录路径 |
5 |
version |
|
|
否 |
DSL解析器版本(默认:1) |
示例:
flow job dsl --cpn-path fate_flow/examples/component_list.txt --train-dsl-path fate_flow/examples/test_hetero_lr_job_dsl.json --version 2
flow job dsl --cpn-path fate_flow/examples/component_list.txt --train-dsl-path fate_flow/examples/test_hetero_lr_job_dsl.json -o fate_flow/examples/
flow job dsl --cpn-list "dataio_0, hetero_feature_binning_0, hetero_feature_selection_0, evaluation_0" --train-dsl-path fate_flow/examples/test_hetero_lr_job_dsl.json -o fate_flow/examples/
flow job dsl --cpn-list [dataio_0,hetero_feature_binning_0,hetero_feature_selection_0,evaluation_0] --train-dsl-path fate_flow/examples/test_hetero_lr_job_dsl.json -o fate_flow/examples/
Component (TRACKING)¶
parameters
¶
介绍: 检索指定组件的参数。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
role |
|
|
是 |
角色 |
3 |
party_id |
|
|
是 |
Party ID |
4 |
component_name |
|
|
是 |
组件名 |
示例:
flow component parameters -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0
metric-all
¶
介绍: 检索指定任务的所有metric数据。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
role |
|
|
是 |
角色 |
3 |
party_id |
|
|
是 |
Party ID |
4 |
component_name |
|
|
是 |
组件名 |
示例:
flow component metric-all -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0
metrics
¶
介绍: 检索指定任务指定组件的metric数据。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
role |
|
|
是 |
角色 |
3 |
party_id |
|
|
是 |
Party ID |
4 |
component_name |
|
|
是 |
组件名 |
示例:
flow component metrics -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0
metric-delete
¶
介绍: 删除指定metric数据。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
date |
|
|
否 |
8位日期, 形如 ‘YYYYMMDD’ |
2 |
job_id |
|
|
否 |
Job ID |
示例:
# 注意:如果同时键入date参数与job_id参数,CLI将优先检测date参数数据,job_id参数将被忽略。
flow component metric-delete -d 20200101
flow component metric-delete -j $JOB_ID
output-model
¶
介绍: 检索指定组件模型。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
role |
|
|
是 |
角色 |
3 |
party_id |
|
|
是 |
Party ID |
4 |
component_name |
|
|
是 |
组件名 |
示例:
flow component output-model -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0
output-data
¶
介绍: 下载指定组件的输出数据。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
role |
|
|
是 |
角色 |
3 |
party_id |
|
|
是 |
Party ID |
4 |
component_name |
|
|
是 |
组件名 |
5 |
output_path |
|
|
是 |
输出目录 |
6 |
limit |
|
|
否 |
默认返回全部 |
示例:
flow component output-data -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0 --output-path ./examples/
output-data-table
¶
介绍: 查看数据表名及命名空间。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
role |
|
|
是 |
角色 |
3 |
party_id |
|
|
是 |
Party ID |
4 |
component_name |
|
|
是 |
组件名 |
示例:
flow component output-data-table -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0
list
¶
介绍: 展示指定任务的组件列表。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
示例:
flow component list -j $JOB_ID
get-summary
¶
介绍: 获取指定组件的概要。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
role |
|
|
是 |
角色 |
3 |
party_id |
|
|
是 |
Party ID |
4 |
component_name |
|
|
是 |
组件名 |
5 |
output_path |
|
|
否 |
输出目录路径 |
示例:
flow component get-summary -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0
flow component get-summary -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0 -o ./examples/
Model¶
load
¶
介绍: 加载模型。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
conf_path |
|
|
否 |
任务配置文件路径 |
2 |
job_id |
|
|
否 |
Job ID |
示例:
flow model load -c fate_flow/examples/publish_load_model.json
flow model load -j $JOB_ID
bind
¶
介绍: 绑定模型。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
conf_path |
|
|
是 |
任务配置文件路径 |
2 |
job_id |
|
|
否 |
Job ID |
示例:
flow model bind -c fate_flow/examples/bind_model_service.json
flow model bind -c fate_flow/examples/bind_model_service.json -j $JOB_ID
import
¶
介绍: 导入模型。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
conf_path |
|
|
是 |
任务配置文件路径 |
2 |
from-database |
–from-database |
否 |
如果指定且有可用的数据库环境,fate flow将从根据任务配置文件从数据库中导入模型。 |
示例:
flow model import -c fate_flow/examples/import_model.json
flow model import -c fate_flow/examples/restore_model.json --from-database
export
¶
介绍: 导出模型。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
conf_path |
|
|
是 |
任务配置文件路径 |
2 |
to-database |
|
否 |
如果指定且有可用的数据库环境,fate flow将从根据任务配置文件将模型导出到数据库中。 |
示例:
flow model export -c fate_flow/examples/export_model.json
flow model export -c fate_flow/examplse/store_model.json --to-database
migrate
¶
介绍: 迁移模型。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
conf_path |
|
|
是 |
任务配置文件路径 |
示例:
flow model migrate -c fate_flow/examples/migrate_model.json
tag-list
¶
介绍: 展示模型的标签列表。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
示例:
flow model tag-list -j $JOB_ID
tag-model
¶
介绍: 对模型添加标签。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
是 |
Job ID |
2 |
tag_name |
|
|
是 |
标签名 |
3 |
remove |
|
否 |
如果指定,带有指定标签名的标签将被模型的标签列表中移除 |
示例:
flow model tag-model -j $JOB_ID -t $TAG_NAME
flow model tag-model -j $JOB_ID -t $TAG_NAME --remove
Tag¶
create
¶
介绍: 创建标签。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
tag_name |
|
|
是 |
标签名 |
2 |
tag_参数介绍 |
|
|
否 |
标签介绍 |
示例:
flow tag create -t tag1 -d "This is the 参数介绍 of tag1."
flow tag create -t tag2
update
¶
介绍: 更新标签信息。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
tag_name |
|
|
是 |
标签名 |
2 |
new_tag_name |
|
否 |
新标签名 |
|
3 |
new_tag_参数介绍 |
|
否 |
新标签介绍 |
示例:
flow tag update -t tag1 --new-tag-name tag2
flow tag update -t tag1 --new-tag-desc "This is the new 参数介绍."
list
¶
介绍: 展示标签列表。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
limit |
|
|
否 |
返回结果数量限制(默认:10) |
示例:
flow tag list
flow tag list -l 3
query
¶
介绍: 检索标签。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
tag_name |
|
|
是 |
标签名 |
2 |
with_model |
|
否 |
如果指定,具有该标签的模型信息将被展示 |
示例:
flow tag query -t $TAG_NAME
flow tag query -t $TAG_NAME --with-model
delete
¶
介绍: 删除标签。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
tag_name |
|
|
是 |
标签名 |
示例:
flow tag delete -t tag1
Data¶
download
¶
介绍: 下载数据表。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
conf_path |
|
|
是 |
任务配置文件路径 |
示例:
flow data download -c fate_flow/examples/download_host.json
upload
¶
介绍: 上传数据表。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
conf_path |
|
|
是 |
任务配置文件路径 |
2 |
verbose |
|
否 |
如果指定,用户将在控制台获得上传进度(默认不开启) |
|
3 |
drop |
|
否 |
如果指定,旧版已上传数据将被新上传的同名数据替换(默认不替换) |
示例:
flow data upload -c fate_flow/examples/upload_guest.json
flow data upload -c fate_flow/examples/upload_host.json --verbose --drop
upload-history
¶
介绍: 检索上传数据历史。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
limit |
|
|
否 |
返回结果数量限制(默认:10) |
2 |
job_id |
|
|
否 |
Job ID |
示例:
flow data upload-history -l 20
flow data upload-history --job-id $JOB_ID
Task¶
query
¶
介绍: 检索Task信息。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
job_id |
|
|
否 |
Job ID |
2 |
role |
|
|
否 |
角色 |
3 |
party_id |
|
|
否 |
Party ID |
4 |
component_name |
|
|
否 |
组件名 |
5 |
status |
|
|
否 |
任务状态 |
示例:
flow task query -j $JOB_ID -p 9999 -r guest
flow task query -cpn hetero_feature_binning_0 -s complete
list
¶
介绍: 展示Task列表。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
limit |
|
|
否 |
返回结果数量限制(默认:10) |
示例:
flow task list
flow task list -l 25
Table¶
info
¶
介绍: 检索数据表信息。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
namespace |
|
|
是 |
命名空间 |
2 |
table_name |
|
|
是 |
数据表名 |
示例:
flow table info -n $NAMESPACE -t $TABLE_NAME
delete
¶
介绍: 删除指定数据表。
参数:
编号 |
参数 |
Flag_1 |
Flag_2 |
必要参数 |
参数介绍 |
---|---|---|---|---|---|
1 |
namespace |
|
|
否 |
命名空间 |
2 |
table_name |
|
|
否 |
数据表名 |
3 |
job_id |
|
|
否 |
Job ID |
4 |
role |
|
|
否 |
角色 |
5 |
party_id |
|
|
否 |
Party ID |
6 |
component_name |
|
|
否 |
组件名 |
示例:
flow table delete -n $NAMESPACE -t $TABLE_NAME
flow table delete -j $JOB_ID -r guest -p 9999