MLClient Classe

Riferimento

Classe client per interagire con i servizi di Azure ML.

Usare questo client per gestire le risorse di Azure ML, ad esempio aree di lavoro, processi, modelli e così via.

Ereditarietà: builtins.object

MLClient

Costruttore

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)

Parametri

credential: TokenCredential

Necessario

Credenziali da usare per l'autenticazione.

subscription_id: Optional[str]

valore predefinito: None

ID sottoscrizione di Azure. Facoltativo solo per gli asset del Registro di sistema. Il valore predefinito è Nessuno.

resource_group_name: Optional[str]

valore predefinito: None

Gruppo di risorse di Azure. Facoltativo solo per gli asset del Registro di sistema. Il valore predefinito è Nessuno.

workspace_name: Optional[str]

valore predefinito: None

Area di lavoro da usare nel client. Facoltativo solo per le operazioni non dipendenti dall'area di lavoro. Il valore predefinito è Nessuno.

registry_name: Optional[str]

valore predefinito: None

Registro di sistema da utilizzare nel client. Facoltativo solo per le operazioni non dipendenti dall'area di lavoro. Il valore predefinito è Nessuno.

show_progress: Optional[bool]

Specifica se visualizzare o meno le barre di stato per le operazioni a esecuzione prolungata, ad esempio i clienti possono prendere in considerazione l'impostazione su False se non si usa questo SDK in un'installazione interattiva. Il valore predefinito è True.

enable_telemetry: Optional[bool]

Specifica se abilitare o meno i dati di telemetria. Verrà sottoposto a override su False se non in un Jupyter Notebook. Il valore predefinito è True se in un Jupyter Notebook.

cloud: Optional[str]

Nome del cloud da usare. Il valore predefinito è "AzureCloud".

Esempio

Quando si usano domini sovrani,ad esempio qualsiasi cloud diverso da AZURE_PUBLIC_CLOUD, è necessario passare il nome del cloud in kwargs ed è necessario usare un'autorità con 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,
   )

Metodi

begin_create_or_update

Crea o aggiorna una risorsa di Azure ML in modo asincrono.

create_or_update

Crea o aggiorna una risorsa di Azure ML.

from_config

Restituisce un client da un'area di lavoro di Azure Machine Learning esistente usando una configurazione di file.

Questo metodo offre un modo semplice per riutilizzare la stessa area di lavoro in più notebook o progetti Python. È possibile salvare le proprietà di Azure Resource Manager (ARM) di un'area di lavoro in un file di configurazione JSON usando questo formato:


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

È quindi possibile usare questo metodo per caricare la stessa area di lavoro in diversi notebook o progetti Python senza digitare di nuovo le proprietà arm dell'area di lavoro.

begin_create_or_update

Crea o aggiorna una risorsa di Azure ML in modo asincrono.

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

Parametri

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

Necessario

Risorsa da creare o aggiornare.

Restituisce

Risorsa dopo l'operazione di creazione/aggiornamento.

Tipo restituito

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

create_or_update

Crea o aggiorna una risorsa di Azure ML.

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

Parametri

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

Necessario

Risorsa da creare o aggiornare.

Restituisce

Risorsa creata o aggiornata.

Tipo restituito

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

from_config

Restituisce un client da un'area di lavoro di Azure Machine Learning esistente usando una configurazione di file.


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

È quindi possibile usare questo metodo per caricare la stessa area di lavoro in diversi notebook o progetti Python senza digitare di nuovo le proprietà arm dell'area di lavoro.

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

Parametri

credential: TokenCredential

Necessario

Oggetto credenziale per l'area di lavoro.

path: Optional[Union[PathLike, str]]

Percorso del file di configurazione o della directory iniziale in cui cercare il file di configurazione. Il valore predefinito è Nessuno, che indica che verrà usata la directory corrente.

file_name: Optional[str]

Nome del file di configurazione da cercare quando il percorso è un percorso di directory. Il valore predefinito è "config.json".

cloud: Optional[str]

Nome del cloud da usare. Il valore predefinito è "AzureCloud".

Restituisce

Client per un'area di lavoro di Azure ML esistente.

Tipo restituito

MLClient

Eccezioni

ValidationException

Generato se "config.json" o file_name se sottoposto a override, non è possibile trovare nella directory . I dettagli verranno forniti nel messaggio di errore.

Esempio

Creazione di un MLClient da un file denominato "config.json" nella directory "src".


   from azure.ai.ml import MLClient

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

Creazione di un MLClient da un file denominato "team_workspace_configuration.json" nella directory corrente.


   from azure.ai.ml import MLClient

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

aka.ms/azuremlexperimental per altre informazioni.

Raccolta di operazioni correlate al set di funzionalità.

Restituisce

Operazioni featureset

Tipo restituito

FeatureSetOperations

feature_store_entities

aka.ms/azuremlexperimental per altre informazioni.

Raccolta di operazioni correlate all'entità dell'archivio funzionalità.

Restituisce

Operazioni FeatureStoreEntity

Tipo restituito

FeatureStoreEntityOperations

feature_stores

registries

workspace_hubs

R

R = ~R

T

T = ~T