ComponentOperations Clase

  • Referencia

ComponentOperations.

No debe crear una instancia de esta clase directamente. En su lugar, debe crear una instancia de MLClient que le cree instancias y la adjunte como un atributo.

Herencia
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
ComponentOperations

Constructor

ComponentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, all_operations: OperationsContainer, preflight_operation: DeploymentsOperations | None = None, **kwargs: Dict)

Parámetros

operation_scope
<xref:azure.ai.ml._scope_dependent_operations.OperationScope>
Requerido

Ámbito de la operación.

operation_config
<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>
Requerido

Configuración de la operación.

service_client
Union[ <xref:azure.ai.ml._restclient.v2022_10_01.AzureMachineLearningWorkspaces>, <xref:azure.ai.ml._restclient.v2021_10_01_dataplanepreview.AzureMachineLearningWorkspaces>]
Requerido

Cliente de servicio para operaciones de API.

all_operations
<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>
Requerido

Contenedor para todas las operaciones disponibles.

preflight_operation
Optional[<xref:azure.ai.ml._vendor.azure_resources.operations.DeploymentsOperations>]
valor predeterminado: None

Operación preparatoria para implementaciones.

kwargs
Dict
Requerido

Argumentos de palabra clave adicionales.

Métodos

archive

Archivar un componente.
create_or_update

Cree o actualice un componente especificado. Si hay entidades definidas insertadas, por ejemplo, Entorno, Código, se crearán junto con el componente .
download

Nota

Se trata de un método experimental y puede cambiar en cualquier momento. Consulte https://aka.ms/azuremlexperimental para más información.

Descargue el componente especificado y sus dependencias en local. El componente local se puede usar para crear el componente en otra área de trabajo o para el desarrollo sin conexión.
get

Devuelve información sobre el componente especificado.
list

Enumerar componentes o componentes específicos del área de trabajo.
restore

Restaure un componente archivado.
validate

Nota

Se trata de un método experimental y puede cambiar en cualquier momento. Consulte https://aka.ms/azuremlexperimental para más información.

valide un componente especificado. Si hay entidades definidas insertadas, por ejemplo, Entorno, Código, no se crearán.

archive

Archivar un componente.

archive(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

Parámetros

name
str
Requerido

Nombre del componente.

version
str
Requerido

Versión del componente.

label
str
Requerido

Etiqueta del componente. (mutuamente excluyente con la versión).

Ejemplos

Ejemplo de componente de archivo.


   ml_client.components.archive(name=component_example.name)

create_or_update

Cree o actualice un componente especificado. Si hay entidades definidas insertadas, por ejemplo, Entorno, Código, se crearán junto con el componente .

create_or_update(component: Component | function, version=None, *, skip_validation: bool = False, **kwargs) -> Component

Parámetros

component
Union[Component, FunctionType]
Requerido

El objeto de componente o una función de componente mldesigner que genera un objeto de componente

version
str
Requerido

Versión del componente que se va a invalidar.

skip_validation
bool

si se omite la validación antes de crear o actualizar el componente, el valor predeterminado es False.

Devoluciones

Objeto de componente especificado.

Tipo de valor devuelto

Component

Excepciones

ValidationException

Se genera si el componente no se puede validar correctamente. Los detalles se proporcionarán en el mensaje de error.

AssetException

Se genera si los recursos de componente (por ejemplo, datos, código, modelo, entorno) no se pueden validar correctamente. Los detalles se proporcionarán en el mensaje de error.

ComponentException

Se genera si el tipo de componente no es compatible. Los detalles se proporcionarán en el mensaje de error.

ModelException

Se genera si el modelo de componentes no se puede validar correctamente. Los detalles se proporcionarán en el mensaje de error.

EmptyDirectoryError

Se genera si la ruta de acceso local proporcionada apunta a un directorio vacío.

Ejemplos

Ejemplo de creación de componentes.


   from azure.ai.ml import load_component
   from azure.ai.ml.entities._component.component import Component

   component_example = load_component(
       source="./sdk/ml/azure-ai-ml/tests/test_configs/components/helloworld_component.yml",
       params_override=[{"version": "1.0.2"}],
   )
   component = ml_client.components.create_or_update(component_example)

download

Nota

Se trata de un método experimental y puede cambiar en cualquier momento. Consulte https://aka.ms/azuremlexperimental para más información.

Descargue el componente especificado y sus dependencias en local. El componente local se puede usar para crear el componente en otra área de trabajo o para el desarrollo sin conexión.

download(name: str, download_path: PathLike | str = '.', *, version: str = None) -> None

Parámetros

name
str
Requerido

Nombre del componente de código.

download_path
str
Requerido

Ruta de acceso local como destino de descarga, el valor predeterminado es el directorio de trabajo actual del usuario actual. Se creará si no existe.

version
Optional[str]

Versión del componente.

Devoluciones

Objeto de componente especificado.

Tipo de valor devuelto

Component

Excepciones

OSError

Se genera si download_path apunta a un directorio existente que no está vacío. identificado y recuperado. Los detalles se proporcionarán en el mensaje de error.

get

Devuelve información sobre el componente especificado.

get(name: str, version: str | None = None, label: str | None = None) -> Component

Parámetros

name
str
Requerido

Nombre del componente de código.

version
Optional[str]
Requerido

Versión del componente.

label
Optional[str]
Requerido

Etiqueta del componente, mutuamente excluyente con la versión.

Devoluciones

Objeto de componente especificado.

Tipo de valor devuelto

Component

Excepciones

ValidationException

Se genera si Component no se puede identificar y recuperar correctamente. Los detalles se proporcionarán en el mensaje de error.

Ejemplos

Ejemplo de obtención de componentes.


   ml_client.components.get(name=component_example.name, version="1.0.2")

list

Enumerar componentes o componentes específicos del área de trabajo.

list(name: str | None = None, *, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY) -> Iterable[Component]

Parámetros

name
Optional[str]
Requerido

Nombre del componente, si no se establece, enumere todos los componentes del área de trabajo.

list_view_type

Tipo de vista para incluir o excluir (por ejemplo) componentes archivados. Valor predeterminado: ACTIVE_ONLY.

Devoluciones

Iterador como la instancia de objetos de componente

Tipo de valor devuelto

ItemPaged[Component]

Ejemplos

Ejemplo de componente de lista.


   print(ml_client.components.list())

restore

Restaure un componente archivado.

restore(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

Parámetros

name
str
Requerido

Nombre del componente.

version
str
Requerido

Versión del componente.

label
str
Requerido

Etiqueta del componente. (mutuamente excluyente con la versión).

Ejemplos

Ejemplo de componente de restauración.


   ml_client.components.restore(name=component_example.name)

validate

Nota

Se trata de un método experimental y puede cambiar en cualquier momento. Consulte https://aka.ms/azuremlexperimental para más información.

valide un componente especificado. Si hay entidades definidas insertadas, por ejemplo, Entorno, Código, no se crearán.

validate(component: Component | function, raise_on_failure: bool = False, **kwargs) -> ValidationResult

Parámetros

component
Union[Component, FunctionType]
Requerido

El objeto de componente o una función de componente mldesigner que genera un objeto de componente

raise_on_failure
bool
Requerido

Indica si se va a producir una excepción en el error de validación. El valor predeterminado es False.

Devoluciones

Todos los errores de validación

Tipo de valor devuelto

ValidationResult