CommandComponent Classe

Versão do componente de comando, usada para definir um componente de comando ou trabalho.

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 somente de palavra-chave

Nome	Description
name	Optional[str] O nome do trabalho ou componente Command.
version	Optional[str] A versão do trabalho ou componente Command.
description	Optional[str] A descrição do componente. Assume o valor padrão de Nenhum.
tags	Optional[dict] Dicionário de marcas. As marcas podem ser adicionadas, removidas e atualizadas. Assume o valor padrão de Nenhum.
display_name	Optional[str] O nome de exibição do componente.
command	Optional[str] O comando a ser executado.
code	O código-fonte para executar o trabalho. Pode ser um caminho local ou uma URL "http:", "https:" ou "azureml:" apontando para um local remoto.
environment	Optional[Union[str, Environment]] O ambiente no qual o trabalho será executado.
distribution	Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] A configuração para trabalhos distribuídos. Assume o valor padrão de Nenhum.
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 fontes de dados de entrada usadas no trabalho. Assume o valor padrão de Nenhum.
outputs	Optional[dict[str, Union[str, Output]]] Um mapeamento de nomes de saída para gerar fontes de dados usadas no trabalho. Assume o valor padrão de Nenhum.
instance_count	Optional[int] O número de instâncias ou nós a serem usados pelo destino de computação. O valor padrão é 1.
is_deterministic	Optional[bool] Especifica se o Comando retornará a mesma saída dada a mesma entrada. O padrão é True. Quando True, se um Comando (componente) for determinístico e tiver sido executado antes no workspace atual com a mesma entrada e configurações, ele reutilizará os resultados de um trabalho enviado anteriormente quando usado como um nó ou etapa em um pipeline. Nesse cenário, nenhum recurso de computação será usado. valor padrão: True
additional_includes	Optional[List[str]] Uma lista de arquivos adicionais compartilhados a serem incluídos no componente. Assume o valor padrão de Nenhum.
properties	Optional[dict[str, str]] O dicionário de propriedades do trabalho. Assume o valor padrão de Nenhum.

Exemplos

Criando 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 em um arquivo no formato yaml.

dump

Despeje o conteúdo do componente em um arquivo no formato yaml.

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

Parâmetros

Nome

Description

dest Obrigatório

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

Atributos

base_path

O caminho base do recurso.

Retornos

Tipo	Description
str	O caminho base do recurso.

creation_context

O contexto de criação do recurso.

Retornos

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

display_name

Nome de exibição do componente.

Retornos

Tipo	Description
str	Nome de exibição do componente.

distribution

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

Retornos

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

id

A ID do recurso.

Retornos

Tipo	Description
Optional[str]	A ID global do recurso, uma ID do ARM (Resource Manager do Azure).

inputs

Entradas do componente.

Retornos

Tipo	Description
dict	Entradas do componente.

instance_count

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

Retornos

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

is_deterministic

Se o componente é determinístico.

Retornos

Tipo	Description
bool	Se o componente é determinístico

outputs

Saídas do componente.

Retornos

Tipo	Description
dict	Saídas do componente.

resources

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

Retornos

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

type

Tipo do componente, o padrão é 'command'.

Retornos

Tipo	Description
str	Tipo do componente.

version

A versão do componente.

Retornos

Tipo	Description
str	A versão do componente.