Partager via

az ml component

  • Référence

Remarque

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 une commande de composant az ml. En savoir plus 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 Statut
az ml component archive

Archivez un composant.

 Extension GA
az ml component create

Créer un composant.

 Extension GA
az ml component list

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

 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

Mettre à 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 az ml component restorede . 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

--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 en utilisant az configure --defaults group=<name>.

--version -v

Numéro de 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 le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az ml component create

Créer 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

--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 en utilisant 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=.

--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.

valeur par défaut: False
--version -v

Numéro de 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 le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

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

--archived-only

Répertorier uniquement les composants archivés.

valeur par défaut: False
--include-archived

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

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 en utilisant 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 le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

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

--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 en utilisant az configure --defaults group=<name>.

--version -v

Numéro de 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 le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

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

--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 en utilisant az configure --defaults group=<name>.

--version -v

Numéro de 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 le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az ml component update

Mettre à 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 en utilisant 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

--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>.

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.

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.

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>.

valeur par défaut: []
--version -v

Numéro de version du composant.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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