MLClient Classe

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

Utilize este cliente para gerir recursos do Azure ML, como áreas de trabalho, trabalhos, modelos, etc.

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

Necessário

A credencial a utilizar para autenticação.

subscription_id

Optional[str]

valor predefinido: None

O ID da subscrição do Azure. Opcional apenas para recursos de registo. Predefinições para Nenhum.

resource_group_name

Optional[str]

valor predefinido: None

O grupo de recursos do Azure. Opcional apenas para recursos de registo. Predefinições para Nenhum.

workspace_name

Optional[str]

valor predefinido: None

A área de trabalho a utilizar no cliente. Opcional apenas para operações que não são dependentes da área de trabalho. Predefinições para Nenhum.

registry_name

Optional[str]

valor predefinido: None

O registo a utilizar no cliente. Opcional apenas para operações que não são dependentes da área de trabalho. Predefinições para Nenhum.

show_progress

Optional[bool]

Especifica se pretende ou não apresentar barras de progresso para operações de execução prolongada (por exemplo, os clientes podem considerar defini-lo como Falso se não utilizarem este SDK numa configuração interativa). Predefinições para Verdadeiro.

enable_telemetry

Optional[bool]

Especifica se quer ou não ativar a telemetria. Será substituído por Falso se não estiver num Jupyter Notebook. A predefinição é Verdadeiro se estiver num Jupyter Notebook.

cloud

Optional[str]

O nome da cloud a utilizar. A predefinição é "AzureCloud".

Exemplos

Ao utilizar domínios soberanos (ou seja, qualquer cloud que não AZURE_PUBLIC_CLOUD), tem de transmitir o nome da cloud em kwargs e tem de utilizar 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	Devolve um cliente de uma Área de Trabalho do Azure Machine Learning existente com uma configuração de ficheiro. Este método fornece uma forma simples de reutilizar a mesma área de trabalho em vários blocos de notas ou projetos python. Pode guardar as propriedades do Azure Resource Manager (ARM) de uma área de trabalho num ficheiro de configuração JSON com este formato: { "subscription_id": "<subscription-id>", "resource_group": "<resource-group>", "workspace_name": "<workspace-name>" } Em seguida, pode utilizar este método para carregar a mesma área de trabalho em blocos de notas ou projetos Python diferentes sem voltar a escrever as propriedades do ARM da área de trabalho.

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]

Necessário

O recurso para criar ou atualizar.

Devoluções

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]

Necessário

O recurso para criar ou atualizar.

Devoluções

O recurso criado ou atualizado.

Tipo de retorno

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

from_config

Devolve um cliente de uma Área de Trabalho do Azure Machine Learning existente com uma configuração de ficheiro.

Este método fornece uma forma simples de reutilizar a mesma área de trabalho em vários blocos de notas ou projetos python. Pode guardar as propriedades do Azure Resource Manager (ARM) de uma área de trabalho num ficheiro de configuração JSON com este formato:

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

Em seguida, pode utilizar este método para carregar a mesma área de trabalho em blocos de notas ou projetos Python diferentes sem voltar a escrever as propriedades do ARM da área de trabalho.

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

Parâmetros

credential

TokenCredential

Necessário

O objeto de credencial da área de trabalho.

path

Optional[Union[PathLike, str]]

O caminho para o ficheiro de configuração ou o diretório inicial para procurar o ficheiro de configuração no . Predefinições para Nenhum, indicando que o diretório atual será utilizado.

file_name

Optional[str]

O nome do ficheiro de configuração a procurar quando o caminho é um caminho de diretório. A predefinição é "config.json".

cloud

Optional[str]

O nome da cloud a utilizar. A predefinição é "AzureCloud".

Devoluções

O cliente de uma Área de Trabalho do Azure ML existente.

Tipo de retorno

MLClient

Exceções

ValidationException

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

Exemplos

Criar um MLClient a partir de um ficheiro com o nome "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")

Criar um MLClient a partir de um ficheiro com o nome "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 com a implementação de lotes.

Devoluções

Operações de Implementação do Batch.

Tipo de retorno

BatchDeploymentOperations

batch_endpoints

Uma coleção de operações relacionadas com pontos finais de lote.

Devoluções

Operações do Ponto Final do Batch

Tipo de retorno

BatchEndpointOperations

components

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

Devoluções

Operações de componentes.

Tipo de retorno

ComponentOperations

compute

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

Devoluções

Operações de computação

Tipo de retorno

ComputeOperations

connections

Uma coleção de operações relacionadas com a ligação da área de trabalho.

Devoluções

Operações de Ligações da Área de Trabalho

Tipo de retorno

WorkspaceConnectionsOperations

data

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

Devoluções

Operações de dados.

Tipo de retorno

DataOperations

datastores

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

Devoluções

Operações do arquivo de dados.

Tipo de retorno

DatastoreOperations

environments

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

Devoluções

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 com conjuntos de funcionalidades.

Devoluções

Operações de Conjunto de Funcionalidades

Tipo de retorno

FeatureSetOperations

feature_store_entities

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

Uma coleção de operações relacionadas com entidades do arquivo de funcionalidades.

Devoluções

Operações FeatureStoreEntity

Tipo de retorno

FeatureStoreEntityOperations

feature_stores

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

Uma coleção de operações relacionadas com o arquivo de funcionalidades.

Devoluções

Operações featureStore

Tipo de retorno

FeatureStoreOperations

jobs

Uma coleção de operações relacionadas com tarefas.

Devoluções

Operações de tarefas

Tipo de retorno

JobOperations

models

Uma coleção de operações relacionadas com modelos.

Devoluções

Operações de modelo

Tipo de retorno

ModelOperations

online_deployments

Uma coleção de operações relacionadas com a implementação online.

Devoluções

Operações de Implementação Online

Tipo de retorno

OnlineDeploymentOperations

online_endpoints

Uma coleção de operações relacionadas com pontos finais online.

Devoluções

Operações de Ponto Final Online

Tipo de retorno

OnlineEndpointOperations

registries

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

Uma coleção de operações relacionadas com o registo.

Devoluções

Operações de registo

Tipo de retorno

RegistryOperations

resource_group_name

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

Devoluções

Um nome de grupo de recursos do Azure.

Tipo de retorno

str

schedules

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

Devoluções

Agendar operações.

Tipo de retorno

ScheduleOperations

subscription_id

Obtenha o ID de subscrição de um objeto MLClient.

Devoluções

Um ID de subscrição do Azure.

Tipo de retorno

str

workspace_hubs

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

Uma coleção de operações relacionadas com o hub da área de trabalho.

Devoluções

Operações do Hub

Tipo de retorno

<xref:HubOperations>

workspace_name

O nome da área de trabalho onde as operações dependentes da área de trabalho serão executadas.

Devoluções

O nome da área de trabalho predefinida.

Tipo de retorno

Optional[str]

workspace_outbound_rules

Uma coleção de operações relacionadas com regras de saída da área de trabalho.

Devoluções

Operações de regras de saída da área de trabalho

Tipo de retorno

WorkspaceOutboundRuleOperations

workspaces

Uma coleção de operações relacionadas com a área de trabalho.

Devoluções

Operações da área de trabalho

Tipo de retorno

WorkspaceOperations

R

R = ~R

T

T = ~T