Fate Flow Client SDK 指南

路径

用法

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

  

 

  
1
  
2
  
3
 

Job 操作

用法

client.job.submit(conf_path, dsl_path)

  

 

  
1
 

函数定义

submit(conf_path, dsl_path)

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

stop(job_id)

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

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

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

config(job_id, role, party_id, output_path)

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

log(job_id, output_path)

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

list(limit=10)

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

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

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

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

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

Component 操作

用法

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

  

 

  
1
 

函数定义

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数据。
• 参数：

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)

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

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)

  

 

  
1
 

函数定义

download(conf_path)

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

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

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

upload_history(limit=10, job_id=None)

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

Task 操作

用法

client.task.list(limit=10)

  

 

  
1
 

函数定义

list(limit=10)

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

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

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

Model 操作

用法

client.model.load(conf_path)

  

 

  
1
 

函数定义

load(conf_path=None, job_id=None)

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

bind(conf_path, job_id=None)

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

export_model(conf_path, to_database=False)

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

import_model(conf_path, from_database=False)

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

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。
• 参数：

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)

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

Tag 操作

用法

client.tag.create(tag_name, desc)

  

 

  
1
 

函数定义

create(tag_name, tag_desc=None)

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

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

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

list(limit=10)

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

query(tag_name, with_model=False)

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

delete(tag_name)

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

Table 操作

用法

client.table.info(namespace, table_name)

  

 

  
1
 

函数定义

info(namespace, table_name)

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

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

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

Queue 操作

用法

client.queue.clean()

  

 

  
1
 

函数定义

clean()

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

文章来源: wanghao.blog.csdn.net，作者：AI浩，版权归原作者所有，如需转载，请联系作者。

原文链接：wanghao.blog.csdn.net/article/details/119887880