MLClient Classe

Une classe cliente pour interagir avec les services Azure ML.

Utilisez ce client pour gérer les ressources Azure ML telles que les espaces de travail, les travaux, les modèles, etc.

Héritage

builtins.object

MLClient

Constructeur

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)

Paramètres

credential

TokenCredential

Obligatoire

Informations d’identification à utiliser pour l’authentification.

subscription_id

Optional[str]

valeur par défaut: None

L’ID d’abonnement Azure. Facultatif pour les ressources du Registre uniquement. La valeur par défaut est None.

resource_group_name

Optional[str]

valeur par défaut: None

Groupe de ressources Azure. Facultatif pour les ressources du Registre uniquement. La valeur par défaut est None.

workspace_name

Optional[str]

valeur par défaut: None

Espace de travail à utiliser dans le client. Facultatif uniquement pour les opérations qui ne dépendent pas de l’espace de travail. La valeur par défaut est None.

registry_name

Optional[str]

valeur par défaut: None

Registre à utiliser dans le client. Facultatif uniquement pour les opérations qui ne dépendent pas de l’espace de travail. La valeur par défaut est None.

show_progress

Optional[bool]

Spécifie s’il faut afficher ou non des barres de progression pour les opérations de longue durée (par exemple, les clients peuvent envisager de définir cette valeur sur False s’ils n’utilisent pas ce KIT de développement logiciel (SDK) dans une installation interactive). La valeur par défaut est True.

enable_telemetry

Optional[bool]

Spécifie si la télémétrie doit être active ou non. Est remplacé par False si ce n’est pas dans un Jupyter Notebook. La valeur par défaut est True si dans un Jupyter Notebook.

cloud

Optional[str]

Nom du cloud à utiliser. La valeur par défaut est « AzureCloud ».

Exemples

Lorsque vous utilisez des domaines souverains (c’est-à-dire tout cloud autre que AZURE_PUBLIC_CLOUD), vous devez passer le nom du cloud dans kwargs et vous devez utiliser une autorité avec 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éthodes

begin_create_or_update	Crée ou met à jour une ressource Azure ML de manière asynchrone.
create_or_update	Crée ou met à jour une ressource Azure ML.
from_config	Retourne un client à partir d’un espace de travail Azure Machine Learning existant à l’aide d’une configuration de fichier. Cette méthode offre un moyen simple de réutiliser le même espace de travail sur plusieurs notebooks ou projets Python. Vous pouvez enregistrer les propriétés Azure Resource Manager (ARM) d’un espace de travail dans un fichier de configuration JSON au format suivant : { "subscription_id": "<subscription-id>", "resource_group": "<resource-group>", "workspace_name": "<workspace-name>" } Ensuite, vous pouvez utiliser cette méthode pour charger le même espace de travail dans différents notebooks ou projets Python sans retaper les propriétés ARM de l’espace de travail.

begin_create_or_update

Crée ou met à jour une ressource Azure ML de manière asynchrone.

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

Paramètres

entity

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

Obligatoire

Ressource à créer ou à mettre à jour.

Retours

Ressource après l’opération de création/mise à jour.

Type de retour

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

create_or_update

Crée ou met à jour une ressource Azure ML.

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

Paramètres

entity

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

Obligatoire

Ressource à créer ou à mettre à jour.

Retours

Ressource créée ou mise à jour.

Type de retour

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

from_config

Retourne un client à partir d’un espace de travail Azure Machine Learning existant à l’aide d’une configuration de fichier.

Cette méthode offre un moyen simple de réutiliser le même espace de travail sur plusieurs notebooks ou projets Python. Vous pouvez enregistrer les propriétés Azure Resource Manager (ARM) d’un espace de travail dans un fichier de configuration JSON au format suivant :

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

Ensuite, vous pouvez utiliser cette méthode pour charger le même espace de travail dans différents notebooks ou projets Python sans retaper les propriétés ARM de l’espace de travail.

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

Paramètres

credential

TokenCredential

Obligatoire

Objet d’informations d’identification pour l’espace de travail.

path

Optional[Union[PathLike, str]]

Chemin d’accès au fichier de configuration ou au répertoire de départ dans lequel rechercher le fichier de configuration. La valeur par défaut est None, ce qui indique que le répertoire actif sera utilisé.

file_name

Optional[str]

Nom du fichier de configuration à rechercher lorsque le chemin d’accès est un chemin d’accès au répertoire. La valeur par défaut est « config.json ».

cloud

Optional[str]

Nom du cloud à utiliser. La valeur par défaut est « AzureCloud ».

Retours

Client d’un espace de travail Azure ML existant.

Type de retour

MLClient

Exceptions

ValidationException

Déclenché si « config.json », ou file_name en cas de substitution, est introuvable dans le répertoire. Les détails seront fournis dans le message d’erreur.

Exemples

Création d’un MLClient à partir d’un fichier nommé « config.json » dans le répertoire « src ».

   from azure.ai.ml import MLClient

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

Création d’un MLClient à partir d’un fichier nommé « team_workspace_configuration.json » dans le répertoire actif.

   from azure.ai.ml import MLClient

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

Attributs

batch_deployments

Collection d’opérations liées au déploiement par lots.

Retours

Opérations de déploiement par lots.

Type de retour

BatchDeploymentOperations

batch_endpoints

Collection d’opérations liées au point de terminaison de lot.

Retours

Opérations de point de terminaison Batch

Type de retour

BatchEndpointOperations

components

Collection d’opérations liées aux composants.

Retours

Opérations de composant.

Type de retour

ComponentOperations

compute

Collection d’opérations liées au calcul.

Retours

Opérations de calcul

Type de retour

ComputeOperations

connections

Collection d’opérations liées à la connexion d’espace de travail.

Retours

Opérations de connexions de l’espace de travail

Type de retour

WorkspaceConnectionsOperations

data

Collection d’opérations liées aux données.

Retours

Opérations de données.

Type de retour

DataOperations

datastores

Collection d’opérations liées au magasin de données.

Retours

Opérations de magasin de données.

Type de retour

DatastoreOperations

environments

Collection d’opérations liées à l’environnement.

Retours

Opérations d’environnement.

Type de retour

EnvironmentOperations

feature_sets

aka.ms/azuremlexperimental pour plus d’informations.

Collection d’opérations liées aux ensembles de fonctionnalités.

Retours

Opérations FeatureSet

Type de retour

FeatureSetOperations

feature_store_entities

aka.ms/azuremlexperimental pour plus d’informations.

Collection d’opérations liées aux entités de magasin de fonctionnalités.

Retours

Opérations FeatureStoreEntity

Type de retour

FeatureStoreEntityOperations

feature_stores

aka.ms/azuremlexperimental pour plus d’informations.

Collection d’opérations liées au magasin de fonctionnalités.

Retours

Opérations FeatureStore

Type de retour

FeatureStoreOperations

jobs

Collection d’opérations liées au travail.

Retours

Opérations de travail

Type de retour

JobOperations

models

Collection d’opérations liées au modèle.

Retours

Opérations de modèle

Type de retour

ModelOperations

online_deployments

Collection d’opérations liées au déploiement en ligne.

Retours

Opérations de déploiement en ligne

Type de retour

OnlineDeploymentOperations

online_endpoints

Collection d’opérations liées au point de terminaison en ligne.

Retours

Opérations de point de terminaison en ligne

Type de retour

OnlineEndpointOperations

registries

aka.ms/azuremlexperimental pour plus d’informations.

Collection d’opérations liées au Registre.

Retours

Opérations du registre

Type de retour

RegistryOperations

resource_group_name

Obtient le nom du groupe de ressources d’un objet MLClient.

Retours

Un nom de groupe de ressources Azure.

Type de retour

str

schedules

Collection d’opérations liées à la planification.

Retours

Planifier des opérations.

Type de retour

ScheduleOperations

subscription_id

Obtenez l’ID d’abonnement d’un objet MLClient.

Retours

Un ID d’abonnement Azure.

Type de retour

str

workspace_hubs

aka.ms/azuremlexperimental pour plus d’informations.

Collection d’opérations liées au hub d’espace de travail.

Retours

Opérations de hub

Type de retour

<xref:HubOperations>

workspace_name

Nom de l’espace de travail dans lequel les opérations dépendantes de l’espace de travail seront exécutées.

Retours

Nom de l’espace de travail par défaut.

Type de retour

Optional[str]

workspace_outbound_rules

Collection d’opérations liées aux règles sortantes de l’espace de travail.

Retours

Opérations de règle de trafic sortant de l’espace de travail

Type de retour

WorkspaceOutboundRuleOperations

workspaces

Collection d’opérations liées à l’espace de travail.

Retours

Opérations de l’espace de travail

Type de retour

WorkspaceOperations

R

R = ~R

T

T = ~T