Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ ModelArts/ Referencia de la API/ Gestión de la formación (recomendada)/ Gestión de algoritmos/ Consulta de la lista de algoritmos

Actualización más reciente 2022-11-14 GMT+08:00

Ver PDF

Consulta de la lista de algoritmos

Función

Esta API se utiliza para consultar la lista de algoritmos.

URI

GET /v2/{project_id}/algorithms

**Tabla 1** Parámetros de ruta
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto.

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
offset	No	Integer	Offset para los algoritmos de consulta. El valor mínimo es 0. Por ejemplo, si este parámetro se establece en 1, la consulta comienza desde la segunda.
limit	No	Integer	Límite de algoritmos a consultar. El valor varía de 1 a 50.
sort_by	No	String	Métrica para ordenar algoritmos a consultar. create_time se utiliza por defecto.
order	No	String	Orden de los algoritmos consultados. El valor predeterminado es desc, que indica que los algoritmos consultados están ordenados en orden descendente. También puede establecer este parámetro en asc, indicando el orden ascendente.
group_by	No	String	Condición para agrupar los algoritmos que se van a consultar.
searches	No	String	Criterios de filtro para algoritmos a consultar, por ejemplo, coincidencia difusa por el nombre del algoritmo.
workspace_id	No	String	ID del espacio de trabajo.

Parámetros de solicitud

No hay

Parámetros de respuesta

Código de estado: 200

**Tabla 3** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
total	Integer	Número total de algoritmos consultados del usuario actual.
count	Integer	Número total de algoritmos que cumplen los criterios de búsqueda del usuario actual.
limit	Integer	Número máximo de algoritmos consultados del usuario actual.
offset	Integer	Offset de todas las consultas de algoritmo del usuario actual.
sort_by	String	Campos utilizados para ordenar algoritmos consultados del usuario actual.
order	String	Modo de clasificación de algoritmos consultados del usuario actual. El valor predeterminado es desc, que indica el orden descendente. También puede establecer este parámetro en asc, indicando el orden ascendente.
group_by	String	Modo de agrupación de algoritmos consultados del usuario actual.
items	Array of AlgorithmResponse objects	Detalles sobre todos los algoritmos que cumplen con los criterios de búsqueda del usuario actual.

**Tabla 4** AlgorithmResponse
Parámetro	Tipo	Descripción
metadata	metadata object	Metadatos de algoritmo, que describe la información básica del algoritmo.
job_config	job_config object	Configuración del algoritmo, como el archivo de arranque.
resource_requirements	Array of resource_requirements objects	Restricción de recursos de algoritmo. Puede deshabilitar esta función si no establece este parámetro.
advanced_config	advanced_config object	Configuración avanzada del algoritmo. Actualmente, se admite autosearch.

**Tabla 5** metadata
Parámetro	Tipo	Descripción
id	Integer	UUID de algoritmo. No es necesario establecer este parámetro al crear un algoritmo.
name	String	Nombre del algoritmo. El valor debe contener de 1 a 64 caracteres que consisten solo en dígitos, letras, guiones bajos (_) y guiones (-).
description	String	Descripción del algoritmo. El valor debe contener de 0 a 256 caracteres. El valor predeterminado es NULL.
workspace_id	String	Espacio de trabajo donde se encuentra un algoritmo especificado. El valor predeterminado es 0.
ai_project	String	Proyecto de IA al que pertenece un algoritmo especificado. El valor predeterminado es default-ai-project.
user_name	String	Nombre de usuario.
domain_id	String	ID de dominio de un usuario.
source	String	Fuente del algoritmo.
api_version	String	Versión de la API de algoritmos, que identifica las antiguas y las nuevas.
is_valid	String	Disponibilidad de algoritmos.
state	String	Estado del algoritmo.
tags	Array of Map<String,String> objects	Etiquetas de algoritmo.
attr_list	Array of strings	Lista de atributos de algoritmo.
version_num	Integer	Número de versiones de algoritmos. El valor predeterminado es 0.
size	Integer	Tamaño del algoritmo.
create_time	Long	Marca de tiempo cuando se crea el algoritmo.
update_time	Long	Marca de tiempo cuando se actualiza el algoritmo.

**Tabla 6** job_config
Parámetro	Tipo	Descripción
code_dir	String	Directorio de código de algoritmo, por ejemplo, /usr/app/. Este parámetro debe usarse junto con boot_file.
boot_file	String	Archivo de arranque de código del algoritmo, que debe almacenarse en el directorio de código, por ejemplo, /usr/app/boot.py. Este parámetro debe usarse con code_dir.
command	String	Comando de inicio del contenedor de un algoritmo de imagen personalizado.
parameters	Array of Parameter objects	Running parameter of an algorithm.
inputs	Array of inputs objects	Entrada de datos de un algoritmo.
outputs	Array of outputs objects	Salida de datos de un algoritmo.
engine	engine object	Motor de algoritmo.
code_tree	Array of code_tree objects	Árbol de directorios de algoritmos.
parameters_customization	Boolean	Si el algoritmo permite la personalización de hiperparámetros durante la creación de trabajos de formación.

**Tabla 7** Parámetro
Parámetro	Tipo	Descripción
name	String	Nombre del parámetro.
value	String	Valor del parámetro.
description	String	Descripción del parámetro.
constraint	constraint object	Restricción de parámetro.
i18n_description	i18n_description object	Descripción de la internacionalización.

**Tabla 8** constraint
Parámetro	Tipo	Descripción
type	String	Tipo de parámetro.
editable	Boolean	Si el parámetro es editable.
required	Boolean	Si el parámetro es obligatorio.
sensitive	Boolean	Si el parámetro es sensible.
valid_type	String	Tipo válido.
valid_range	Array of strings	Rango válido.

**Tabla 9** i18n_description
Parámetro	Tipo	Descripción
language	String	Internacionalización idioma.
description	String	Descripción.

**Tabla 10** inputs
Parámetro	Tipo	Descripción
name	String	Nombre del canal de entrada de datos.
description	String	Descripción del canal de entrada de datos.
remote_constraints	Array of remote_constraints objects	Restricción de entrada de datos.

**Tabla 11** remote_constraints
Parámetro	Tipo	Descripción
data_type	String	Tipo de entrada de datos, incluida la ubicación de almacenamiento de datos y el conjunto de datos.
attributes	Array of Map<String,String> objects	Atributos si se utiliza un conjunto de datos como entrada de datos. Opciones: data_format: Formato de datos data_segmentation: Segmentación de datos dataset_type: Tipo de etiquetado

**Tabla 12** outputs
Parámetro	Tipo	Descripción
name	String	Nombre del canal de salida de datos.
description	String	Descripción del canal de salida de datos.

**Tabla 13** engine
Parámetro	Tipo	Descripción
engine_id	String	ID del motor seleccionado para un algoritmo.
engine_name	String	Nombre de la versión del motor seleccionado para un algoritmo. Si se especifica engine_id, deje este parámetro en blanco.
engine_version	String	Nombre de la versión del motor seleccionado para un algoritmo. Si se especifica engine_id, deje este parámetro en blanco.
image_url	String	URL de imagen personalizada seleccionada por un algoritmo.

**Tabla 14** code_tree
Parámetro	Tipo	Descripción
name	String	Nombre del directorio actual en el árbol de directorios del algoritmo.
children	Object	Subarchivos y subdirectorios en el directorio actual del árbol de directorios del algoritmo.

**Tabla 15** resource_requirements
Parámetro	Tipo	Descripción
key	String	Restricción de recurso. Opciones:flavor_type: tipo de variante. El valor puede ser CPU, Ascend o GPU. device_distributed_mode: si se admite el entrenamiento multidispositivo. El valor puede ser multiple (soportado) o singular (no soportado). host_distributed_mode: si se admite la formación distribuida. El valor puede ser multiple (soportado) o singular (no soportado).
value	Array of strings	Valor de la clave de restricción de recurso.
operator	String	Relación entre claves y valores. Actualmente, solo in es compatible. Por ejemplo: flavor_type en [CPU,GPU].

**Tabla 16** advanced_config
Parámetro	Tipo	Descripción
auto_search	auto_search object	Política de búsqueda de hiperparámetros.

**Tabla 17** auto_search
Parámetro	Tipo	Descripción
skip_search_params	String	Parámetros hiperparamétricos que deben omitirse.
reward_attrs	Array of reward_attrs objects	Lista de métricas de búsqueda.
search_params	Array of search_params objects	Parámetros de búsqueda.
algo_configs	Array of algo_configs objects	Configuraciones de algoritmos de búsqueda.

**Tabla 18** reward_attrs
Parámetro	Tipo	Descripción
name	String	Nombre de la métrica
mode	String	Dirección de búsqueda. max: Un valor métrico mayor indica un mejor rendimiento. min: Un valor métrico más pequeño indica un mejor rendimiento.
regex	String	Expresión regular de una métrica.

**Tabla 19** search_params
Parámetro	Tipo	Descripción
name	String	Nombre de hiperparámetro.
param_type	String	Tipo de parámetro. continuous: El hiperparámetro es del tipo continuo. discrete: El hiperparámetro es del tipo discreto.
lower_bound	String	Límite inferior del hiperparámetro.
upper_bound	String	Límite superior del hiperparámetro.
discrete_points_num	String	Número de puntos discretos de un hiperparámetro continuo.
discrete_values	String	Lista de valores de hiperparámetro discretos.

**Tabla 20** algo_configs
Parámetro	Tipo	Descripción
name	String	Nombre del algoritmo de búsqueda.
params	Array of AutoSearchAlgoConfigParameter objects	Parámetros del algoritmo de búsqueda.

**Tabla 21** AutoSearchAlgoConfigParameter
Parámetro	Tipo	Descripción
key	String	Clave de parámetro.
value	String	Valor del parámetro.
type	String	Tipo de parámetro.

Ejemplo de las solicitudes

A continuación se muestra cómo consultar todos los algoritmos en trabajos cuyos nombres contienen TestModelArtsalgorithm y el número máximo de algoritmos se establece en 1.

GET    https://endpoint/v2/{project_id}/algorithms?limit=1&searches=name%3ATestModelArtsalgorithm

Ejemplo de las respuestas

Código de estado: 200

Aceptar

{
  "total" : 1,
  "count" : 1,
  "limit" : 1,
  "offset" : 0,
  "sort_by" : "create_time",
  "order" : "desc",
  "group_by" : "",
  "items" : [ {
    "metadata" : {
      "id" : "2e5451fe-913f-4492-821a-2981031382f7",
      "name" : "TestModelArtsalgorithm",
      "description" : "This is a ModelArts algorithm",
      "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" : { }
  } ]
}