CommandComponent Classe

Versione del componente di comando usata per definire un componente di comando o un processo.

Ereditarietà

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

Costruttore

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)

Parametri di sole parole chiave

Nome	Descrizione
name	Optional[str] Nome del processo o del componente Command.
version	Optional[str] Versione del processo o del componente Command.
description	Optional[str] Descrizione del componente. Il valore predefinito è Nessuna.
tags	Optional[dict] Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. Il valore predefinito è Nessuna.
display_name	Optional[str] Nome visualizzato del componente
command	Optional[str] Comando da eseguire.
code	Codice sorgente da eseguire il processo. Può essere un percorso locale o "http:", "https:" o "azureml:" url che punta a una posizione remota.
environment	Optional[Union[str, Environment]] Ambiente in cui verrà eseguito il processo.
distribution	Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] Configurazione per i processi distribuiti. Il valore predefinito è Nessuna.
resources	Optional[JobResourceConfiguration] Configurazione della risorsa di calcolo per il comando.
inputs	Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]] Mapping dei nomi di input alle origini dati di input usate nel processo. Il valore predefinito è Nessuna.
outputs	Optional[dict[str, Union[str, Output]]] Mapping dei nomi di output alle origini dati di output usate nel processo. Il valore predefinito è Nessuna.
instance_count	Optional[int] Numero di istanze o nodi da usare dalla destinazione di calcolo. Assume il valore predefinito 1.
is_deterministic	Optional[bool] Specifica se il comando restituirà lo stesso output dato lo stesso input. Impostazione predefinita su True. Quando True, se un comando (componente) è deterministico ed è stato eseguito prima nell'area di lavoro corrente con le stesse impostazioni di input e impostazioni, verrà riutilizzato i risultati di un processo inviato precedente quando viene usato come nodo o passaggio in una pipeline. In questo scenario non verranno usate risorse di calcolo. valore predefinito: True
additional_includes	Optional[List[str]] Elenco di file aggiuntivi condivisi da includere nel componente. Il valore predefinito è Nessuna.
properties	Optional[dict[str, str]] Dizionario delle proprietà del processo. Il valore predefinito è Nessuna.

Esempio

Creazione di un comandoComponent.

   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",
   )

Metodi

dump	Eseguire il dump del contenuto del componente in un file in formato yaml.

dump

Eseguire il dump del contenuto del componente in un file in formato yaml.

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

Parametri

Nome

Descrizione

dest Necessario

Union[<xref:PathLike>, str, IO[AnyStr]] Destinazione per ricevere il contenuto di questo componente. Deve essere un percorso di un file locale o un flusso di file già aperto. Se si verifica un percorso di file, verrà creato un nuovo file e viene generata un'eccezione se il file esiste. Se il massimo è un file aperto, il file verrà scritto direttamente in e verrà generata un'eccezione se il file non è scrivibile.

Attributi

base_path

Percorso di base della risorsa.

Restituisce

Tipo	Descrizione
str	Percorso di base della risorsa.

creation_context

Contesto di creazione della risorsa.

Restituisce

Tipo	Descrizione
Optional[SystemData]	Metadati di creazione per la risorsa.

display_name

Nome visualizzato del componente.

Restituisce

Tipo	Descrizione
str	Nome visualizzato del componente.

distribution

Configurazione del componente o del processo di comando distribuito.

Restituisce

Tipo	Descrizione
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]	Configurazione della distribuzione.

id

L'ID della risorsa.

Restituisce

Tipo	Descrizione
Optional[str]	ID globale della risorsa, ID di Azure Resource Manager (ARM).

inputs

Input del componente.

Restituisce

Tipo	Descrizione
dict	Input del componente.

instance_count

Numero di istanze o nodi da usare dalla destinazione di calcolo.

Restituisce

Tipo	Descrizione
int	Numero di istanze o nodi.

is_deterministic

Indica se il componente è deterministico.

Restituisce

Tipo	Descrizione
bool	Indica se il componente è deterministico

outputs

Output del componente.

Restituisce

Tipo	Descrizione
dict	Output del componente.

resources

Configurazione della risorsa di calcolo per il componente di comando o il processo.

Restituisce

Tipo	Descrizione
JobResourceConfiguration	Configurazione della risorsa di calcolo per il componente di comando o il processo.

type

Il tipo del componente, il valore predefinito è 'command'.

Restituisce

Tipo	Descrizione
str	Tipo del componente.

version

Versione del componente.

Restituisce

Tipo	Descrizione
str	Versione del componente.