Partager via

az ml component

Note

Cette référence fait partie de l’extension ml pour Azure CLI (version 2.15.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez un composant ml commande. Apprenez-en davantage sur les extensions.

Gérer les composants Azure ML.

Le composant Azure ML définit la configuration du composant pour les travaux de pipeline. Vous pouvez configurer les ports d’entrée/sortie, l’environnement d’exécution et la commande du composant. Une fois le composant créé, vous pouvez référencer les composants du travail de pipeline pour les exécuter dans des conteneurs Docker.

Commandes

Nom Description Type État
az ml component archive

Archivez un composant.

 Extension GA
az ml component create

Créez un composant.

 Extension GA
az ml component list

Répertorier les composants d’un espace de travail.

 Extension GA
az ml component prepare-for-sign

Préparez un composant pour la signature.

 Extension GA
az ml component restore

Restaurez un composant archivé.

 Extension GA
az ml component show

Afficher les détails d’un composant.

 Extension GA
az ml component update

Mettez à jour un composant. Actuellement, seuls quelques champs (description, display_name) prennent en charge la mise à jour.

 Extension GA

az ml component archive

Archivez un composant.

L’archivage d’un composant le masque par défaut dans les requêtes de liste (az ml component list). Vous pouvez toujours continuer à référencer et utiliser un composant archivé dans vos pipelines. Vous pouvez archiver un conteneur de composants ou une version de composant spécifique. L’archivage d’un conteneur de composants archive toutes les versions du composant sous ce nom donné. Vous pouvez restaurer un composant archivé à l’aide de az ml component restore. Si l’intégralité du conteneur de composants est archivée, vous ne pouvez pas restaurer des versions individuelles du composant. Vous devez restaurer le conteneur du composant.

az ml component archive --name
                        [--label]
                        [--registry-name]
                        [--resource-group]
                        [--version]
                        [--workspace-name]

Exemples

Archiver un conteneur de composants (archive toutes les versions de ce composant)

az ml component archive --name my-component --resource-group my-resource-group --workspace-name my-workspace

Archiver une version spécifique d’un composant

az ml component archive --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

Paramètres obligatoires

--name -n

Nom du composant.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--label -l

Étiquette du composant.

--registry-name

Si elle est fournie, la commande cible le Registre au lieu d’un espace de travail. Par conséquent, le groupe de ressources et l’espace de travail ne sont pas obligatoires.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--version -v

Version du composant.

--workspace-name -w

Nom de l’espace de travail Azure ML. Vous pouvez configurer l’espace de travail par défaut à l’aide az configure --defaults workspace=<name>de .

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az ml component create

Créez un composant.

az ml component create --file
                       [--name]
                       [--registry-name]
                       [--resource-group]
                       [--set]
                       [--skip-validation]
                       [--version]
                       [--workspace-name]

Exemples

Créer un composant à partir d’un fichier de spécification YAML

az ml component create --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace

Créer un composant à partir d’un fichier de spécification YAML avec la version spécifiée

az ml component create --file my_component.yml --version 1 --resource-group my-resource-group --workspace-name my-workspace

Créer un composant dans le Registre à partir d’un fichier de spécification YAML

az ml component create --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group

Créer un composant dans le Registre à partir d’un fichier de spécification YAML avec la version spécifiée

az ml component create --file my_component.yml --version 1 --registry-name my-registry-name --resource-group my-resource-group

Paramètres obligatoires

--file -f

Chemin local du fichier YAML contenant la spécification du composant Azure ML. Vous trouverez les documents de référence YAML pour le composant à l’adresse suivante : https://aka.ms/ml-cli-v2-component-command-yaml-reference.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--name -n

Nom du composant.

--registry-name

Si elle est fournie, la commande cible le Registre au lieu d’un espace de travail. Par conséquent, le groupe de ressources et l’espace de travail ne sont pas obligatoires.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=value.

--skip-validation

Ignorez la validation lors de la création de la ressource. Notez que les ressources dépendantes n’ignorent pas leur validation lors de la création.

Propriété Valeur
Valeur par défaut: False
--version -v

Version du composant.

--workspace-name -w

Nom de l’espace de travail Azure ML. Vous pouvez configurer l’espace de travail par défaut à l’aide az configure --defaults workspace=<name>de .

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az ml component list

Répertorier les composants d’un espace de travail.

az ml component list [--archived-only]
                     [--include-archived]
                     [--max-results]
                     [--name]
                     [--registry-name]
                     [--resource-group]
                     [--workspace-name]

Exemples

Répertorier tous les composants d’un espace de travail

az ml component list --resource-group my-resource-group --workspace-name my-workspace

Répertorier toutes les versions du composant pour le nom spécifié dans un espace de travail

az ml component list --name my-component --resource-group my-resource-group --workspace-name my-workspace

Répertoriez tous les composants d’un espace de travail à l’aide de l’argument --query pour exécuter une requête JMESPath sur les résultats des commandes.

az ml component list --query "[].{Name:name}"  --output table --resource-group my-resource-group --workspace-name my-workspace

Répertorier tous les composants d’un registre

az ml component list --registry-name my-registry-name --resource-group my-resource-group

Répertorier toutes les versions de composant pour le nom spécifié dans un registre

az ml component list --name my-component --registry-name my-registry-name --resource-group my-resource-group

Répertoriez tous les composants d’un registre à l’aide de l’argument --query pour exécuter une requête JMESPath sur les résultats des commandes.

az ml component list --query "[].{Name:name}"  --output table --registry-name my-registry-name --resource-group my-resource-group

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--archived-only

Répertorier uniquement les composants archivés.

Propriété Valeur
Valeur par défaut: False
--include-archived

Répertorier les composants archivés et les composants actifs.

Propriété Valeur
Valeur par défaut: False
--max-results -r

Nombre maximal de résultats à retourner.

--name -n

Nom du composant.

--registry-name

Si elle est fournie, la commande cible le Registre au lieu d’un espace de travail. Par conséquent, le groupe de ressources et l’espace de travail ne sont pas obligatoires.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--workspace-name -w

Nom de l’espace de travail Azure ML. Vous pouvez configurer l’espace de travail par défaut à l’aide az configure --defaults workspace=<name>de .

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az ml component prepare-for-sign

Préparez un composant pour la signature.

La préparation d’un composant pour la signature génère 2 fichiers : catalog.json et catalog.json.sig, ces fichiers contiennent les fichiers SHA256 générés pour chaque fichier présent dans le dossier cible. Si les fichiers sont déjà présents, ils seront supprimés et de nouveaux fichiers seront créés avec la signature mise à jour.

az ml component prepare-for-sign --file
                                 [--registry-name]
                                 [--resource-group]
                                 [--workspace-name]

Exemples

Préparer un composant à partir d’un fichier de spécification YAML pour la signature

az ml component prepare-for-sign --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace

Préparer un composant dans le Registre à partir d’un fichier de spécification YAML pour la signature

az ml component prepare-for-sign --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group

Paramètres obligatoires

--file -f

Chemin local du fichier YAML contenant la spécification du composant Azure ML. Vous trouverez les documents de référence YAML pour le composant à l’adresse suivante : https://aka.ms/ml-cli-v2-component-command-yaml-reference.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--registry-name

Si elle est fournie, la commande cible le Registre au lieu d’un espace de travail. Par conséquent, le groupe de ressources et l’espace de travail ne sont pas obligatoires.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--workspace-name -w

Nom de l’espace de travail Azure ML. Vous pouvez configurer l’espace de travail par défaut à l’aide az configure --defaults workspace=<name>de .

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az ml component restore

Restaurez un composant archivé.

Lorsqu’un composant archivé est restauré, il ne sera plus masqué dans les requêtes de liste (az ml component list). Si un conteneur de composant entier est archivé, vous pouvez restaurer ce conteneur archivé. Cela restaure toutes les versions du composant sous ce nom donné. Vous ne pouvez restaurer qu’une version de composant spécifique si l’intégralité du conteneur de composants est archivée. Vous devez restaurer l’intégralité du conteneur. Si seule une version de composant individuelle a été archivée, vous pouvez restaurer cette version spécifique.

az ml component restore --name
                        [--label]
                        [--registry-name]
                        [--resource-group]
                        [--version]
                        [--workspace-name]

Exemples

Restaurer un conteneur de composant archivé (restaure toutes les versions de ce composant)

az ml component restore --name my-component --resource-group my-resource-group --workspace-name my-workspace

Restaurer une version spécifique d’un composant archivé

az ml component restore --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

Paramètres obligatoires

--name -n

Nom du composant.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--label -l

Étiquette du composant.

--registry-name

Si elle est fournie, la commande cible le Registre au lieu d’un espace de travail. Par conséquent, le groupe de ressources et l’espace de travail ne sont pas obligatoires.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--version -v

Version du composant.

--workspace-name -w

Nom de l’espace de travail Azure ML. Vous pouvez configurer l’espace de travail par défaut à l’aide az configure --defaults workspace=<name>de .

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az ml component show

Afficher les détails d’un composant.

az ml component show --name
                     [--label]
                     [--registry-name]
                     [--resource-group]
                     [--version]
                     [--workspace-name]

Exemples

Afficher les détails d’un composant avec le nom et la version spécifiés

az ml component show --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

Afficher les détails d’un composant dans le Registre avec le nom et la version spécifiés

az ml component show --name my-component --version 1 --registry-name my-registry-name --resource-group my-resource-group

Paramètres obligatoires

--name -n

Nom du composant.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--label -l

Étiquette du composant.

--registry-name

Si elle est fournie, la commande cible le Registre au lieu d’un espace de travail. Par conséquent, le groupe de ressources et l’espace de travail ne sont pas obligatoires.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--version -v

Version du composant.

--workspace-name -w

Nom de l’espace de travail Azure ML. Vous pouvez configurer l’espace de travail par défaut à l’aide az configure --defaults workspace=<name>de .

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az ml component update

Mettez à jour un composant. Actuellement, seuls quelques champs (description, display_name) prennent en charge la mise à jour.

az ml component update --name
                       --resource-group
                       --workspace-name
                       [--add]
                       [--force-string]
                       [--label]
                       [--registry-name]
                       [--remove]
                       [--set]
                       [--version]

Exemples

Mettre à jour la description d’un composant

az ml component update -n my_component -v 1 --set description="new description" -g my-resource-group -w my-workspace

Paramètres obligatoires

--name -n

Nom du composant.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--workspace-name -w

Nom de l’espace de travail Azure ML. Vous pouvez configurer l’espace de travail par défaut à l’aide az configure --defaults workspace=<name>de .

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string or JSON string>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeur par défaut: []
--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeur par défaut: False
--label -l

Étiquette du composant.

--registry-name

Si elle est fournie, la commande cible le Registre au lieu d’un espace de travail. Par conséquent, le groupe de ressources et l’espace de travail ne sont pas obligatoires.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeur par défaut: []
--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=<value>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeur par défaut: []
--version -v

Version du composant.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False