Partager via

CommandComponent Classe

  • Référence

Version du composant de commande, utilisée pour définir un composant de commande ou un travail.

Héritage
azure.ai.ml.entities._component.component.Component
CommandComponent
azure.ai.ml.entities._job.parameterized_command.ParameterizedCommand
CommandComponent
azure.ai.ml.entities._component._additional_includes.AdditionalIncludesMixin
CommandComponent

Constructeur

CommandComponent(*, name: str | None = None, version: str | None = None, description: str | None = None, tags: Dict | None = None, display_name: str | None = None, command: str | None = None, code: PathLike | str | None = None, environment: Environment | str | None = None, distribution: Dict | MpiDistribution | TensorFlowDistribution | PyTorchDistribution | RayDistribution | DistributionConfiguration | None = None, resources: JobResourceConfiguration | None = None, inputs: Dict | None = None, outputs: Dict | None = None, instance_count: int | None = None, is_deterministic: bool = True, additional_includes: List | None = None, properties: Dict | None = None, **kwargs: Any)

Paramètres de mot clé uniquement

Nom Description
name
Optional[str]

Nom du travail ou du composant Command.
version
Optional[str]

Version du travail ou du composant Command.
description
Optional[str]

Description du composant. La valeur par défaut est None.
tags
Optional[dict]

Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour. La valeur par défaut est None.
display_name
Optional[str]

Nom complet du composant.
command
Optional[str]

Commande à exécuter.
code

Code source pour exécuter le travail. Il peut s’agir d’un chemin d’accès local ou d’une URL « http : », « https : » ou « azureml : » pointant vers un emplacement distant.
environment
Optional[Union[str, Environment]]

Environnement dans lequel le travail s’exécutera.
distribution
Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]]

Configuration des travaux distribués. La valeur par défaut est None.
resources
Optional[JobResourceConfiguration]

Configuration de la ressource de calcul pour la commande .
inputs
Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]]

Mappage des noms d’entrée aux sources de données d’entrée utilisées dans le travail. La valeur par défaut est None.
outputs
Optional[dict[str, Union[str, Output]]]

Mappage des noms de sortie aux sources de données de sortie utilisées dans le travail. La valeur par défaut est None.
instance_count
Optional[int]

Nombre d’instances ou de nœuds à utiliser par la cible de calcul. La valeur par défaut est de 1.
is_deterministic
Optional[bool]

Spécifie si la commande retourne la même sortie en fonction de la même entrée. La valeur par défaut est True. Si la valeur est True, si une commande (composant) est déterministe et a été exécutée auparavant dans l’espace de travail actuel avec les mêmes entrées et paramètres, elle réutilise les résultats d’un travail envoyé précédent lorsqu’il est utilisé comme nœud ou étape dans un pipeline. Dans ce scénario, aucune ressource de calcul n’est utilisée.

valeur par défaut: True
additional_includes
Optional[List[str]]

Liste des fichiers supplémentaires partagés à inclure dans le composant. La valeur par défaut est None.
properties
Optional[dict[str, str]]

Dictionnaire de propriétés de travail. La valeur par défaut est None.

Exemples

Création d’un CommandComponent.


   from azure.ai.ml.entities import CommandComponent

   component = CommandComponent(
       name="sample_command_component_basic",
       display_name="CommandComponentBasic",
       description="This is the basic command component",
       tags={"tag": "tagvalue", "owner": "sdkteam"},
       version="1",
       outputs={"component_out_path": {"type": "uri_folder"}},
       command="echo Hello World",
       code="./src",
       environment="AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33",
   )

Méthodes

dump

Videz le contenu du composant dans un fichier au format yaml.

dump

Videz le contenu du composant dans un fichier au format yaml.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Paramètres

Nom Description
dest
Obligatoire
Union[<xref:PathLike>, str, IO[AnyStr]]

Destination pour recevoir le contenu de ce composant. Doit être un chemin d’accès à un fichier local ou un flux de fichier déjà ouvert. Si dest est un chemin d’accès de fichier, un nouveau fichier est créé et une exception est levée si le fichier existe. Si dest est un fichier ouvert, le fichier est écrit directement dans et une exception est levée si le fichier n’est pas accessible en écriture.

Attributs

base_path

Chemin de base de la ressource.

Retours

Type Description
str

Chemin de base de la ressource.

creation_context

Contexte de création de la ressource.

Retours

Type Description
Optional[SystemData]

Métadonnées de création de la ressource.

display_name

Nom d’affichage du composant.

Retours

Type Description
str

Nom d’affichage du composant.

distribution

Configuration du composant ou du travail de commande distribuée.

Retours

Type Description
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]

Configuration de distribution.

id

ID de la ressource.

Retours

Type Description
Optional[str]

L’ID global de la ressource, un ID Azure Resource Manager (ARM).

inputs

Entrées du composant.

Retours

Type Description
dict

Entrées du composant.

instance_count

Nombre d’instances ou de nœuds à utiliser par la cible de calcul.

Retours

Type Description
int

Nombre d’instances ou de nœuds.

is_deterministic

Indique si le composant est déterministe.

Retours

Type Description
bool

Si le composant est déterministe

outputs

Sorties du composant.

Retours

Type Description
dict

Sorties du composant.

resources

Configuration de la ressource de calcul pour le composant de commande ou le travail.

Retours

Type Description
JobResourceConfiguration

Configuration de la ressource de calcul pour le composant de commande ou le travail.

type

Type du composant, la valeur par défaut est 'command'.

Retours

Type Description
str

Type du composant.

version

Numéro de version du composant.

Retours

Type Description
str

Numéro de version du composant.