MLClient Classe

  • Referência

Uma classe cliente para interagir com os serviços do Azure ML.

Use esse cliente para gerenciar recursos do Azure ML, como workspaces, trabalhos, modelos e assim por diante.

Herança
builtins.object
MLClient

Construtor

MLClient(credential: TokenCredential, subscription_id: str | None = None, resource_group_name: str | None = None, workspace_name: str | None = None, registry_name: str | None = None, **kwargs: Any)

Parâmetros

credential
TokenCredential
Obrigatório

A credencial a ser usada para autenticação.

subscription_id
Optional[str]
valor padrão: None

A ID de assinatura do Azure. Opcional somente para ativos do Registro. Assume o valor padrão de Nenhum.

resource_group_name
Optional[str]
valor padrão: None

O grupo de recursos do Azure. Opcional somente para ativos do Registro. Assume o valor padrão de Nenhum.

workspace_name
Optional[str]
valor padrão: None

O workspace a ser usado no cliente. Opcional somente para operações que não dependem do workspace. Assume o valor padrão de Nenhum.

registry_name
Optional[str]
valor padrão: None

O registro a ser usado no cliente. Opcional somente para operações que não dependem do workspace. Assume o valor padrão de Nenhum.

show_progress
Optional[bool]

Especifica se as barras de progresso devem ou não ser exibidas para operações de execução prolongada (por exemplo, os clientes podem considerar definir isso como False se não estiverem usando esse SDK em uma configuração interativa). O padrão é True.

enable_telemetry
Optional[bool]

Especifica se a telemetria deve ou não ser habilitada. Será substituído para False se não estiver em um Jupyter Notebook. O padrão será True se estiver em um Jupyter Notebook.

cloud
Optional[str]

O nome da nuvem a ser usado. O padrão é "AzureCloud".

Exemplos

Ao usar domínios soberanos (ou seja, qualquer nuvem diferente de AZURE_PUBLIC_CLOUD), você deve passar o nome da nuvem em kwargs e deve usar uma autoridade com DefaultAzureCredential.


   from azure.ai.ml import MLClient
   from azure.identity import AzureAuthorityHosts, DefaultAzureCredential

   kwargs = {"cloud": "AzureChinaCloud"}
   ml_client = MLClient(
       subscription_id=subscription_id,
       resource_group_name=resource_group,
       credential=DefaultAzureCredential(authority=AzureAuthorityHosts.AZURE_CHINA),
       **kwargs,
   )

Métodos

begin_create_or_update

Cria ou atualiza um recurso do Azure ML de forma assíncrona.
create_or_update

Cria ou atualiza um recurso do Azure ML.
from_config

Retorna um cliente de um workspace do Azure Machine Learning existente usando uma configuração de arquivo.

Esse método fornece uma maneira simples de reutilizar o mesmo workspace em vários notebooks ou projetos do Python. Você pode salvar as propriedades do ARM (Azure Resource Manager) de um workspace em um arquivo de configuração JSON usando este formato:


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

Em seguida, você pode usar esse método para carregar o mesmo workspace em diferentes blocos de anotações ou projetos do Python sem redigir as propriedades do ARM do workspace.

begin_create_or_update

Cria ou atualiza um recurso do Azure ML de forma assíncrona.

begin_create_or_update(entity: R, **kwargs) -> LROPoller[R]

Parâmetros

entity
Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]
Obrigatório

O recurso a ser criado ou atualizado.

Retornos

O recurso após a operação de criação/atualização.

Tipo de retorno

LROPoller[Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]]

create_or_update

Cria ou atualiza um recurso do Azure ML.

create_or_update(entity: T, **kwargs) -> T

Parâmetros

entity
Union[Job , Model, Environment, Component , Datastore]
Obrigatório

O recurso a ser criado ou atualizado.

Retornos

O recurso criado ou atualizado.

Tipo de retorno

Union[Job, Model , Environment, Component, Datastore]

from_config

Retorna um cliente de um workspace do Azure Machine Learning existente usando uma configuração de arquivo.

Esse método fornece uma maneira simples de reutilizar o mesmo workspace em vários notebooks ou projetos do Python. Você pode salvar as propriedades do ARM (Azure Resource Manager) de um workspace em um arquivo de configuração JSON usando este formato:


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

Em seguida, você pode usar esse método para carregar o mesmo workspace em diferentes blocos de anotações ou projetos do Python sem redigir as propriedades do ARM do workspace.

from_config(credential: TokenCredential, *, path: PathLike | str | None = None, file_name=None, **kwargs) -> MLClient

Parâmetros

credential
TokenCredential
Obrigatório

O objeto de credencial para o workspace.

path
Optional[Union[PathLike, str]]

O caminho para o arquivo de configuração ou diretório inicial para pesquisar o arquivo de configuração dentro. O padrão é Nenhum, indicando que o diretório atual será usado.

file_name
Optional[str]

O nome do arquivo de configuração a ser pesquisado quando o caminho é um caminho de diretório. O padrão é "config.json".

cloud
Optional[str]

O nome da nuvem a ser usado. O padrão é "AzureCloud".

Retornos

O cliente de um Workspace do Azure ML existente.

Tipo de retorno

MLClient

Exceções

ValidationException

Gerado se "config.json" ou file_name se substituído, não puder ser encontrado no diretório. Os detalhes serão fornecidos na mensagem de erro.

Exemplos

Criando um MLClient de um arquivo chamado "config.json" no diretório "src".


   from azure.ai.ml import MLClient

   client = MLClient.from_config(credential=DefaultAzureCredential(), path="./sdk/ml/azure-ai-ml/samples/src")

Criando um MLClient de um arquivo chamado "team_workspace_configuration.json" no diretório atual.


   from azure.ai.ml import MLClient

   client = MLClient.from_config(
       credential=DefaultAzureCredential(),
       file_name="./sdk/ml/azure-ai-ml/samples/team_workspace_configuration.json",
   )

Atributos

batch_deployments

Uma coleção de operações relacionadas à implantação em lote.

Retornos

Operações de implantação em lote.

Tipo de retorno

BatchDeploymentOperations

batch_endpoints

Uma coleção de operações relacionadas ao ponto de extremidade em lote.

Retornos

Operações de ponto de extremidade em lote

Tipo de retorno

BatchEndpointOperations

components

Uma coleção de operações relacionadas a componentes.

Retornos

Operações de componente.

Tipo de retorno

ComponentOperations

compute

Uma coleção de operações relacionadas à computação.

Retornos

Operações de computação

Tipo de retorno

ComputeOperations

connections

Uma coleção de operações relacionadas à conexão de workspace.

Retornos

Operações de conexões de workspace

Tipo de retorno

WorkspaceConnectionsOperations

data

Uma coleção de operações relacionadas a dados.

Retornos

Operações de dados.

Tipo de retorno

DataOperations

datastores

Uma coleção de operações relacionadas ao armazenamento de dados.

Retornos

Operações de armazenamento de dados.

Tipo de retorno

DatastoreOperations

environments

Uma coleção de operações relacionadas ao ambiente.

Retornos

Operações de ambiente.

Tipo de retorno

EnvironmentOperations

feature_sets

aka.ms/azuremlexperimental para obter mais informações.

Uma coleção de operações relacionadas ao conjunto de recursos.

Retornos

Operações do FeatureSet

Tipo de retorno

FeatureSetOperations

feature_store_entities

aka.ms/azuremlexperimental para obter mais informações.

Uma coleção de operações relacionadas à entidade do repositório de recursos.

Retornos

Operações featureStoreEntity

Tipo de retorno

FeatureStoreEntityOperations

feature_stores

aka.ms/azuremlexperimental para obter mais informações.

Uma coleção de operações relacionadas ao repositório de recursos.

Retornos

Operações do FeatureStore

Tipo de retorno

FeatureStoreOperations

jobs

Uma coleção de operações relacionadas ao trabalho.

Retornos

Operações de trabalho

Tipo de retorno

JobOperations

models

Uma coleção de operações relacionadas ao modelo.

Retornos

Operações de modelo

Tipo de retorno

ModelOperations

online_deployments

Uma coleção de operações relacionadas à implantação online.

Retornos

Operações de implantação online

Tipo de retorno

OnlineDeploymentOperations

online_endpoints

Uma coleção de operações relacionadas ao ponto de extremidade online.

Retornos

Operações de ponto de extremidade online

Tipo de retorno

OnlineEndpointOperations

registries

aka.ms/azuremlexperimental para obter mais informações.

Uma coleção de operações relacionadas ao Registro.

Retornos

Operações de registro

Tipo de retorno

RegistryOperations

resource_group_name

Obtenha o nome do grupo de recursos de um objeto MLClient.

Retornos

Um nome de grupo de recursos do Azure.

Tipo de retorno

str

schedules

Uma coleção de operações relacionadas ao agendamento.

Retornos

Agendar operações.

Tipo de retorno

ScheduleOperations

subscription_id

Obtenha a ID da assinatura de um objeto MLClient.

Retornos

uma ID da assinatura do Azure;

Tipo de retorno

str

workspace_hubs

aka.ms/azuremlexperimental para obter mais informações.

Uma coleção de operações relacionadas ao hub de workspace.

Retornos

Operações do Hub

Tipo de retorno

<xref:HubOperations>

workspace_name

O nome do workspace em que as operações dependentes do workspace serão executadas.

Retornos

O nome do workspace padrão.

Tipo de retorno

Optional[str]

workspace_outbound_rules

Uma coleção de operações relacionadas à regra de saída do workspace.

Retornos

Operações de regra de saída do workspace

Tipo de retorno

WorkspaceOutboundRuleOperations

workspaces

Uma coleção de operações relacionadas ao workspace.

Retornos

Operações de workspace

Tipo de retorno

WorkspaceOperations

R 

R = ~R

T 

T = ~T