Skip to content

Commit

Permalink
update quick start
Browse files Browse the repository at this point in the history 
Signed-off-by: zhihuiwan <[email protected]>
  • Loading branch information
@zhihuiwan
zhihuiwan committed Sep 15, 2023
1 parent fcc319c commit 682c59e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
20 changes: 10 additions & 10 deletions doc/quick_start.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ fate_flow status/start/stop/restart
```

### 1.2 Standalone Deployment
Refer to [Standalone Deployment](https://github.com/FederatedAI/FATE/blob/dev-2.0.0-beta/deploy/standalone-deploy/README.zh.md).
Refer to [Standalone Deployment](https://github.com/FederatedAI/FATE/tree/v2.0.0-beta/deploy/standalone-deploy/README.zh.md).

### 1.3 Cluster Deployment
Refer to [All-in-one Deployment](https://github.com/FederatedAI/FATE/blob/dev-2.0.0-beta/deploy/cluster-deploy/allinone/fate-allinone_deployment_guide.zh.md).
Refer to [Allinone Deployment](https://github.com/FederatedAI/FATE/tree/v2.0.0-beta/deploy/cluster-deploy/allinone/fate-allinone_deployment_guide.zh.md).

## 2. User Guide
FATE provides client tools including SDK, CLI, and Pipeline. If you don't have FATE Client deployed in your environment, you can download it using `pip install fate_client`. The following operations are based on CLI.
Expand All @@ -49,7 +49,7 @@ In version 2.0-beta, data uploading is a two-step process:

#### 2.1.1 upload
##### 2.1.1.1 Configuration and Data
- Upload configuration can be found at [examples-upload](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/upload), and the data is located at [upload-data](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/data).
- Upload configuration can be found at [examples-upload](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/upload), and the data is located at [upload-data](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/data).
- You can also use your own data and modify the "meta" information in the upload configuration.

##### 2.1.1.2 Upload Guest Data
Expand Down Expand Up @@ -87,7 +87,7 @@ If the returned code is 0, the upload was successful.

#### 2.1.2 Transformer
##### 2.1.2.1 Configuration
- Transformer configuration can be found at [examples-transformer](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/transformer).
- Transformer configuration can be found at [examples-transformer](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/transformer).

##### 2.1.2.2 Transform Guest Data
- Configuration path: examples/transformer/transformer_guest.json
Expand Down Expand Up @@ -131,8 +131,8 @@ If the returned code is 0, the upload was successful.
#### 2.2.1 Submitting a Job
Once your data is prepared, you can start submitting jobs to FATE Flow:

- The configuration for training jobs can be found in [lr-train](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/lr/train_lr.yaml).
- The configuration for prediction jobs can be found in [lr-predict](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/lr/predict_lr.yaml). To use it, modify the "dag.conf.model_warehouse" to point to the output model of your training job.
- The configuration for training jobs can be found in [lr-train](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/lr/train_lr.yaml).
- The configuration for prediction jobs can be found in [lr-predict](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/lr/predict_lr.yaml). To use it, modify the "dag.conf.model_warehouse" to point to the output model of your training job.
- In the training and prediction job configurations, the site IDs are set to "9998" and "9999." If your deployment environment is the cluster version, you need to replace them with the actual site IDs. For the standalone version, you can use the default configuration.
- If you want to use your own data, you can change the "namespace" and "name" of "data_warehouse" for both the guest and host in the configuration.
- To submit a job, use the following command:
Expand Down Expand Up @@ -325,7 +325,7 @@ The download result will be as follows:
```

## 3. More Documentation
- [Restful-api](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/doc/swagger/swagger.yaml)
- [CLI](https://github.com/FederatedAI/FATE-Client/blob/dev-2.0.0-beta/python/fate_client/flow_cli/build/doc)
- [Pipeline](https://github.com/FederatedAI/FATE/tree/dev-2.0.0-beta/doc/tutorial)
- [FATE Algorithms](https://github.com/FederatedAI/FATE/tree/dev-2.0.0-beta/doc/2.0/components)
- [Restful-api](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/doc/swagger/swagger.yaml)
- [CLI](https://github.com/FederatedAI/FATE-Client/tree/v2.0.0-beta/python/fate_client/flow_cli/build/doc)
- [Pipeline](https://github.com/FederatedAI/FATE/tree/v2.0.0-beta/doc/tutorial)
- [FATE Algorithms](https://github.com/FederatedAI/FATE/tree/v2.0.0-beta/doc/2.0/components)
20 changes: 10 additions & 10 deletions doc/quick_start.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ fate_flow status/start/stop/restart
```

### 1.2 单机版部署
参考[单机版部署](https://github.com/FederatedAI/FATE/blob/dev-2.0.0-beta/deploy/standalone-deploy/README.zh.md)
参考[单机版部署](https://github.com/FederatedAI/FATE/tree/v2.0.0-beta/deploy/standalone-deploy/README.zh.md)

### 1.3 集群部署
参考[allinone部署](https://github.com/FederatedAI/FATE/blob/dev-2.0.0-beta/deploy/cluster-deploy/allinone/fate-allinone_deployment_guide.zh.md)
参考[allinone部署](https://github.com/FederatedAI/FATE/tree/v2.0.0-beta/deploy/cluster-deploy/allinone/fate-allinone_deployment_guide.zh.md)

## 2. 使用指南
fate提供的客户端包括SDK、CLI和Pipeline，若你的环境中没有部署FATE Client,可以使用`pip install fate_client`下载，以下的使用操作均基于cli编写。
Expand All @@ -45,7 +45,7 @@ fate提供的客户端包括SDK、CLI和Pipeline，若你的环境中没有部
- transformer: 将数据转化成dataframe
#### 2.1.1 upload
#### 2.1.1.1 配置及数据
- 上传配置位于[examples-upload](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/upload)，上传数据位于[upload-data](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/data)
- 上传配置位于[examples-upload](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/upload)，上传数据位于[upload-data](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/data)
- 你也可以使用自己的数据，并修改upload配置中的"meta"信息。
#### 2.1.1.2 上传guest方数据
```shell
Expand Down Expand Up @@ -117,7 +117,7 @@ flow table query --namespace upload --name 36491bc8-3fef-11ee-be05-16b977118319

#### 2.1.2 transformer
#### 2.1.2.1 配置
- transformer配置位于[examples-transformer](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/transformer)
- transformer配置位于[examples-transformer](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/transformer)
#### 2.1.2.2 transformer guest
- 配置路径位于： examples/transformer/transformer_guest.json
- 修改配置中"data_warehouse"的"namespace"和"name"：上面upload guest阶段的输出
Expand Down Expand Up @@ -158,8 +158,8 @@ flow table query --namespace experiment --name breast_hetero_host
### 2.2 开始FATE作业
#### 2.2.1 提交作业
当你的数据准备好后，可以开始提交作业给FATE Flow：
- 训练job配置example位于[lr-train](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/lr/train_lr.yaml);
- 预测job配置example位于[lr-predict](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/examples/lr/predict_lr.yaml);预测任务需要修改"dag.conf.model_warehouse"成训练作业的输出模型。
- 训练job配置example位于[lr-train](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/lr/train_lr.yaml);
- 预测job配置example位于[lr-predict](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/examples/lr/predict_lr.yaml);预测任务需要修改"dag.conf.model_warehouse"成训练作业的输出模型。
- 训练和预测job配置中站点id为"9998"和"9999"。如果你的部署环境为集群版，需要替换成真实的站点id；单机版可使用默认配置。
- 如果想要使用自己的数据，可以更改配置中guest和host的data_warehouse的namespace和name
- 提交作业的命令为:
Expand Down Expand Up @@ -555,7 +555,7 @@ flow output download-data -j $job_id -r $role -p $party_id -tn $task_name -o $do
```

## 3.更多文档
- [Restful-api](https://github.com/FederatedAI/FATE-Flow/tree/dev-2.0-beta/doc/swagger/swagger.yaml)
- [CLI](https://github.com/FederatedAI/FATE-Client/blob/dev-2.0.0-beta/python/fate_client/flow_cli/build/doc)
- [Pipeline](https://github.com/FederatedAI/FATE/tree/dev-2.0.0-beta/doc/tutorial)
- [FATE算法](https://github.com/FederatedAI/FATE/tree/dev-2.0.0-beta/doc/2.0/components)
- [Restful-api](https://github.com/FederatedAI/FATE-Flow/tree/v2.0.0-beta/doc/swagger/swagger.yaml)
- [CLI](https://github.com/FederatedAI/FATE-Client/tree/v2.0.0-beta/python/fate_client/flow_cli/build/doc)
- [Pipeline](https://github.com/FederatedAI/FATE/tree/v2.0.0-beta/doc/tutorial)
- [FATE算法](https://github.com/FederatedAI/FATE/tree/v2.0.0-beta/doc/2.0/components)

0 comments on commit 682c59e

Please sign in to comment.