路径

用法

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任务。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 conf_path string 是 任务配置文件路径
2 dsl_path string 是 DSL文件路径

stop(job_id)

  • 介绍：取消或终止指定任务。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID

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

  • 介绍：检索任务信息。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 否 Job ID
2 role string 否 角色
3 party_id integer 否 Party id
4 status string 否 任务状态

config(job_id, role, party_id, output_path)

  • 介绍：下载指定任务的配置文件到指定目录。
  • 参数：
否 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 role string 是 角色
3 party_id integer 是 Party id
4 output_path string 是 输出目录路径

log(job_id, output_path)

  • 介绍：下载指定任务的日志文件到指定目录。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 output_path string 是 输出目录路径

list(limit=10)

  • 介绍：展示任务列表。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 limit integer 否 返回数量限制（默认：10）

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

  • 介绍：检索任务数据视图。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 否 Job ID
2 role= string 否 角色
3 party_id integer 否 Party id
4 component_name string 否 组件名

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

  • 介绍：预测DSL文件生成器。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 train_dsl_path string(path) 是 用户指定组件名列表
2 version string 否 DSL解析器版本（默认：1）
3 cpn_file_path string(path) 否 用户指定带有组件名列表的文件路径
4 cpn_list list 否 用户指定组件名列表

Component 操作

用法

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

函数定义

parameters(job_id, role, party_id, component_name)

  • 介绍：检索指定组件的参数。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 role string 是 角色
3 party_id integer 是 Party id
4 component_name string 是 组件名

metric_all(job_id, role, party_id, component_name)

  • 介绍：检索指定任务的所有metric数据。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 role string 是 角色
3 party_id integer 是 Party id
4 component_name string 是 组件名

metrics(job_id, role, party_id, component_name)

  • 介绍：检索指定任务指定组件的metric数据。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 role string 是 角色
3 party_id integer 是 Party id
4 component_name string 是 组件名

metric_delete(date=None, job_id=None)

  • 介绍：删除指定metric数据。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 date integer 是 8位日期, 形如 ‘YYYYMMDD’
2 job_id integer 是 Job ID

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)

  • 介绍：检索指定组件模型。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 role string 是 role=
3 party_id integer 是 Party id
4 component_name string 是 组件名

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

  • 介绍：下载指定组件的输出数据。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 role string 是 角色
3 party_id integer 是 Party id
4 component_name string 是 组件名
5 output_path string 是 输出目录路径
6 limit integer 否 返回结果数量限制（默认：-1，指返回所有数据）

output_data_table(job_id, role, party_id, component_name)

  • 介绍：查看数据表名及命名空间。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 role string 是 角色
3 party_id integer 是 Party id
4 component_name string 是 组件名

list(job_id)

  • 介绍： 展示指定任务的组件列表。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID

get_summary(job_id, role, party_id, component_name)

  • 介绍：获取指定组件的概要。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 role string 是 角色
3 party_id integer 是 Party id
4 component_name string 是 组件名

Data 操作

用法

client.data.download(conf_path)

函数定义

download(conf_path)

  • 介绍：下载数据表。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 conf_path string 是 任务配置文件路径

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

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

upload_history(limit=10, job_id=None)

  • 介绍：检索上传数据历史。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 limit integer 否 返回结果数量限制（默认：10）
2 job_id integer 否 Job ID

Task 操作

用法

client.task.list(limit=10)

函数定义

list(limit=10)

  • 介绍： 展示Task列表。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 limit integer 否 返回结果数量限制（默认：10）

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

  • 介绍： 检索Task信息。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 否 Job ID.
2 role string 否 角色
3 party_id integer 否 Party ID
4 component_name string 否 组件名
5 status string 否 任务状态

Model 操作

用法

client.model.load(conf_path)

函数定义

load(conf_path=None, job_id=None)

  • 介绍：加载模型。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 conf_path string 否 任务配置文件路径
2 job_id string 否 Job ID

bind(conf_path, job_id=None)

  • 介绍： 绑定模型。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 conf_path string 是 任务配置文件路径
2 job_id string 否 Job ID

export_model(conf_path, to_database=False)

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

import_model(conf_path, from_database=False)

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

migrate(conf_path, to_database=False)

  • 介绍： 迁移模型。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 conf_path string 是 任务配置文件路径

tag_list(job_id)

  • 介绍： 展示模型的标签列表。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID

tag_model(job_id, tag_name, remove=False)

  • 介绍： 对模型添加标签。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 job_id integer 是 Job ID
2 tag_name string 是 标签名
3 remove bool 否 如果指定，带有指定标签名的标签将被模型的标签列表中移除

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

  • 介绍： 配置模型预测dsl。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 model_id string 是 模型ID
2 model_version string 是 模型版本
3 cpn_list list 否 组件列表
4 predict_dsl dict 否 预测DSL

get_predict_dsl(model_id, model_version)

  • 介绍： 获取模型预测dsl。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 model_id string 是 模型ID
2 model_version string 是 模型版本

get_predict_conf(model_id, model_version)

  • 介绍： 获取模型预测conf模板。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 model_id string 是 模型ID
2 model_version string 是 模型版本

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

  • 介绍： 获取模型信息。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 model_id string 否 模型ID
2 model_version string 是 模型版本
3 role string 否 角色名
4 party_id string 否 Party ID
5 query_filters list 否 检索字段

Tag 操作

用法

client.tag.create(tag_name, desc)

函数定义

create(tag_name, tag_desc=None)

  • 介绍：创建标签。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 tag_name string 是 标签名
2 tag_desc string 否 标签介绍

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

  • 介绍： 更新标签信息。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 tag_name string 是 标签名
2 new_tag_name string 否 新标签名
3 new_tag_desc string 否 新标签介绍

list(limit=10)

  • 介绍： 展示标签列表。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 limit integer 否 返回结果数量限制（默认：10）

query(tag_name, with_model=False)

  • 介绍： 检索标签。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 tag_name string 是 标签名
2 with_model bool 否 如果指定，具有该标签的模型信息将被展示

delete(tag_name)

  • 介绍： 删除标签。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 tag_name string 是 标签名

Table 操作

用法

client.table.info(namespace, table_name)

函数定义

info(namespace, table_name)

  • 介绍： 检索数据表信息。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 namespace string 是 命名空间
2 table_name string 是 数据表名

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

  • 介绍：删除指定数据表。
  • 参数：
编号 参数 参数类型 必要参数 参数介绍
1 namespace string 否 命名空间
2 table_name string 否 数据表名
3 job_id integer 否 Job ID
4 role= string 否 角色
5 party_id integer 否 Party id
6 component_name string 否 组件名

Queue 操作

用法

client.queue.clean()

函数定义

clean()

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

Fate Flow Client SDK 指南相关推荐

  1. oracle 11g sdk,OCI和Instant Client SDK和Oracle数据库

    抱歉,这个问题太幼稚了,但对于我在该主题上的经历也是如此. 从谷歌搜索我所了解的内容,我只是想确认该理解是正确的.欢迎大家查明我错了. > OCI基本上是一组API,供C/C++程序员用来编写C ...

  2. fastdfs java client_GitHub - happyfish100/fastdfs-client-java: FastDFS java client SDK

    FastDFS java client SDK FastDFS Java Client API may be copied only under the terms of the BSD licens ...

  3. MinIO Client完全指南 ​​​​​​​

    MinIO Client完全指南 MinIO Client (mc)为ls,cat,cp,mirror,diff,find等UNIX命令提供了一种替代方案.它支持文件系统和兼容Amazon S3的云存 ...

  4. vSphere Web Client使用指南之安装配置

    2019独角兽企业重金招聘Python工程师标准>>> vSphere Web Client使用指南之安装配置 vSphere Web Client是为忙碌的管理员提供的一款通用的. ...

  5. client Sdk

    client Sdk学习 spring.factories 在Spring Boot中有一种非常解耦的扩展机制:Spring Factories,这种扩展机制实际上是仿照Java中的SPI扩展机制来实 ...

  6. Flow Season#Day2| 初步了解FCL（Flow Client Library)

    Flow Season#Day 2: 一起来认识 Flow 客户端库(Flow Client Library) !FCL 赋予开发人员可以: ✅  自动的钱包发现功能 ✅  快速的用户身份认证 ✅  ...

  7. android点对点 sdk,Client(SDK)_开发文档_容联云通讯

    Demo & SDK下载 云通讯平台为开发者提供多语言Demo,让您可以轻松地选择你熟悉的编程语言来体验.以下是官方提供的Demo,这些Demo都是开源的,如果你发现错误,我们欢迎你的反馈,同 ...

  8. Nacos client SDK 订阅式请求坑

    一.场景复现 (1)业务需求 在不同的nacos注册集群,不同的namespace,由页面发起查询nacos集群上注册的服务实例ip. (2)故障现象 nacos集群配置推送push超时,查看naco ...

  9. [译] Kotlin Flow 官方 Guide 指南(2021-06-13)翻译

    原文链接:https://github.com/Kotlin/kotlinx.coroutines/blob/master/docs/topics/flow.md 文章目录 Flow 是冷流 Flow ...

最新文章

  1. 机器学习（8）朴素贝叶斯算法（20条新闻分类）
  2. 95、Jenkins部署.net持续集成自动化测试环境
  3. canvas百分比加载动画
  4. mongodb 持久化 mysql_scrapy数据持久化存储(MySQL、MongoDB)
  5. 进程间通信-共享内存实例
  6. Java知识点：条件编译
  7. 程序员绩效总结_闲聊程序员的绩效考核
  8. python定时发送邮件_Python3实现带附件的定时发送邮件功能
  9. python3随记——字符编码
  10. php如何获取ajax请求,php-从ajax调用获取json数据
  11. byteman_Byteman –用于字节码操纵的瑞士军刀
  12. Tomcat源码分析(十)--部署器 转载
  13. 高等组合学笔记(十四):Lagrange反演公式
  14. php 什么是函数式编程,函数式编程的介绍和归纳总结（附代码）
  15. DPDK QOS4 -- PORT数据结构的初始化
  16. js !!条件判断或运算的作用
  17. 什么是ISO9000质量管理体系认证以及认证流程
  18. c语言程序设计 网上资源,超星尔雅C语言程序设计-资源包完整答案
  19. Day01 郝斌C语言自学视频之 C 语言概述
  20. Android Studio如何用无线（WiFi）连接手机进行调试

热门文章

  1. 猿如意中的【PyCharm Community】工具详情介绍
  2. 深度摄像头ORBBEC Dabai Pro调试
  3. 预推免复习之英语口试
  4. 半导体激光器相关英文缩写词（一）
  5. Excel 2010 SQL应用092 聚合函数之不重复之记录数
  6. 电商违禁词查询工具在线检查
  7. 在linux中本地安装blender LTS
  8. 【视频制作】我们的相册【第1期】
  9. 修改文件注册数据库连接配置，可不在Net Manager里配置
  10. NLP基础——python的jieba用于词类分割用法总结(1)