az ml component
Note
Esta referencia forma parte de la extensión ml para la CLI de Azure (versión 2.15.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az ml component. Obtenga más información sobre las extensiones.
Administración de componentes de Azure ML.
El componente de Azure ML define la configuración del componente para los trabajos de canalización. Puede configurar los puertos de entrada y salida, el entorno de ejecución y el comando del componente. Una vez creado el componente, puede hacer referencia a los componentes del trabajo de canalización para ejecutarlos en contenedores de Docker.
Comandos
| Nombre | Description | Tipo | Estado |
|---|---|---|---|
| az ml component archive |
Archivar un componente. |
Extension | GA |
| az ml component create |
Crear un componente. |
Extension | GA |
| az ml component list |
Enumere los componentes de un área de trabajo. |
Extension | GA |
| az ml component prepare-for-sign |
Prepare un componente para la firma. |
Extension | GA |
| az ml component restore |
Restaure un componente archivado. |
Extension | GA |
| az ml component show |
Mostrar los detalles de un componente. |
Extension | GA |
| az ml component update |
Actualización de un componente Actualmente solo hay algunos campos (descripción, display_name) que admiten la actualización. |
Extension | GA |
az ml component archive
Archivar un componente.
El archivado de un componente lo ocultará de forma predeterminada de las consultas de lista (az ml component list). Todavía puede seguir haciendo referencia y usar un componente archivado en las canalizaciones. Puede archivar un contenedor de componentes o una versión de componente específica. El archivado de un contenedor de componentes archivará todas las versiones del componente con ese nombre determinado. Puede restaurar un componente archivado mediante az ml component restore. Si se archiva todo el contenedor de componentes, no puede restaurar versiones individuales del componente; deberá restaurar el contenedor de componentes.
az ml component archive --name
[--label]
[--registry-name]
[--resource-group]
[--version]
[--workspace-name]
Ejemplos
Archivar un contenedor de componentes (archiva todas las versiones de ese componente)
az ml component archive --name my-component --resource-group my-resource-group --workspace-name my-workspace
Archivar una versión de componente específica
az ml component archive --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace
Parámetros requeridos
Nombre del componente.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Etiqueta del componente.
Si se proporciona, el comando tendrá como destino el registro en lugar de un área de trabajo. Por lo tanto, no será necesario el grupo de recursos y el área de trabajo.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Versión del componente.
Nombre del área de trabajo de Azure ML. Puede configurar el área de trabajo predeterminada mediante az configure --defaults workspace=<name>.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az ml component create
Crear un componente.
az ml component create --file
[--name]
[--registry-name]
[--resource-group]
[--set]
[--skip-validation]
[--version]
[--workspace-name]
Ejemplos
Creación de un componente a partir de un archivo de especificación de YAML
az ml component create --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace
Creación de un componente a partir de un archivo de especificación de YAML con la versión especificada
az ml component create --file my_component.yml --version 1 --resource-group my-resource-group --workspace-name my-workspace
Creación de un componente en el registro a partir de un archivo de especificación de YAML
az ml component create --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group
Creación de un componente en el registro a partir de un archivo de especificación de YAML con la versión especificada
az ml component create --file my_component.yml --version 1 --registry-name my-registry-name --resource-group my-resource-group
Parámetros requeridos
Ruta de acceso local al archivo YAML que contiene la especificación del componente de Azure ML. Los documentos de referencia de YAML para el componente se pueden encontrar en: https://aka.ms/ml-cli-v2-component-command-yaml-reference.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Nombre del componente.
Si se proporciona, el comando tendrá como destino el registro en lugar de un área de trabajo. Por lo tanto, no será necesario el grupo de recursos y el área de trabajo.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=value.
Omita la validación al crear el recurso. Tenga en cuenta que los recursos dependientes no omitirán su validación al crear.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Versión del componente.
Nombre del área de trabajo de Azure ML. Puede configurar el área de trabajo predeterminada mediante az configure --defaults workspace=<name>.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az ml component list
Enumere los componentes de un área de trabajo.
az ml component list [--archived-only]
[--include-archived]
[--max-results]
[--name]
[--registry-name]
[--resource-group]
[--workspace-name]
Ejemplos
Enumeración de todos los componentes de un área de trabajo
az ml component list --resource-group my-resource-group --workspace-name my-workspace
Enumeración de todas las versiones de componente para el nombre especificado en un área de trabajo
az ml component list --name my-component --resource-group my-resource-group --workspace-name my-workspace
Enumere todos los componentes de un área de trabajo mediante el argumento --query para ejecutar una consulta JMESPath en los resultados de los comandos.
az ml component list --query "[].{Name:name}" --output table --resource-group my-resource-group --workspace-name my-workspace
Enumerar todos los componentes de un registro
az ml component list --registry-name my-registry-name --resource-group my-resource-group
Enumeración de todas las versiones de componente para el nombre especificado en un registro
az ml component list --name my-component --registry-name my-registry-name --resource-group my-resource-group
Enumere todos los componentes de un registro mediante el argumento --query para ejecutar una consulta JMESPath en los resultados de los comandos.
az ml component list --query "[].{Name:name}" --output table --registry-name my-registry-name --resource-group my-resource-group
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Enumera solo los componentes archivados.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Enumera los componentes archivados y los componentes activos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Número máximo de resultados que se van a devolver.
Nombre del componente.
Si se proporciona, el comando tendrá como destino el registro en lugar de un área de trabajo. Por lo tanto, no será necesario el grupo de recursos y el área de trabajo.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Nombre del área de trabajo de Azure ML. Puede configurar el área de trabajo predeterminada mediante az configure --defaults workspace=<name>.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az ml component prepare-for-sign
Prepare un componente para la firma.
La preparación de un componente para el signo genera 2 archivos: catalog.json y catalog.json.sig, estos archivos contienen el SHA256 generado para cada archivo que está presente en la carpeta de destino. Si los archivos ya están presentes, se eliminarán y se crearán nuevos archivos con la firma actualizada.
az ml component prepare-for-sign --file
[--registry-name]
[--resource-group]
[--workspace-name]
Ejemplos
Preparación de un componente a partir de un archivo de especificación DE YAML para la firma
az ml component prepare-for-sign --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace
Preparación de un componente en el registro a partir de un archivo de especificación YAML para la firma
az ml component prepare-for-sign --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group
Parámetros requeridos
Ruta de acceso local al archivo YAML que contiene la especificación del componente de Azure ML. Los documentos de referencia de YAML para el componente se pueden encontrar en: https://aka.ms/ml-cli-v2-component-command-yaml-reference.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Si se proporciona, el comando tendrá como destino el registro en lugar de un área de trabajo. Por lo tanto, no será necesario el grupo de recursos y el área de trabajo.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Nombre del área de trabajo de Azure ML. Puede configurar el área de trabajo predeterminada mediante az configure --defaults workspace=<name>.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az ml component restore
Restaure un componente archivado.
Cuando se restaura un componente archivado, ya no se ocultará a las consultas de lista (az ml component list). Si se archiva un contenedor de componentes completo, puede restaurar ese contenedor archivado. Esto restaurará todas las versiones del componente con ese nombre determinado. No se puede restaurar solo una versión de componente específica si se archiva todo el contenedor de componentes; deberá restaurar todo el contenedor. Si solo se ha archivado una versión de componente individual, puede restaurar esa versión específica.
az ml component restore --name
[--label]
[--registry-name]
[--resource-group]
[--version]
[--workspace-name]
Ejemplos
Restaurar un contenedor de componentes archivados (restaura todas las versiones de ese componente)
az ml component restore --name my-component --resource-group my-resource-group --workspace-name my-workspace
Restaurar una versión específica del componente archivado
az ml component restore --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace
Parámetros requeridos
Nombre del componente.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Etiqueta del componente.
Si se proporciona, el comando tendrá como destino el registro en lugar de un área de trabajo. Por lo tanto, no será necesario el grupo de recursos y el área de trabajo.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Versión del componente.
Nombre del área de trabajo de Azure ML. Puede configurar el área de trabajo predeterminada mediante az configure --defaults workspace=<name>.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az ml component show
Mostrar los detalles de un componente.
az ml component show --name
[--label]
[--registry-name]
[--resource-group]
[--version]
[--workspace-name]
Ejemplos
Mostrar detalles de un componente con el nombre y la versión especificados
az ml component show --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace
Mostrar detalles de un componente en el Registro con el nombre y la versión especificados
az ml component show --name my-component --version 1 --registry-name my-registry-name --resource-group my-resource-group
Parámetros requeridos
Nombre del componente.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Etiqueta del componente.
Si se proporciona, el comando tendrá como destino el registro en lugar de un área de trabajo. Por lo tanto, no será necesario el grupo de recursos y el área de trabajo.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Versión del componente.
Nombre del área de trabajo de Azure ML. Puede configurar el área de trabajo predeterminada mediante az configure --defaults workspace=<name>.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az ml component update
Actualización de un componente Actualmente solo hay algunos campos (descripción, display_name) que admiten la actualización.
az ml component update --name
--resource-group
--workspace-name
[--add]
[--force-string]
[--label]
[--registry-name]
[--remove]
[--set]
[--version]
Ejemplos
Actualizar la descripción de un componente
az ml component update -n my_component -v 1 --set description="new description" -g my-resource-group -w my-workspace
Parámetros requeridos
Nombre del componente.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Nombre del área de trabajo de Azure ML. Puede configurar el área de trabajo predeterminada mediante az configure --defaults workspace=<name>.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Generic Update Arguments |
| Valor predeterminado: | [] |
Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Generic Update Arguments |
| Valor predeterminado: | False |
Etiqueta del componente.
Si se proporciona, el comando tendrá como destino el registro en lugar de un área de trabajo. Por lo tanto, no será necesario el grupo de recursos y el área de trabajo.
Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Generic Update Arguments |
| Valor predeterminado: | [] |
Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Generic Update Arguments |
| Valor predeterminado: | [] |
Versión del componente.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |