计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

更新算法

更新时间:2025-01-27 GMT+08:00

功能介绍

更新算法。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v2/{project_id}/algorithms/{algorithm_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户项目ID。获取方法请参见获取项目ID和名称

algorithm_id

String

算法ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

metadata

AlgorithmMetadata object

算法的元数据,描述算法基本信息。

job_config

AlgorithmJobConfig object

算法配置信息,如启动文件等。

resource_requirements

Array of ResourceRequirement objects

算法资源约束。可不设置。设置后,在算法使用于训练作业时,控制台会过滤可用的公共资源池。

advanced_config

AlgorithmAdvancedConfig object

算法高级策略:

  • auto_search

表3 AlgorithmMetadata

参数

是否必选

参数类型

描述

id

Integer

算法uuid,创建算法时无需填写。

name

String

算法名称。限制为1-64位只含数字、字母、下划线和中划线的名称。

description

String

对算法的描述,默认为“NULL”,字符串的长度限制为[0, 256]。

workspace_id

String

指定算法所处的工作空间,默认值为“0”。“0” 为默认的工作空间。

ai_project

String

指定算法所属的ai项目,默认值为"default-ai-project"。ai项目已下线,无需关注。

表4 AlgorithmJobConfig

参数

是否必选

参数类型

描述

code_dir

String

算法的代码目录。如:“/usr/app/”。应与boot_file一同出现。

boot_file

String

算法的代码启动文件,需要在代码目录下。如:“/usr/app/boot.py”。应与code_dir一同出现。

command

String

自定义镜像算法的容器启动命令。

parameters

Array of Parameters objects

算法的运行参数。

inputs

Array of AlgorithmCreateInput objects

算法的数据输入。

outputs

Array of AlgorithmCreateOutput objects

算法的数据输出。

engine

AlgorithmCreateEngine object

算法的引擎。

parameters_customization

Boolean

算法是否允许创建训练作业时自定义超参。

表5 Parameters

参数

是否必选

参数类型

描述

name

String

参数名称。

value

String

参数值。

description

String

参数描述信息。

constraint

ParametersConstraint object

参数属性。

i18n_description

I18nDescription object

国际化描述。

表6 ParametersConstraint

参数

是否必选

参数类型

描述

type

String

参数种类。

editable

Boolean

是否可编辑。

required

Boolean

是否必须。

sensitive

Boolean

是否敏感。该功能暂未实现。

valid_type

String

有效种类。

valid_range

Array of strings

有效范围。

表7 I18nDescription

参数

是否必选

参数类型

描述

language

String

国际语种。

description

String

描述信息。

表8 AlgorithmCreateInput

参数

是否必选

参数类型

描述

name

String

数据输入通道名称。

description

String

数据输入通道描述信息。

remote_constraints

Array of RemoteConstraint objects

数据输入约束。

表9 RemoteConstraint

参数

是否必选

参数类型

描述

data_type

String

数据输入类型,支持数据存储位置(OBS)、ModelArts数据集两种方式。

attributes

Array of Map<String,String> objects

数据输入为数据集时的相关属性。枚举值:

  • data_format:数据格式。

  • data_segmentation:数据切分方式。

  • dataset_type:标注类型。

表10 AlgorithmCreateOutput

参数

是否必选

参数类型

描述

name

String

数据输出通道名称。

description

String

数据输出通道描述信息。

表11 AlgorithmCreateEngine

参数

是否必选

参数类型

描述

engine_id

String

算法选择的引擎规格ID。

engine_name

String

算法选择的引擎版本名称。若填入engine_id则无需填写。

engine_version

String

算法选择的引擎版本名称。若填入engine_id则无需填写。

image_url

String

算法选择的自定义镜像地址。

表12 ResourceRequirement

参数

是否必选

参数类型

描述

key

String

资源约束,可选键值如:

  • flavor_type(资源类型),对应值可选择CPU、GPU或Ascend;

  • device_distributed_mode(是否支持多卡训练),对应值可选择multiple(支持)、singular(不支持);

  • host_distributed_mode(是否支持分布式训练),对应值可选择multiple(支持)、singular(不支持)。

values

Array of strings

资源约束键对应值。

operator

String

键与值关系,当前只支持in。例如flavor_type in [CPU,GPU]。

表13 AlgorithmAdvancedConfig

参数

是否必选

参数类型

描述

auto_search

AutoSearch object

超参搜索策略。

表14 AutoSearch

参数

是否必选

参数类型

描述

skip_search_params

String

需要排除的超参组合。

reward_attrs

Array of RewardAttrs objects

搜索指标列表。

search_params

Array of SearchParams objects

搜索参数。

algo_configs

Array of AlgoConfigs objects

搜索算法配置。

表15 RewardAttrs

参数

是否必选

参数类型

描述

name

String

指标名称。

mode

String

搜索方向。 - max指定时表示指标值越大越好; - min指定时表示指标值越小越好。

regex

String

指标正则表达式。

表16 SearchParams

参数

是否必选

参数类型

描述

name

String

超参名称。

param_type

String

参数类型。 - continuous:指定时表示这个超参是连续类型的。连续类型的超参在算法使用于训练作业时,控制台显示为输入框。 - discrete:指定时表示这个超参是离散类型的。离散类型的超参在算法使用于训练作业时,控制台显示为下拉选择框架。

lower_bound

String

超参下界。

upper_bound

String

超参上界。

discrete_points_num

String

连续型超参离散化取值个数。

discrete_values

Array of strings

离散型超参的取值列表。

表17 AlgoConfigs

参数

是否必选

参数类型

描述

name

String

搜索算法名称。

params

Array of AutoSearchAlgoConfigParameter objects

搜索算法参数。

表18 AutoSearchAlgoConfigParameter

参数

是否必选

参数类型

描述

key

String

参数键。

value

String

参数值。

type

String

参数种类。

响应参数

状态码:201

表19 响应Body参数

参数

参数类型

描述

metadata

metadata object

算法的元数据,描述算法基本信息。

job_config

job_config object

算法配置信息,如启动文件等。

resource_requirements

Array of resource_requirements objects

算法资源约束,可不设置。设置后,在算法使用于训练作业时,控制台会过滤可用的公共资源池。

advanced_config

advanced_config object

算法高级策略:

  • auto_search

表20 metadata

参数

参数类型

描述

id

Integer

算法uuid,创建算法时无需填写。

name

String

算法名称。限制为1-64位只含数字、字母、下划线和中划线的名称。

description

String

对算法的描述,默认为“NULL”,字符串的长度限制为[0, 256]。

workspace_id

String

指定算法所处的工作空间,默认值为“0”。“0” 为默认的工作空间。

ai_project

String

指定算法所属的ai项目,默认值为"default-ai-project"。ai项目已下线,无需关注。

user_name

String

用户名称。

domain_id

String

用户的domainID。

source

String

算法来源类型。

api_version

String

算法api版本,标识新旧版。

is_valid

String

算法可用性。

state

String

算法状态。

tags

Array of Map<String,String> objects

算法标签。

attr_list

Array of strings

算法属性列表。

version_num

Integer

算法版本数量,默认为0。

size

Integer

算法大小。

create_time

Long

算法创建时间戳。

update_time

Long

算法更新时间戳。

表21 job_config

参数

参数类型

描述

code_dir

String

算法的代码目录。如:“/usr/app/”。应与boot_file一同出现。

boot_file

String

算法的代码启动文件,需要在代码目录下。如:“/usr/app/boot.py”。应与code_dir一同出现。

command

String

自定义镜像算法的容器启动命令。

parameters

Array of Parameter objects

算法的运行参数。

inputs

Array of inputs objects

算法的数据输入。

outputs

Array of outputs objects

算法的数据输出。

engine

engine object

算法的引擎。

code_tree

Array of code_tree objects

算法的目录结构树。

parameters_customization

Boolean

算法是否允许创建训练作业时自定义超参。

表22 Parameter

参数

参数类型

描述

name

String

参数名称。

value

String

参数值。

description

String

参数描述信息。

constraint

constraint object

参数属性。

i18n_description

i18n_description object

国际化描述。

表23 constraint

参数

参数类型

描述

type

String

参数种类。

editable

Boolean

是否可编辑。

required

Boolean

是否必须。

sensitive

Boolean

是否敏感。该功能暂未实现。

valid_type

String

有效种类。

valid_range

Array of strings

有效范围。

表24 i18n_description

参数

参数类型

描述

language

String

国际语种,可选值如下:

  • zh-cn(中文)

  • en-us(英文)

description

String

国际化语种的描述信息。

表25 inputs

参数

参数类型

描述

name

String

数据输入通道名称。

description

String

数据输入通道描述信息。

remote_constraints

Array of remote_constraints objects

数据输入约束。

表26 remote_constraints

参数

参数类型

描述

data_type

String

数据输入类型,包括数据存储位置、数据集两种方式。

attributes

Array of Map<String,String> objects

数据输入为数据集时的相关属性。枚举值:

  • data_format数据格式。

  • data_segmentation数据切分方式。

  • dataset_type标注类型。

表27 outputs

参数

参数类型

描述

name

String

数据输出通道名称。

description

String

数据输出通道描述信息。

表28 engine

参数

参数类型

描述

engine_id

String

算法选择的引擎规格ID。

engine_name

String

算法选择的引擎版本名称。若填入engine_id则无需填写。

engine_version

String

算法选择的引擎版本名称。若填入engine_id则无需填写。

image_url

String

算法选择的自定义镜像地址。

表29 code_tree

参数

参数类型

描述

name

String

算法目录树当前层级目录名。

children

Object

算法目录树当前层级目录下子文件和子目录。

表30 resource_requirements

参数

参数类型

描述

key

String

资源约束,可选值如下:

  • 资源类型(flavor_type),对应值可选择CPU、GPU或Ascend;

  • 是否支持多卡训练(device_distributed_mode),对应值可选择支持(multiple)、不支持(singular);

  • 是否支持分布式训练(host_distributed_mode),对应值可选择支持(multiple)、不支持(singular)。

value

Array of strings

资源约束键对应值。

operator

String

键与值关系,当前只支持in。例如flavor_type in [CPU,GPU]。

表31 advanced_config

参数

参数类型

描述

auto_search

auto_search object

超参搜索策略。

表33 reward_attrs

参数

参数类型

描述

name

String

指标名称。

mode

String

搜索方向。

  • max指定时表示指标值越大越好;

  • min指定时表示指标值越小越好。

regex

String

指标正则表达式。

表34 search_params

参数

参数类型

描述

name

String

超参名称。

param_type

String

参数类型。

  • continuous:指定时表示这个超参是连续类型的。连续类型的超参在算法使用于训练作业时,控制台显示为输入框。

  • discrete:指定时表示这个超参是离散类型的。离散类型的超参在算法使用于训练作业时,控制台显示为下拉选择框架。

lower_bound

String

超参下界。

upper_bound

String

超参上界。

discrete_points_num

String

连续型超参离散化取值个数。

discrete_values

String

离散型超参的取值列表。

表35 algo_configs

参数

参数类型

描述

name

String

搜索算法名称。

params

Array of AutoSearchAlgoConfigParameter objects

搜索算法参数。

表36 AutoSearchAlgoConfigParameter

参数

参数类型

描述

key

String

参数键。

value

String

参数值。

type

String

参数种类。

请求示例

如下以修改uuid为2e5451fe-913f-4492-821a-2981031382f7的算法为例。

PUT https://endpoint/v2/{project_id}/algorithms/2e5451fe-913f-4492-821a-2981031382f7

{
  "metadata" : {
    "name" : "TestModelArtsalgorithm",
    "description" : "This is a ModelArts algorithm modified"
  },
  "job_config" : {
    "code_dir" : "/algo-test/pytorch/work1/code/",
    "boot_file" : "/algo-test/pytorch/work1/code/test-pytorch.py",
    "parameters" : [ {
      "name" : "test-parameter",
      "value" : "10",
      "constraint" : {
        "type" : "String",
        "editable" : true,
        "required" : false,
        "sensitive" : false,
        "valid_type" : "None",
        "valid_range" : [ ]
      }
    } ],
    "parameters_customization" : true,
    "inputs" : [ {
      "name" : "data_url",
      "description" : "data source."
    } ],
    "outputs" : [ {
      "name" : "train_url",
      "description" : "model output."
    } ],
    "engine" : {
      "engine_name" : "PyTorch",
      "engine_version" : "PyTorch-1.3.0-python3.6"
    }
  }
}

响应示例

状态码:201

ok

{
  "metadata" : {
    "id" : "2e5451fe-913f-4492-821a-2981031382f7",
    "name" : "TestModelArtsalgorithm",
    "description" : "This is a ModelArts algorithm modified",
    "create_time" : 1636600721742,
    "workspace_id" : "0",
    "ai_project" : "default-ai-project",
    "user_name" : "",
    "domain_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "source" : "custom",
    "api_version" : "",
    "is_valid" : true,
    "state" : "",
    "size" : 4791,
    "tags" : null,
    "attr_list" : null,
    "version_num" : 0,
    "update_time" : 0
  },
  "job_config" : {
    "code_dir" : "/algo-test/pytorch/work1/code/",
    "boot_file" : "/algo-test/pytorch/work1/code/test-pytorch.py",
    "command" : "",
    "parameters" : [ {
      "name" : "test-parameter",
      "description" : "",
      "i18n_description" : null,
      "value" : "10",
      "constraint" : {
        "type" : "String",
        "editable" : true,
        "required" : false,
        "sensitive" : false,
        "valid_type" : "None",
        "valid_range" : [ ]
      }
    } ],
    "parameters_customization" : true,
    "inputs" : [ {
      "name" : "data_url",
      "description" : "name to translate"
    } ],
    "outputs" : [ {
      "name" : "train_url",
      "description" : "name to translate"
    } ],
    "engine" : {
      "engine_id" : "pytorch-cp36-1.3.0",
      "engine_name" : "PyTorch",
      "engine_version" : "PyTorch-1.3.0-python3.6"
    },
    "code_tree" : {
      "name" : "code/",
      "children" : [ {
        "name" : "test-pytorch.py"
      } ]
    }
  },
  "resource_requirements" : null,
  "advanced_config" : { }
}

状态码

状态码

描述

201

ok

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容