Fate Flow Client SDK 指南

一时失言乱红尘 2022-09-07 15:50 226阅读 0赞

## 路径 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hoaGhoaGhoaGh3d3d3d3d3d3d3_size_16_color_FFFFFF_t_70]

## 用法 ##

from flow_sdk.client import FlowClient
    # use real ip address to initialize SDK
    client = FlowClient('127.0.0.1', 9000, 'v1')

## Job 操作 ##

### 用法 ###

client.job.submit(conf_path, dsl_path)

### 函数定义 ###

#### `submit(conf_path, dsl_path)` ####

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

#### `stop(job_id)` ####

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

#### `query(job_id=None, role=None, party_id=None, status=None)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td>string</td> 
   <td>否</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>Party id</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>status</td> 
   <td>string</td> 
   <td>否</td> 
   <td>任务状态</td> 
  </tr> 
 </tbody> 
</table>

#### `config(job_id, role, party_id, output_path)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>否</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td>integer</td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td>string</td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td>integer</td> 
   <td>是</td> 
   <td>Party id</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>output_path</td> 
   <td>string</td> 
   <td>是</td> 
   <td>输出目录路径</td> 
  </tr> 
 </tbody> 
</table>

#### `log(job_id, output_path)` ####

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

#### `list(limit=10)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>limit</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>返回数量限制（默认：10）</td> 
  </tr> 
 </tbody> 
</table>

#### `view(job_id=None, role=None, party_id=None, status=None)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role=</td> 
   <td>string</td> 
   <td>否</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>Party id</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td>string</td> 
   <td>否</td> 
   <td>组件名</td> 
  </tr> 
 </tbody> 
</table>

#### `generate_dsl(train_dsl_path, cpn_file_path=None, cpn_list = None)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>train_dsl_path</td> 
   <td>string(path)</td> 
   <td>是</td> 
   <td>用户指定组件名列表</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>version</td> 
   <td>string</td> 
   <td>否</td> 
   <td>DSL解析器版本（默认：1）</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>cpn_file_path</td> 
   <td>string(path)</td> 
   <td>否</td> 
   <td>用户指定带有组件名列表的文件路径</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>cpn_list</td> 
   <td>list</td> 
   <td>否</td> 
   <td>用户指定组件名列表</td> 
  </tr> 
 </tbody> 
</table>

## Component 操作 ##

### 用法 ###

client.component.parameters(job_id, role, party_id, component_name)

### 函数定义 ###

#### `parameters(job_id, role, party_id, component_name)` ####

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

#### `metric_all(job_id, role, party_id, component_name)` ####

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

#### `metrics(job_id, role, party_id, component_name)` ####

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

#### `metric_delete(date=None, job_id=None)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>date</td> 
   <td>integer</td> 
   <td>是</td> 
   <td>8位日期, 形如 ‘YYYYMMDD’</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>job_id</td> 
   <td>integer</td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
 </tbody> 
</table>

`Notice`： If you input two optional 参数s in the mean time, the ‘date’ 参数 will be detected in priority while the ‘job\_id’ 参数 would be ignored.

#### `output_model(job_id, role, party_id, component_name)` ####

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

#### `output_data(job_id, role, party_id, component_name, output_path, limit=10)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td>integer</td> 
   <td>是</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td>string</td> 
   <td>是</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td>integer</td> 
   <td>是</td> 
   <td>Party id</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td>string</td> 
   <td>是</td> 
   <td>组件名</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>output_path</td> 
   <td>string</td> 
   <td>是</td> 
   <td>输出目录路径</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>limit</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>返回结果数量限制（默认：-1，指返回所有数据）</td> 
  </tr> 
 </tbody> 
</table>

#### `output_data_table(job_id, role, party_id, component_name)` ####

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

#### `list(job_id)` ####

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

#### `get_summary(job_id, role, party_id, component_name)` ####

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

## Data 操作 ##

### 用法 ###

client.data.download(conf_path)

### 函数定义 ###

#### `download(conf_path)` ####

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

#### `upload(conf_path, verbose=0, drop=0)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>conf_path</td> 
   <td>string</td> 
   <td>是</td> 
   <td>任务配置文件路径</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>verbose</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>如果赋值为1，用户将在控制台获得上传进度（默认为0）</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>drop</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>如果赋值为1，旧版已上传数据将被新上传的同名数据替换（默认为0）</td> 
  </tr> 
 </tbody> 
</table>

#### `upload_history(limit=10, job_id=None)` ####

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

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

## Task 操作 ##

### 用法 ###

client.task.list(limit=10)

### 函数定义 ###

#### `list(limit=10)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>limit</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>返回结果数量限制（默认：10）</td> 
  </tr> 
 </tbody> 
</table>

#### `query(job_id=None, role=None, party_id=None, component_name=None, status=None)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>job_id</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>Job ID.</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>role</td> 
   <td>string</td> 
   <td>否</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>party_id</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>component_name</td> 
   <td>string</td> 
   <td>否</td> 
   <td>组件名</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>status</td> 
   <td>string</td> 
   <td>否</td> 
   <td>任务状态</td> 
  </tr> 
 </tbody> 
</table>

## Model 操作 ##

### 用法 ###

client.model.load(conf_path)

### 函数定义 ###

#### `load(conf_path=None, job_id=None)` ####

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

#### `bind(conf_path, job_id=None)` ####

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

#### `export_model(conf_path, to_database=False)` ####

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

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

#### `import_model(conf_path, from_database=False)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>conf_path</td> 
   <td>string</td> 
   <td>是</td> 
   <td>任务配置文件路径</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>from_database</td> 
   <td>bool</td> 
   <td>否</td> 
   <td>如果指定且有可用的数据库环境，fate flow将从根据任务配置文件从数据库中导入模型。</td> 
  </tr> 
 </tbody> 
</table>

#### `migrate(conf_path, to_database=False)` ####

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

#### `tag_list(job_id)` ####

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

#### `tag_model(job_id, tag_name, remove=False)` ####

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

#### `deploy(model_id, model_version=None, cpn_list=None, predict_dsl=None)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>model_id</td> 
   <td>string</td> 
   <td>是</td> 
   <td>模型ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>model_version</td> 
   <td>string</td> 
   <td>是</td> 
   <td>模型版本</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>cpn_list</td> 
   <td>list</td> 
   <td>否</td> 
   <td>组件列表</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>predict_dsl</td> 
   <td>dict</td> 
   <td>否</td> 
   <td>预测DSL</td> 
  </tr> 
 </tbody> 
</table>

#### `get_predict_dsl(model_id, model_version)` ####

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

#### `get_predict_conf(model_id, model_version)` ####

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

#### `get_model_info(model_id=None, model_version=None, role=None, party_id=None, query_filters=None, **kwargs)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>model_id</td> 
   <td>string</td> 
   <td>否</td> 
   <td>模型ID</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>model_version</td> 
   <td>string</td> 
   <td>是</td> 
   <td>模型版本</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>role</td> 
   <td>string</td> 
   <td>否</td> 
   <td>角色名</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>party_id</td> 
   <td>string</td> 
   <td>否</td> 
   <td>Party ID</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>query_filters</td> 
   <td>list</td> 
   <td>否</td> 
   <td>检索字段</td> 
  </tr> 
 </tbody> 
</table>

## Tag 操作 ##

### 用法 ###

client.tag.create(tag_name, desc)

### 函数定义 ###

#### `create(tag_name, tag_desc=None)` ####

*  介绍：创建标签。
 *  参数：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>tag_name</td> 
   <td>string</td> 
   <td>是</td> 
   <td>标签名</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>tag_desc</td> 
   <td>string</td> 
   <td>否</td> 
   <td>标签介绍</td> 
  </tr> 
 </tbody> 
</table>

#### `update(tag_name, new_tag_name=None, new_tag_desc=None)` ####

*  介绍： 更新标签信息。
 *  参数：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>tag_name</td> 
   <td>string</td> 
   <td>是</td> 
   <td>标签名</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>new_tag_name</td> 
   <td>string</td> 
   <td>否</td> 
   <td>新标签名</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>new_tag_desc</td> 
   <td>string</td> 
   <td>否</td> 
   <td>新标签介绍</td> 
  </tr> 
 </tbody> 
</table>

#### `list(limit=10)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>limit</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>返回结果数量限制（默认：10）</td> 
  </tr> 
 </tbody> 
</table>

#### `query(tag_name, with_model=False)` ####

*  介绍： 检索标签。
 *  参数：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>tag_name</td> 
   <td>string</td> 
   <td>是</td> 
   <td>标签名</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>with_model</td> 
   <td>bool</td> 
   <td>否</td> 
   <td>如果指定，具有该标签的模型信息将被展示</td> 
  </tr> 
 </tbody> 
</table>

#### `delete(tag_name)` ####

*  介绍： 删除标签。
 *  参数：

## Table 操作 ##

### 用法 ###

client.table.info(namespace, table_name)

### 函数定义 ###

#### `info(namespace, table_name)` ####

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

#### `delete(namespace=None, table_name=None, job_id=None, role=None, party_id=None, component_name=None)` ####

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

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>参数</th> 
   <th>参数类型</th> 
   <th>必要参数</th> 
   <th>参数介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>namespace</td> 
   <td>string</td> 
   <td>否</td> 
   <td>命名空间</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>table_name</td> 
   <td>string</td> 
   <td>否</td> 
   <td>数据表名</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>job_id</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>Job ID</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>role=</td> 
   <td>string</td> 
   <td>否</td> 
   <td>角色</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>party_id</td> 
   <td>integer</td> 
   <td>否</td> 
   <td>Party id</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>component_name</td> 
   <td>string</td> 
   <td>否</td> 
   <td>组件名</td> 
  </tr> 
 </tbody> 
</table>

## Queue 操作 ##

### 用法 ###

client.queue.clean()

### 函数定义 ###

#### `clean()` ####

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

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hoaGhoaGhoaGh3d3d3d3d3d3d3_size_16_color_FFFFFF_t_70]: /images/20220829/218490c63f0a4b43a7f55241b6332a0a.png