flow 命令的安装与使用

灰太狼 2022-09-07 12:16 424阅读 0赞

### 文章目录 ###

*  1 安装
 *  2 初始化
 *  3 Data
 *   *   *  \`download\`
         *  \`upload\`
         *  \`upload-history\`
     *  
 *  3 Job
 *   *   *  \`submit\`
         *  \`stop\`
         *  \`query\`
         *  \`view\`
         *  \`config\`
         *  \`log\`
         *  \`list\`
         *  \`dsl\`
 *  4 Model
 *   *   *  \`load\`
         *  \`bind\`
         *  \`import\`
         *  \`export\`
         *  \`migrate\`
         *  \`tag-list\`
         *  \`tag-model\`
         *  \`deploy\`
         *  \`get-predict-dsl\`
         *  \`get-predict-conf\`
         *  \`get-model-info\`
     *  
 *  5 Component (TRACKING)
 *   *   *  \`parameters\`
         *  \`metric-all\`
         *  \`metrics\`
         *  \`metric-delete\`
         *  \`output-model\`
         *  \`output-data\`
         *  \`output-data-table\`
         *  \`list\`
         *  \`get-summary\`
 *  6 Task
 *   *   *  \`query\`
         *  \`list\`
 *  7 Table
 *   *   *  \`info\`
         *  \`delete\`
 *  8 Queue
 *   *   *  \`clean\`

# 1 安装 #

pip install fate-client

如果觉得下载速度太慢可以考虑指定国内源，例：

pip install fate-client -i https://pypi.tuna.tsinghua.edu.cn/simple

# 2 初始化 #

**init**

*  *介绍*： Fate Flow 命令行初始化命令。用户可选择提供fate服务器配置文件路径或指定fate服务器ip地址及端口进行初始化。注意：若用户同时使用上述两种方式进行初始化，CLI将优先读取配置文件内容，而用户所配置的服务器ip地址及端口信息将被忽略。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>conf_path</td> 
   <td><code>-c</code></td> 
   <td><code>--server-conf-path</code></td> 
   <td>否</td> 
   <td>FATE服务器配置文件路径</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>ip</td> 
   <td></td> 
   <td><code>--ip</code></td> 
   <td>否</td> 
   <td>FATE服务器ip地址</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>port</td> 
   <td></td> 
   <td><code>--port</code></td> 
   <td>否</td> 
   <td>FATE服务器端口</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>reset</td> 
   <td></td> 
   <td><code>--reset</code></td> 
   <td>否</td> 
   <td>如果指定，初始化信息将被重置</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

# configure values in conf/service_conf.yaml
    flow init -c /data/projects/fate/conf/service_conf.yaml
    # alternatively, input real ip address and port info to initialize cli
    flow init --ip 127.0.0.1 --port 9380

单机版没有.yaml文件，所以只能使用第二种初始化方式，我在集群部署时，使用第二种初始化后，flow命令一直无法使用，所以使用第一种初始化方式。

![image-20210823113102859][]

**upload**

*  *介绍*： 上传数据表。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>conf_path</td> 
   <td><code>-c</code></td> 
   <td><code>--conf-path</code></td> 
   <td>是</td> 
   <td>任务配置文件路径</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>verbose</td> 
   <td></td> 
   <td><code>--verbose</code></td> 
   <td>否</td> 
   <td>如果指定，用户将在控制台获得上传进度（默认不开启）</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>drop</td> 
   <td></td> 
   <td><code>--drop</code></td> 
   <td>否</td> 
   <td>如果指定，旧版已上传数据将被新上传的同名数据替换（默认不替换）</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow data upload -c fate_flow/examples/upload_guest.json
    flow data upload -c fate_flow/examples/upload_host.json --verbose --drop

![image-20210823113514141][]

# 3 Data #

### `download` ###

*  *介绍*： 下载数据表。
 *  *参数*：

*  *示例*：

flow data download -c fate_flow/examples/download_host.json

### `upload` ###

*  *介绍*： 上传数据表。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>conf_path</td> 
   <td><code>-c</code></td> 
   <td><code>--conf-path</code></td> 
   <td>是</td> 
   <td>任务配置文件路径</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>verbose</td> 
   <td></td> 
   <td><code>--verbose</code></td> 
   <td>否</td> 
   <td>如果指定，用户将在控制台获得上传进度（默认不开启）</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>drop</td> 
   <td></td> 
   <td><code>--drop</code></td> 
   <td>否</td> 
   <td>如果指定，旧版已上传数据将被新上传的同名数据替换（默认不替换）</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow data upload -c fate_flow/examples/upload_guest.json
    flow data upload -c fate_flow/examples/upload_host.json --verbose --drop

upload\_guest.json的内容：

{ 
      "file": "examples/data/breast_homo_guest.csv",
      "head": 1,
      "partition": 10,
      "work_mode": 0,
      "namespace": "experiment",
      "table_name": "breast_homo_guest"
    }

字段说明：

1.  file: 文件路径
2.  table\_name&namespace: 存储数据表的标识符号
3.  head: 指定数据文件是否包含表头
4.  partition: 指定用于存储数据的分区数
5.  work\_mode: 指定工作模式，0代表单机版，1代表集群版
6.  backend: 指定后端，0代表EGGROLL， 1代表SPARK加RabbitMQ， 2代表SPARK加Pulsar

### `upload-history` ###

*  *介绍*： 检索上传数据历史。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>limit</td> 
   <td><code>-l</code></td> 
   <td><code>--limit</code></td> 
   <td>否</td> 
   <td>返回结果数量限制（默认：10）</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>否</td> 
   <td>Job ID</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow data upload-history -l 20
    flow data upload-history --job-id $JOB_ID

##  ##

# 3 Job #

### `submit` ###

*  *介绍*： 提交执行pipeline任务。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>conf_path</td> 
   <td><code>-c</code></td> 
   <td><code>--conf-path</code></td> 
   <td>是</td> 
   <td>任务配置文件路径</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>dsl_path</td> 
   <td><code>-d</code></td> 
   <td><code>--dsl-path</code></td> 
   <td>否</td> 
   <td>DSL文件路径. 如果任务为预测任务，该字段可以不输入。另外，用户可以提供可用的自定义DSL文件用于执行预测任务。</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow job submit -c test_homolr_train_job_conf.json -d test_homolr_train_job_dsl.json

![image-20210823133333517][]

### `stop` ###

*  *介绍*： 取消或终止指定任务。
 *  *参数*：

*  *示例*：
    
        flow job stop -j $JOB_ID

### `query` ###

*  *介绍*： 检索任务信息。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>否</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>否</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>否</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>status</td> 
   <td><code>-s</code></td> 
   <td><code>--status</code></td> 
   <td>否</td> 
   <td>任务状态</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：
    
        flow job query -r guest -p 9999 -s complete
        flow job query -j $JOB_ID

### `view` ###

*  *介绍*： 检索任务数据视图。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>否</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>否</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>status</td> 
   <td><code>-s</code></td> 
   <td><code>--status</code></td> 
   <td>否</td> 
   <td>任务状态</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：
    
        flow job view -j $JOB_ID -s complete

### `config` ###

*  *介绍*： 下载指定任务的配置文件到指定目录。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>是</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>output_path</td> 
   <td><code>-o</code></td> 
   <td><code>--output-path</code></td> 
   <td>是</td> 
   <td>输出目录</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：
    
        flow job config -j $JOB_ID -r host -p 10000 --output-path ./examples/

### `log` ###

*  *介绍*： 下载指定任务的日志文件到指定目录。
 *  *参数*：

*  *示例*：
    
        flow job log -j JOB_ID --output-path ./examples/

### `list` ###

*  *介绍*： 展示任务列表。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>limit</td> 
   <td><code>-l</code></td> 
   <td><code>--limit</code></td> 
   <td>否</td> 
   <td>返回数量限制（默认：10）</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow job list
    flow job list -l 30

### `dsl` ###

*  *介绍*： 预测DSL文件生成器。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>cpn_list</td> 
   <td></td> 
   <td><code>--cpn-list</code></td> 
   <td>否</td> 
   <td>用户指定组件名列表</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>cpn_path</td> 
   <td></td> 
   <td><code>--cpn-path</code></td> 
   <td>否</td> 
   <td>用户指定带有组件名列表的文件路径</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>train_dsl_path</td> 
   <td></td> 
   <td><code>--train-dsl-path</code></td> 
   <td>是</td> 
   <td>训练dsl文件路径</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>output_path</td> 
   <td><code>-o</code></td> 
   <td><code>--output-path</code></td> 
   <td>否</td> 
   <td>输出目录路径</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow job dsl --cpn-path fate_flow/examples/component_list.txt --train-dsl-path fate_flow/examples/test_hetero_lr_job_dsl.json
    
    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/

# 4 Model #

### `load` ###

*  *介绍*： 加载模型。
 *  *参数*：

*  *示例*：

flow model load -c fate_flow/examples/publish_load_model.json
    flow model load -j $JOB_ID

### `bind` ###

*  *介绍*： 绑定模型。
 *  *参数*：

*  *示例*：

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` ###

*  *介绍*： 导入模型。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>conf_path</td> 
   <td><code>-c</code></td> 
   <td><code>--conf-path</code></td> 
   <td>是</td> 
   <td>任务配置文件路径</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>from-database</td> 
   <td></td> 
   <td>–from-database</td> 
   <td>否</td> 
   <td>如果指定且有可用的数据库环境，fate flow将从根据任务配置文件从数据库中导入模型。</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow model import -c fate_flow/examples/import_model.json
    flow model import -c fate_flow/examples/restore_model.json --from-database

### `export` ###

*  *介绍*： 导出模型。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>conf_path</td> 
   <td><code>-c</code></td> 
   <td><code>--conf-path</code></td> 
   <td>是</td> 
   <td>任务配置文件路径</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>to-database</td> 
   <td></td> 
   <td><code>--to-database</code></td> 
   <td>否</td> 
   <td>如果指定且有可用的数据库环境，fate flow将从根据任务配置文件将模型导出到数据库中。</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow model export -c fate_flow/examples/export_model.json
    flow model export -c fate_flow/examplse/store_model.json --to-database

### `migrate` ###

*  *介绍*： 迁移模型。
 *  *参数*：

*  *示例*：

flow model migrate -c fate_flow/examples/migrate_model.json

### `tag-list` ###

*  *介绍*： 展示模型的标签列表。
 *  *参数*：

*  *示例*：

flow model tag-list -j $JOB_ID

### `tag-model` ###

*  *介绍*： 对模型添加标签。
 *  *参数*：

*  *示例*：

flow model tag-model -j $JOB_ID -t $TAG_NAME
    flow model tag-model -j $JOB_ID -t $TAG_NAME --remove

### `deploy` ###

*  *介绍*： 配置模型预测DSL。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>model_id</td> 
   <td></td> 
   <td><code>--model-id</code></td> 
   <td>是</td> 
   <td>模型ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>model_version</td> 
   <td></td> 
   <td><code>--model-version</code></td> 
   <td>是</td> 
   <td>模型版本</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>cpn_list</td> 
   <td></td> 
   <td><code>--cpn-list</code></td> 
   <td>否</td> 
   <td>组件列表</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>cpn_path</td> 
   <td></td> 
   <td><code>--cpn-path</code></td> 
   <td>否</td> 
   <td>组件列表文件路径</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>dsl_path</td> 
   <td></td> 
   <td><code>--dsl-path</code></td> 
   <td>否</td> 
   <td>用户指定预测DSL文件路径</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow model deploy --model-id $MODEL_ID --model-version $MODEL_VERSION

### `get-predict-dsl` ###

*  *介绍*： 获取模型预测DSL。
 *  *参数*：

*  *示例*：

flow model get-predict-dsl --model-id $MODEL_ID --model-version $MODEL_VERSION -o ./examples/

### `get-predict-conf` ###

*  *介绍*： 获取模型预测Conf模板。
 *  *参数*：

*  *示例*：

flow model get-predict-conf --model-id $MODEL_ID --model-version $MODEL_VERSION -o ./examples/

### `get-model-info` ###

*  *介绍*： 获取模型信息。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>model_id</td> 
   <td></td> 
   <td><code>--model-id</code></td> 
   <td>否</td> 
   <td>模型ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>model_version</td> 
   <td></td> 
   <td><code>--model-version</code></td> 
   <td>是</td> 
   <td>模型版本</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>否</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party-id</code></td> 
   <td>否</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>detail</td> 
   <td></td> 
   <td><code>--detail</code></td> 
   <td>否</td> 
   <td>若指定，详细信息将被展示</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow model get-model-info --model-id $MODEL_ID --model-version $MODEL_VERSION
    flow model get-model-info --model-id $MODEL_ID --model-version $MODEL_VERSION --detail

##  ##

# 5 Component (TRACKING) #

### `parameters` ###

*  *介绍*： 检索指定组件的参数。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>是</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td><code>-cpn</code></td> 
   <td><code>--component_name</code></td> 
   <td>是</td> 
   <td>组件名</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow component parameters -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0

### `metric-all` ###

*  *介绍*： 检索指定任务的所有metric数据。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>是</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td><code>-cpn</code></td> 
   <td><code>--component_name</code></td> 
   <td>是</td> 
   <td>组件名</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：
    
        flow component metric-all -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0

### `metrics` ###

*  *介绍*： 检索指定任务指定组件的metric数据。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>是</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td><code>-cpn</code></td> 
   <td><code>--component_name</code></td> 
   <td>是</td> 
   <td>组件名</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：
    
        flow component metrics -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0

### `metric-delete` ###

*  *介绍*： 删除指定metric数据。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>date</td> 
   <td><code>-d</code></td> 
   <td><code>--date</code></td> 
   <td>否</td> 
   <td>8位日期, 形如 ‘YYYYMMDD’</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>否</td> 
   <td>Job ID</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

# 注意：如果同时键入date参数与job_id参数，CLI将优先检测date参数数据，job_id参数将被忽略。
    flow component metric-delete -d 20200101
    flow component metric-delete -j $JOB_ID

### `output-model` ###

*  *介绍*： 检索指定组件模型。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>是</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td><code>-cpn</code></td> 
   <td><code>--component_name</code></td> 
   <td>是</td> 
   <td>组件名</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：
    
        flow component output-model -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0

### `output-data` ###

*  *介绍*： 下载指定组件的输出数据。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>是</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td><code>-cpn</code></td> 
   <td><code>--component_name</code></td> 
   <td>是</td> 
   <td>组件名</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>output_path</td> 
   <td><code>-o</code></td> 
   <td><code>--output-path</code></td> 
   <td>是</td> 
   <td>输出目录</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>limit</td> 
   <td><code>-l</code></td> 
   <td><code>--limit</code></td> 
   <td>否</td> 
   <td>默认返回全部</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：
    
        flow component output-data -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0 --output-path ./examples/

### `output-data-table` ###

*  *介绍*： 查看数据表名及命名空间。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>是</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td><code>-cpn</code></td> 
   <td><code>--component_name</code></td> 
   <td>是</td> 
   <td>组件名</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：
    
        flow component output-data-table -j $JOB_ID -r host -p 10000 -cpn hetero_feature_binning_0

### `list` ###

*  *介绍*： 展示指定任务的组件列表。
 *  *参数*：

*  *示例*：

flow component list -j $JOB_ID

### `get-summary` ###

*  *介绍*： 获取指定组件的概要。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>是</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td><code>-cpn</code></td> 
   <td><code>--component_name</code></td> 
   <td>是</td> 
   <td>组件名</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>output_path</td> 
   <td><code>-o</code></td> 
   <td><code>--output-path</code></td> 
   <td>否</td> 
   <td>输出目录路径</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

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/

# 6 Task #

### `query` ###

*  *介绍*： 检索Task信息。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td><code>-j</code></td> 
   <td><code>--job_id</code></td> 
   <td>否</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td><code>-r</code></td> 
   <td><code>--role</code></td> 
   <td>否</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td><code>-p</code></td> 
   <td><code>--party_id</code></td> 
   <td>否</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td><code>-cpn</code></td> 
   <td><code>--component_name</code></td> 
   <td>否</td> 
   <td>组件名</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>status</td> 
   <td><code>-s</code></td> 
   <td><code>--status</code></td> 
   <td>否</td> 
   <td>任务状态</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow task query -j $JOB_ID -p 9999 -r guest
    flow task query -cpn hetero_feature_binning_0 -s complete

### `list` ###

*  *介绍*： 展示Task列表。
 *  *参数*：

*  *示例*：

flow task list
    flow task list -l 25

# 7 Table #

### `info` ###

*  *介绍*： 检索数据表信息。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>namespace</td> 
   <td><code>-n</code></td> 
   <td><code>--namespace</code></td> 
   <td>是</td> 
   <td>命名空间</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>table_name</td> 
   <td><code>-t</code></td> 
   <td><code>--table-name</code></td> 
   <td>是</td> 
   <td>数据表名</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow table info -n $NAMESPACE -t $TABLE_NAME

### `delete` ###

*  *介绍*： 删除指定数据表。
 *  *参数*：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>Flag_1</th> 
   <th>Flag_2</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>namespace</td> 
   <td><code>-n</code></td> 
   <td><code>--namespace</code></td> 
   <td>否</td> 
   <td>命名空间</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>table_name</td> 
   <td><code>-t</code></td> 
   <td><code>--table_name</code></td> 
   <td>否</td> 
   <td>数据表名</td> 
  </tr> 
 </tbody> 
</table>

*  *示例*：

flow table delete -n $NAMESPACE -t $TABLE_NAME

# 8 Queue #

### `clean` ###

*  *介绍*： 取消所有在队列中的Job。
 *  *参数*： 无
 *  *示例*：

flow queue clean
    | -------- | -------- |
    | 1    | namespace  | `-n`   | `--namespace`  | 是       | 命名空间 |
    | 2    | table_name | `-t`   | `--table-name` | 是       | 数据表名 |
    
    - *示例*：

flow table info -n $NAMESPACE -t $TABLE\_NAME

### `delete`
    
    - *介绍*： 删除指定数据表。
    - *参数*：
    
    | 编号 | 参数       | Flag_1 | Flag_2         | 必要参数 | 参数介绍 |
    | ---- | ---------- | ------ | -------------- | -------- | -------- |
    | 1    | namespace  | `-n`   | `--namespace`  | 否       | 命名空间 |
    | 2    | table_name | `-t`   | `--table_name` | 否       | 数据表名 |
    
    - *示例*：

flow table delete -n $NAMESPACE -t $TABLE\_NAME

# 8 Queue
    
    ### `clean`
    
    - *介绍*： 取消所有在队列中的Job。
    - *参数*： 无
    - *示例*：

flow queue clean

[image-20210823113102859]: /images/20220829/a72fe0ca18364cb2bf112fc8098dfbbf.png
[image-20210823113514141]: /images/20220829/5632f7d51f84477f841b9f57cb3d0dc6.png
[image-20210823133333517]: /images/20220829/c00174af3a884f468f9f5de78ffe76b7.png