Compartir a través de

CommandComponent Clase

  • Referencia

Versión del componente de comando, que se usa para definir un componente de comando o un trabajo.

Herencia
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

Constructor

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 de palabra clave únicamente

Nombre Description
name
Optional[str]

Nombre del trabajo de comando o componente.
version
Optional[str]

Versión del trabajo o componente Command.
description
Optional[str]

Descripción del componente. El valor predeterminado es None.
tags
Optional[dict]

Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar. El valor predeterminado es None.
display_name
Optional[str]

El nombre para mostrar del componente.
command
Optional[str]

Comando que se va a ejecutar.
code

Código fuente para ejecutar el trabajo. Puede ser una ruta de acceso local o "http:", "https:" o "azureml:" que apunte a una ubicación remota.
environment
Optional[Union[str, Environment]]

Entorno en el que se ejecutará el trabajo.
distribution
Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]]

Configuración de trabajos distribuidos. El valor predeterminado es None.
resources
Optional[JobResourceConfiguration]

Configuración del recurso de proceso para el comando .
inputs
Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]]

Asignación de nombres de entrada a orígenes de datos de entrada usados en el trabajo. El valor predeterminado es None.
outputs
Optional[dict[str, Union[str, Output]]]

Asignación de nombres de salida a orígenes de datos de salida usados en el trabajo. El valor predeterminado es None.
instance_count
Optional[int]

Número de instancias o nodos que va a usar el destino de proceso. De manera predeterminada, su valor es 1.
is_deterministic
Optional[bool]

Especifica si el comando devolverá la misma salida según la misma entrada. El valor predeterminado es True. Cuando es True, si un comando (componente) es determinista y se ha ejecutado antes en el área de trabajo actual con la misma entrada y configuración, reutilizará los resultados de un trabajo enviado anterior cuando se usa como nodo o paso en una canalización. En ese escenario, no se usará ningún recurso de proceso.

valor predeterminado: True
additional_includes
Optional[List[str]]

Lista de archivos adicionales compartidos que se incluirán en el componente. El valor predeterminado es None.
properties
Optional[dict[str, str]]

Diccionario de propiedades de trabajo. El valor predeterminado es None.

Ejemplos

Crear un objeto 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

Volque el contenido del componente en un archivo en formato yaml.

dump

Volque el contenido del componente en un archivo en formato yaml.

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

Parámetros

Nombre Description
dest
Requerido
Union[<xref:PathLike>, str, IO[AnyStr]]

Destino para recibir el contenido de este componente. Debe ser una ruta de acceso a un archivo local o una secuencia de archivos ya abierta. Si dest es una ruta de acceso de archivo, se creará un nuevo archivo y se generará una excepción si el archivo existe. Si dest es un archivo abierto, el archivo se escribirá directamente en y se generará una excepción si el archivo no se puede escribir.

Atributos

base_path

Ruta de acceso base del recurso.

Devoluciones

Tipo Description
str

Ruta de acceso base del recurso.

creation_context

Contexto de creación del recurso.

Devoluciones

Tipo Description
Optional[SystemData]

Metadatos de creación del recurso.

display_name

Nombre para mostrar del componente.

Devoluciones

Tipo Description
str

Nombre para mostrar del componente.

distribution

Configuración del componente de comando distribuido o del trabajo.

Devoluciones

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

Configuración de distribución.

id

El identificador del recurso.

Devoluciones

Tipo Description
Optional[str]

Identificador global del recurso, un identificador de Azure Resource Manager (ARM).

inputs

Entradas del componente.

Devoluciones

Tipo Description
dict

Entradas del componente.

instance_count

Número de instancias o nodos que va a usar el destino de proceso.

Devoluciones

Tipo Description
int

Número de instancias o nodos.

is_deterministic

Si el componente es determinista.

Devoluciones

Tipo Description
bool

Si el componente es determinista

outputs

Salidas del componente.

Devoluciones

Tipo Description
dict

Salidas del componente.

resources

Configuración del recurso de proceso para el componente de comando o el trabajo.

Devoluciones

Tipo Description
JobResourceConfiguration

Configuración del recurso de proceso para el componente de comando o el trabajo.

type

El tipo del componente, el valor predeterminado es "command".

Devoluciones

Tipo Description
str

Tipo del componente.

version

Versión del componente.

Devoluciones

Tipo Description
str

Versión del componente.