GetAlgorithmVersion - 获取算法版本详情

更新时间:
复制 MD 格式

获取算法版本详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pai:GetAlgorithmVersion

get

*全部资源

*

无 无

请求语法

GET /api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

AlgorithmId

string

否

算法 ID。

algo-xsldfvu1334

AlgorithmVersion

string

否

算法版本。

v0.0.1

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

请求返回数据。

AlgorithmSpec AlgorithmSpec

算法详情。

AlgorithmId

string

算法 ID。

algo-xsldfvu1334

AlgorithmName

string

算法名。

llm_training

AlgorithmProvider

string

算法提供方。

pai

AlgorithmVersion

string

算法版本。

v0.0.1

GmtCreateTime

string

算法创建时间,采用 ISO 8601 格式,时区为 UTC。

2024-07-10T11:49:47Z

GmtModifiedTime

string

算法更新时间,采用 ISO 8601 格式,时区为 UTC。

2024-07-10T11:49:47Z

UserId

string

算法归属用户 ID。

123456789

TenantId

string

算法归属租户 ID。

123456789

示例

正常返回示例

JSON格式

{
  "AlgorithmSpec": {
    "OutputChannels": [
      {
        "Description": "模型输出。",
        "Required": true,
        "Properties": {},
        "Name": "Model",
        "SupportedChannelTypes": [
          "oss"
        ]
      }
    ],
    "HyperParameters": [
      {
        "DefaultValue": "0",
        "Type": "Integer",
        "Description": "参数定义了训练的batch_size。",
        "Required": true,
        "Name": "batch_size",
        "Range": {
          "Enum": [
            "0"
          ],
          "MinLength": 1,
          "MaxLength": 30,
          "Minimum": "0",
          "Maximum": "10",
          "ExclusiveMinimum": true,
          "ExclusiveMaximum": true,
          "Pattern": "^\\+?[1-9][0-9]*$"
        },
        "DisplayName": "Batch Size"
      }
    ],
    "JobType": "TFJob",
    "Command": [
      "python train.py"
    ],
    "MetricDefinitions": [
      {
        "Description": "训练损失函数。",
        "Regex": ".*train:loss=([-+]?[0-9]*\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*",
        "Name": "loss"
      }
    ],
    "InputChannels": [
      {
        "Description": "模型输出。",
        "Required": true,
        "Properties": {},
        "Name": "Model",
        "SupportedChannelTypes": [
          "oss"
        ]
      }
    ],
    "SupportsDistributedTraining": true,
    "Image": "registry.cn-shanghai.aliyuncs.com/pai-training/kmeans:v1.0.0",
    "SupportedInstanceTypes": [
      "ecs.g6.2xlarge"
    ],
    "ComputeResource": {
      "Policy": {
        "Version": "V1",
        "Value": "[{\\\"MinTotalCount\\\":1,\\\"MaxTotalCount\\\":4,\\\"RolePolicies\\\":{\\\"chief\\\":{\\\"Count\\\":1},\\\"ps\\\":{\\\"Count\\\":1},\\\"worker\\\":{\\\"Percentage\\\":100}}},{\\\"MinTotalCount\\\":5,\\\"MaxTotalCount\\\":10,\\\"RolePolicies\\\":{\\\"chief\\\":{\\\"Count\\\":1},\\\"ps\\\":{\\\"Percentage\\\":20},\\\"worker\\\":{\\\"Percentage\\\":80}}},{\\\"MinTotalCount\\\":11,\\\"RolePolicies\\\":{\\\"chief\\\":{\\\"Count\\\":1},\\\"ps\\\":{\\\"Percentage\\\":40},\\\"worker\\\":{\\\"Percentage\\\":60}}}]"
      }
    },
    "CodeDir": {
      "LocationType": "OSS",
      "LocationValue": {
        "test": "test",
        "test2": 1
      }
    },
    "Customization": {
      "CodeDir": true
    },
    "ResourceRequirements": [
      {
        "Key": "SupportedMachineTypes",
        "Operator": "in",
        "Values": [
          "ecs.gn5-c4g1.xlarge"
        ]
      }
    ],
    "ProgressDefinitions": {
      "OverallProgress": {
        "Description": "training progress",
        "Regex": "^[0-9]+([.][0-9]+){0,1}$"
      },
      "RemainingTime": {
        "Description": "training remaining time",
        "Regex": "^[0-9]+([.][0-9]+){0,1}$"
      }
    }
  },
  "AlgorithmId": "algo-xsldfvu1334",
  "AlgorithmName": "llm_training",
  "AlgorithmProvider": "pai",
  "AlgorithmVersion": "v0.0.1",
  "GmtCreateTime": "2024-07-10T11:49:47Z",
  "GmtModifiedTime": "2024-07-10T11:49:47Z",
  "UserId": "123456789",
  "TenantId": "123456789"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。