CommandComponent Classe

Versão do componente de comando, utilizada para definir um Componente de Comando ou Uma Tarefa.

Herança

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

Construtor

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)

Parâmetros Só de Palavra-Chave

Name	Description
name	Optional[str] O nome da tarefa de comando ou componente.
version	Optional[str] A versão do componente ou tarefa de Comando.
description	Optional[str] A descrição do componente. A predefinição é Nenhuma.
tags	Optional[dict] Dicionário de etiquetas. As etiquetas podem ser adicionadas, removidas e atualizadas. A predefinição é Nenhuma.
display_name	Optional[str] O nome a apresentar do componente.
command	Optional[str] O comando a ser executado.
code	O código fonte para executar a tarefa. Pode ser um caminho local ou "http:", "https:" ou um URL "azureml:" a apontar para uma localização remota.
environment	Optional[Union[str, Environment]] O ambiente no qual a tarefa será executada.
distribution	Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] A configuração para tarefas distribuídas. A predefinição é Nenhuma.
resources	Optional[JobResourceConfiguration] A configuração do recurso de computação para o comando .
inputs	Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]] Um mapeamento de nomes de entrada para origens de dados de entrada utilizadas na tarefa. A predefinição é Nenhuma.
outputs	Optional[dict[str, Union[str, Output]]] Um mapeamento de nomes de saída para origens de dados de saída utilizadas na tarefa. A predefinição é Nenhuma.
instance_count	Optional[int] O número de instâncias ou nós a utilizar pelo destino de computação. A predefinição é 1.
is_deterministic	Optional[bool] Especifica se o Comando irá devolver a mesma saída dada a mesma entrada. A predefinição é Verdadeiro. Quando Verdadeiro, se um Comando (componente) for determinista e tiver sido executado anteriormente na área de trabalho atual com a mesma entrada e definições, reutilizará os resultados de uma tarefa submetida anterior quando utilizado como nó ou passo num pipeline. Nesse cenário, não serão utilizados recursos de computação. valor predefinido: True
additional_includes	Optional[List[str]] Uma lista de ficheiros adicionais partilhados a serem incluídos no componente. A predefinição é Nenhuma.
properties	Optional[dict[str, str]] O dicionário da propriedade da tarefa. A predefinição é Nenhuma.

Exemplos

Criar um 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étodos

dump	Despeje o conteúdo do componente num ficheiro no formato yaml.

dump

Despeje o conteúdo do componente num ficheiro no formato yaml.

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

Parâmetros

Name

Description

dest Necessário

Union[<xref:PathLike>, str, IO[AnyStr]] O destino para receber o conteúdo deste componente. Tem de ser um caminho para um ficheiro local ou um fluxo de ficheiros já aberto. Se dest for um caminho de ficheiro, será criado um novo ficheiro e será gerada uma exceção se o ficheiro existir. Se dest for um ficheiro aberto, o ficheiro será escrito diretamente e será gerada uma exceção se o ficheiro não for gravável.

Atributos

base_path

O caminho base do recurso.

Devoluções

Tipo	Description
str	O caminho base do recurso.

creation_context

O contexto de criação do recurso.

Devoluções

Tipo	Description
Optional[SystemData]	Os metadados de criação do recurso.

display_name

Nome a apresentar do componente.

Devoluções

Tipo	Description
str	Nome a apresentar do componente.

distribution

A configuração para o componente ou tarefa de comando distribuído.

Devoluções

Tipo	Description
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]	A configuração de distribuição.

id

O ID do recurso.

Devoluções

Tipo	Description
Optional[str]	O ID global do recurso, um ID de Resource Manager do Azure (ARM).

inputs

Entradas do componente.

Devoluções

Tipo	Description
dict	Entradas do componente.

instance_count

O número de instâncias ou nós a utilizar pelo destino de computação.

Devoluções

Tipo	Description
int	O número de instâncias ou nós.

is_deterministic

Se o componente é determinista.

Devoluções

Tipo	Description
bool	Se o componente é determinista

outputs

Saídas do componente.

Devoluções

Tipo	Description
dict	Saídas do componente.

resources

A configuração do recurso de computação para o componente de comando ou tarefa.

Devoluções

Tipo	Description
JobResourceConfiguration	A configuração do recurso de computação para o componente de comando ou tarefa.

type

Tipo de componente, a predefinição é "comando".

Devoluções

Tipo	Description
str	Tipo do componente.

version

Versão do componente.

Devoluções

Tipo	Description
str	Versão do componente.