快速入门¶
1. 环境部署¶
以下三种模式可根据需求自行选择一种
1.1 Pypi包安装¶
说明：此方式的运行模式为单机模式
1.1.1 安装¶
- conda环境准备及安装
- 创建虚拟环境
# fate的运行环境为python>=3.8 conda create -n fate_env python=3.8 conda activate fate_env - 安装fate flow及相关依赖
pip install fate_client[fate,fate_flow]==2.0.0
1.1.2 服务初始化¶
fate_flow init --ip 127.0.0.1 --port 9380 --home $HOME_DIR
1.1.3 服务启停¶
fate_flow status/start/stop/restart
1.2 单机版部署¶
参考单机版部署
1.3 集群部署¶
2. 使用指南¶
fate提供的客户端包括SDK、CLI和Pipeline，若你的环境中没有部署FATE Client,可以使用pip install fate_client下载，以下的使用操作均基于cli编写。
2.1 数据上传¶
更详细的数据操作指南可参考：数据接入指南
2.1.1 配置及数据¶
- 上传配置: examples-upload
- 上传数据: upload-data
2.1.2 上传guest方数据¶
flow data upload -c examples/upload/upload_guest.json
2.1.3 上传host方数据¶
flow data upload -c examples/upload/upload_host.json
2.2 开始FATE作业¶
2.2.1 提交作业¶
当你的数据准备好后，可以开始提交作业给FATE Flow： - job配置example位于lr-train; - job配置中站点id为"9998"和"9999"。如果你的部署环境为集群版，需要替换成真实的站点id；单机版可使用默认配置。 - 如果想要使用自己的数据，可以更改配置中reader的参数。 - 提交作业的命令为:
flow job submit -c examples/lr/train_lr.yaml
{
"code": 0,
"data": {
"model_id": "202308211911505128750",
"model_version": "0"
},
"job_id": "202308211911505128750",
"message": "success"
}
2.2.2 查询作业¶
在作业的运行过程时，你可以通过查询命令获取作业的运行状态
flow job query -j $job_id
2.2.3 停止作业¶
在作业的运行过程时，你可以通过停止作业命令来终止当前作业
flow job stop -j $job_id
2.2.4 重跑作业¶
在作业的运行过程时，如果运行失败，你可以通过重跑命令来重跑当前作业
flow job rerun -j $job_id
2.3 获取作业输出结果¶
作业的输出包括数据、模型和指标
2.3.1 输出指标¶
查询输出指标命令：
flow output query-metric -j $job_id -r $role -p $party_id -tn $task_name
flow output query-metric -j 202308211911505128750 -r arbiter -p 9998 -tn lr_0查询。
查询结果如下:
{
"code": 0,
"data": [
{
"data": [
{
"metric": [
0.0
],
"step": 0,
"timestamp": 1692616428.253495
}
],
"groups": [
{
"index": null,
"name": "default"
},
{
"index": null,
"name": "train"
}
],
"name": "lr_loss",
"step_axis": "iterations",
"type": "loss"
},
{
"data": [
{
"metric": [
-0.07785049080848694
],
"step": 1,
"timestamp": 1692616432.9727712
}
],
"groups": [
{
"index": null,
"name": "default"
},
{
"index": null,
"name": "train"
}
],
"name": "lr_loss",
"step_axis": "iterations",
"type": "loss"
}
],
"message": "success"
}
2.3.2 输出模型¶
2.3.2.1 查询模型¶
flow output query-model -j $job_id -r $role -p $party_id -tn $task_name
flow output query-model -j 202308211911505128750 -r host -p 9998 -tn lr_0查询。
查询结果如下：
{
"code": 0,
"data": {
"output_model": {
"data": {
"estimator": {
"end_epoch": 10,
"is_converged": false,
"lr_scheduler": {
"lr_params": {
"start_factor": 0.7,
"total_iters": 100
},
"lr_scheduler": {
"_get_lr_called_within_step": false,
"_last_lr": [
0.07269999999999996
],
"_step_count": 10,
"base_lrs": [
0.1
],
"end_factor": 1.0,
"last_epoch": 9,
"start_factor": 0.7,
"total_iters": 100,
"verbose": false
},
"method": "linear"
},
"optimizer": {
"alpha": 0.001,
"l1_penalty": false,
"l2_penalty": true,
"method": "sgd",
"model_parameter": [
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
],
[
0.0
]
],
"model_parameter_dtype": "float32",
"optim_param": {
"lr": 0.1
},
"optimizer": {
"param_groups": [
{
"dampening": 0,
"differentiable": false,
"foreach": null,
"initial_lr": 0.1,
"lr": 0.07269999999999996,
"maximize": false,
"momentum": 0,
"nesterov": false,
"params": [
0
],
"weight_decay": 0
}
],
"state": {}
}
},
"param": {
"coef_": [
[
-0.10828543454408646
],
[
-0.07341302931308746
],
[
-0.10850320011377335
],
[
-0.10066638141870499
],
[
-0.04595951363444328
],
[
-0.07001449167728424
],
[
-0.08949052542448044
],
[
-0.10958756506443024
],
[
-0.04012322425842285
],
[
0.02270071767270565
],
[
-0.07198350876569748
],
[
0.00548586156219244
],
[
-0.06599288433790207
],
[
-0.06410090625286102
],
[
0.016374297440052032
],
[
-0.01607361063361168
],
[
-0.011447405442595482
],
[
-0.04352564364671707
],
[
0.013161249458789825
],
[
0.013506329618394375
]
],
"dtype": "float32",
"intercept_": null
}
}
},
"meta": {
"batch_size": null,
"epochs": 10,
"init_param": {
"fill_val": 0.0,
"fit_intercept": false,
"method": "zeros",
"random_state": null
},
"label_count": false,
"learning_rate_param": {
"method": "linear",
"scheduler_params": {
"start_factor": 0.7,
"total_iters": 100
}
},
"optimizer_param": {
"alpha": 0.001,
"method": "sgd",
"optimizer_params": {
"lr": 0.1
},
"penalty": "l2"
},
"ovr": false
}
}
},
"message": "success"
}
2.3.2.2 下载模型¶
flow output download-model -j $job_id -r $role -p $party_id -tn $task_name -o $download_dir
flow output download-model -j 202308211911505128750 -r host -p 9998 -tn lr_0 -o ./下载。
下载结果如下：
{
"code": 0,
"directory": "./output_model_202308211911505128750_host_9998_lr_0",
"message": "download success, please check the path: ./output_model_202308211911505128750_host_9998_lr_0"
}
2.3.3 输出数据¶
2.3.3.1 查询数据表¶
flow output query-data-table -j $job_id -r $role -p $party_id -tn $task_name
flow output query-data-table -j 202308211911505128750 -r host -p 9998 -tn binning_0查询。
查询结果如下：
{
"train_output_data": [
{
"name": "9e28049c401311ee85c716b977118319",
"namespace": "202308211911505128750_binning_0"
}
]
}
2.3.3.2 预览数据¶
flow output display-data -j $job_id -r $role -p $party_id -tn $task_name
flow output display-data -j 202308211911505128750 -r host -p 9998 -tn binning_0预览输出数据。
2.3.3.3 下载数据¶
flow output download-data -j $job_id -r $role -p $party_id -tn $task_name -o $download_dir
flow output download-data -j 202308211911505128750 -r guest -p 9999 -tn lr_0 -o ./下载输出数据。
下载结果如下：
{
"code": 0,
"directory": "./output_data_202308211911505128750_guest_9999_lr_0",
"message": "download success, please check the path: ./output_data_202308211911505128750_guest_9999_lr_0"
}