EnvironmentOperations Classe

EnvironmentOperations.

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

EnvironmentOperations

Construtor

EnvironmentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, all_operations: OperationsContainer, **kwargs: Any)

Parâmetros

operation_scope

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

Obrigatório

Variáveis de escopo para as classes de operações de um objeto MLClient.

operation_config

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

Obrigatório

Configuração comum para classes de operações de um objeto MLClient.

service_client

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

Obrigatório

Cliente de serviço para permitir que os usuários finais operem nos recursos do Workspace do Azure Machine Learning (ServiceClient042023Preview ou ServiceClient102021Dataplane).

all_operations

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

Obrigatório

Todas as classes de operações de um objeto MLClient.

Métodos

archive	Arquive um ambiente ou uma versão de ambiente.
create_or_update	Retorna o ativo de ambiente criado ou atualizado.
get	Retorna o ativo de ambiente especificado.
list	Listar todos os ativos de ambiente no workspace.
restore	Restaurar uma versão de ambiente arquivado.
share	Observação Esse é um método experimental e pode mudar a qualquer momento. Consulte https://aka.ms/azuremlexperimental para obter mais informações. Compartilhe um ativo de ambiente do workspace para o registro.

archive

Arquive um ambiente ou uma versão de ambiente.

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

Parâmetros

name

str

Obrigatório

Nome do ambiente.

version

str

Obrigatório

Versão do ambiente.

label

str

Obrigatório

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

Exemplos

Exemplo de arquivo morto.

   ml_client.environments.archive("create-environment", "2.0")

create_or_update

Retorna o ativo de ambiente criado ou atualizado.

create_or_update(environment: Environment) -> Environment

Parâmetros

environment

<xref:azure.ai.ml.entities._assets.Environment>

Obrigatório

Objeto Environment

Retornos

Objeto Environment criado ou atualizado

Tipo de retorno

Environment

Exceções

ValidationException

Gerado se Ambiente 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

Criar ambiente.

   from azure.ai.ml.entities import BuildContext, Environment

   env_docker_context = Environment(
       build=BuildContext(
           path="./sdk/ml/azure-ai-ml/tests/test_configs/environment/environment_files",
           dockerfile_path="DockerfileNonDefault",
       ),
       name="create-environment",
       version="2.0",
       description="Environment created from a Docker context.",
   )
   ml_client.environments.create_or_update(env_docker_context)

get

Retorna o ativo de ambiente especificado.

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

Parâmetros

name

str

Obrigatório

Nome do ambiente.

version

str

Obrigatório

Versão do ambiente.

label

str

Obrigatório

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

Retornos

Objeto Environment

Tipo de retorno

Environment

Exceções

ValidationException

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

Exemplos

Obter exemplo.

   ml_client.environments.get("create-environment", "2.0")

list

Listar todos os ativos de ambiente no workspace.

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

Parâmetros

name

Optional[str]

Obrigatório

Nome do ambiente.

list_view_type

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

Retornos

Um iterador como a instância de objetos Environment.

Tipo de retorno

ItemPaged[Environment]

Exemplos

Exemplo de lista.

   ml_client.environments.list()

restore

Restaurar uma versão de ambiente arquivado.

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

Parâmetros

name

str

Obrigatório

Nome do ambiente.

version

str

Obrigatório

Versão do ambiente.

label

str

Obrigatório

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

Exemplos

Exemplo de restauração.

   ml_client.environments.restore("create-environment", "2.0")

share

Observação

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

Compartilhe um ativo de ambiente do workspace para o registro.

share(name: str, version: str, *, share_with_name: str, share_with_version: str, registry_name: str) -> Environment

Parâmetros

name

str

Obrigatório

Nome do ativo de ambiente.

version

str

Obrigatório

Versão do ativo de ambiente.

share_with_name

str

Nome do ativo de ambiente com o qual compartilhar.

share_with_version

str

Versão do ativo de ambiente com o qual compartilhar.

registry_name

str

Nome do registro de destino.

Retornos

Objeto de ativo de ambiente.

Tipo de retorno

Environment