ComponentOperations Classe

ComponentOperations.

Você não deve instanciar essa classe diretamente. Em vez disso, você deve criar uma instância do MLClient que a instancie para você e a anexa como um atributo.

Herança

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

ComponentOperations

Construtor

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>

Obrigatório

O escopo da operação.

operation_config

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

Obrigatório

A configuração da operação.

service_client

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

Obrigatório

O cliente de serviço para operações de API.

all_operations

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

Obrigatório

O contêiner para todas as operações disponíveis.

preflight_operation

Optional[<xref:azure.ai.ml._vendor.azure_resources.operations.DeploymentsOperations>]

valor padrão: None

A operação de pré-vôo para implantações.

kwargs

Dict

Obrigatório

Argumentos de palavra-chave adicionais.

Métodos

archive	Arquive um componente.
create_or_update	Criar ou atualizar um componente especificado. se houver entidades definidas embutidas, por exemplo, Ambiente, Código, elas serão criadas junto com o componente .
download	Observação Esse é um método experimental e pode mudar a qualquer momento. Consulte https://aka.ms/azuremlexperimental para obter mais informações. Baixe o componente especificado e suas dependências para local. O componente local pode ser usado para criar o componente em outro workspace ou para desenvolvimento offline.
get	Retorna informações sobre o componente especificado.
list	Listar componentes ou componentes específicos do workspace.
restore	Restaurar um componente arquivado.
validate	Observação Esse é um método experimental e pode mudar a qualquer momento. Consulte https://aka.ms/azuremlexperimental para obter mais informações. validar um componente especificado. se houver entidades definidas embutidas, por exemplo, Ambiente, Código, elas não serão criadas.

archive

Arquive um componente.

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

Parâmetros

name

str

Obrigatório

Nome do componente.

version

str

Obrigatório

A versão do componente.

label

str

Obrigatório

Rótulo do componente. (mutuamente exclusivo com a versão).

Exemplos

Exemplo de componente de arquivo morto.

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

create_or_update

Criar ou atualizar um componente especificado. se houver entidades definidas embutidas, por exemplo, Ambiente, Código, elas serão criadas junto com o componente .

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

Parâmetros

component

Union[Component, FunctionType]

Obrigatório

O objeto de componente ou uma função de componente mldesigner que gera o objeto de componente

version

str

Obrigatório

A versão do componente a ser substituída.

skip_validation

bool

se deseja ignorar a validação antes de criar/atualizar o componente, o padrão é False

Retornos

O objeto de componente especificado.

Tipo de retorno

Component

Exceções

ValidationException

Gerado se o Componente não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

AssetException

Gerado se os ativos de componente (por exemplo, dados, código, modelo, ambiente) não puderem ser validados com êxito. Os detalhes serão fornecidos na mensagem de erro.

ComponentException

Gerado se o tipo de componente não tiver suporte. Os detalhes serão fornecidos na mensagem de erro.

ModelException

Gerado se o modelo de componente não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

EmptyDirectoryError

Gerado se o caminho local fornecido apontar para um diretório vazio.

Exemplos

Exemplo de criação de componente.

   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

Observação

Esse é um método experimental e pode mudar a qualquer momento. Consulte https://aka.ms/azuremlexperimental para obter mais informações.

Baixe o componente especificado e suas dependências para local. O componente local pode ser usado para criar o componente em outro workspace ou para desenvolvimento offline.

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

Parâmetros

name

str

Obrigatório

Nome do componente de código.

download_path

str

Obrigatório

Caminho local como destino de download, o padrão é o diretório de trabalho atual do usuário atual. Será criado se não existir.

version

Optional[str]

A versão do componente.

Retornos

O objeto de componente especificado.

Tipo de retorno

Component

Exceções

OSError

Gerado se download_path estiver apontando para um diretório existente que não está vazio. identificado e recuperado. Os detalhes serão fornecidos na mensagem de erro.

get

Retorna informações sobre o componente especificado.

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

Parâmetros

name

str

Obrigatório

Nome do componente de código.

version

Optional[str]

Obrigatório

A versão do componente.

label

Optional[str]

Obrigatório

Rótulo do componente, mutuamente exclusivo com a versão.

Retornos

O objeto de componente especificado.

Tipo de retorno

Component

Exceções

ValidationException

Gerado se o Componente não puder ser identificado e recuperado com êxito. Os detalhes serão fornecidos na mensagem de erro.

Exemplos

Obter exemplo de componente.

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

list

Listar componentes ou componentes específicos do workspace.

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

Parâmetros

name

Optional[str]

Obrigatório

Nome do componente, se não definido, lista todos os componentes do workspace

list_view_type

Tipo de exibição para incluir/excluir (por exemplo) componentes arquivados. Padrão: ACTIVE_ONLY.

Retornos

Um iterador como a instância de objetos de componente

Tipo de retorno

ItemPaged[Component]

Exemplos

Exemplo de componente de lista.

   print(ml_client.components.list())

restore

Restaurar um componente arquivado.

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

Parâmetros

name

str

Obrigatório

Nome do componente.

version

str

Obrigatório

A versão do componente.

label

str

Obrigatório

Rótulo do componente. (mutuamente exclusivo com a versão).

Exemplos

Exemplo de componente de restauração.

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

validate

Observação

Esse é um método experimental e pode mudar a qualquer momento. Consulte https://aka.ms/azuremlexperimental para obter mais informações.

validar um componente especificado. se houver entidades definidas embutidas, por exemplo, Ambiente, Código, elas não serão criadas.

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

Parâmetros

component

Union[Component, FunctionType]

Obrigatório

O objeto de componente ou uma função de componente mldesigner que gera o objeto de componente

raise_on_failure

bool

Obrigatório

Se deve gerar exceção no erro de validação. Usa False como padrão

Retornos

Todos os erros de validação

Tipo de retorno

ValidationResult