Freigeben über

MLClient Klasse

  • Referenz

Eine Clientklasse für die Interaktion mit Azure ML-Diensten.

Verwenden Sie diesen Client, um Azure ML-Ressourcen wie Arbeitsbereiche, Aufträge, Modelle usw. zu verwalten.

Vererbung
builtins.object
MLClient

Konstruktor

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)

Parameter

credential
TokenCredential
Erforderlich

Die Anmeldeinformationen, die für die Authentifizierung verwendet werden sollen.

subscription_id
Optional[str]
Standardwert: None

Die Azure-Abonnement-ID. Optional nur für Registrierungsressourcen. Der Standardwert ist „None“.

resource_group_name
Optional[str]
Standardwert: None

Die Azure-Ressourcengruppe. Optional nur für Registrierungsressourcen. Der Standardwert ist „None“.

workspace_name
Optional[str]
Standardwert: None

Der Arbeitsbereich, der im Client verwendet werden soll. Optional nur für Vorgänge, die nicht arbeitsbereichsabhängig sind. Der Standardwert ist „None“.

registry_name
Optional[str]
Standardwert: None

Die Registrierung, die im Client verwendet werden soll. Optional nur für Vorgänge, die nicht arbeitsbereichsabhängig sind. Der Standardwert ist „None“.

show_progress
Optional[bool]

Gibt an, ob Statusanzeigen für Vorgänge mit langer Ausführungsdauer angezeigt werden sollen (Kunden können z. B. erwägen, dies auf False festzulegen, wenn sie dieses SDK nicht in einem interaktiven Setup verwenden). Der Standardwert ist „True“.

enable_telemetry
Optional[bool]

Gibt an, ob Telemetriedaten aktiviert werden sollen. Wird auf False überschrieben, wenn nicht in einem Jupyter Notebook. Der Standardwert ist True, wenn in einem Jupyter Notebook.

cloud
Optional[str]

Der zu verwendende Cloudname. Der Standardwert ist "AzureCloud".

Beispiele

Wenn Sie Sovereign-Domänen (d. h. jede andere Cloud als AZURE_PUBLIC_CLOUD) verwenden, müssen Sie den Cloudnamen in kwargs übergeben, und Sie müssen eine Autorität mit DefaultAzureCredential verwenden.


   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,
   )

Methoden

begin_create_or_update

Erstellt oder aktualisiert eine Azure ML-Ressource asynchron.
create_or_update

Erstellt oder aktualisiert eine Azure ML-Ressource.
from_config

Gibt einen Client aus einem vorhandenen Azure Machine Learning-Arbeitsbereich mithilfe einer Dateikonfiguration zurück.

Diese Methode bietet eine einfache Möglichkeit, denselben Arbeitsbereich in mehreren Python-Notebooks oder -Projekten wiederzuverwenden. Sie können die Azure Resource Manager -Eigenschaften (ARM) eines Arbeitsbereichs in einer JSON-Konfigurationsdatei in folgendem Format speichern:


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

Anschließend können Sie diese Methode verwenden, um denselben Arbeitsbereich in verschiedene Python-Notebooks oder -Projekte zu laden, ohne die ARM-Eigenschaften des Arbeitsbereichs neu eingeben zu müssen.

begin_create_or_update

Erstellt oder aktualisiert eine Azure ML-Ressource asynchron.

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

Parameter

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

Die zu erstellende oder zu aktualisierende Ressource.

Gibt zurück

Die Ressource nach dem Erstellungs-/Aktualisierungsvorgang.

Rückgabetyp

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

create_or_update

Erstellt oder aktualisiert eine Azure ML-Ressource.

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

Parameter

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

Die zu erstellende oder zu aktualisierende Ressource.

Gibt zurück

Die erstellte oder aktualisierte Ressource.

Rückgabetyp

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

from_config

Gibt einen Client aus einem vorhandenen Azure Machine Learning-Arbeitsbereich mithilfe einer Dateikonfiguration zurück.

Diese Methode bietet eine einfache Möglichkeit, denselben Arbeitsbereich in mehreren Python-Notebooks oder -Projekten wiederzuverwenden. Sie können die Azure Resource Manager -Eigenschaften (ARM) eines Arbeitsbereichs in einer JSON-Konfigurationsdatei in folgendem Format speichern:


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

Anschließend können Sie diese Methode verwenden, um denselben Arbeitsbereich in verschiedene Python-Notebooks oder -Projekte zu laden, ohne die ARM-Eigenschaften des Arbeitsbereichs neu eingeben zu müssen.

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

Parameter

credential
TokenCredential
Erforderlich

Das Anmeldeinformationsobjekt für den Arbeitsbereich.

path
Optional[Union[PathLike, str]]

Der Pfad zur Konfigurationsdatei oder zum Startverzeichnis, in dem nach der Konfigurationsdatei gesucht werden soll. Der Standardwert ist "None", was angibt, dass das aktuelle Verzeichnis verwendet wird.

file_name
Optional[str]

Der Name der Konfigurationsdatei, nach der gesucht werden soll, wenn pfad ein Verzeichnispfad ist. Der Standardwert ist "config.json".

cloud
Optional[str]

Der zu verwendende Cloudname. Der Standardwert ist "AzureCloud".

Gibt zurück

Der Client für einen vorhandenen Azure ML-Arbeitsbereich.

Rückgabetyp

MLClient

Ausnahmen

ValidationException

Wird ausgelöst, wenn "config.json" oder file_name bei Überschreibung nicht im Verzeichnis gefunden werden kann. Details werden in der Fehlermeldung angegeben.

Beispiele

Erstellen eines MLClients aus einer Datei namens "config.json" im Verzeichnis "src".


   from azure.ai.ml import MLClient

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

Erstellen eines MLClients aus einer Datei namens "team_workspace_configuration.json" im aktuellen Verzeichnis.


   from azure.ai.ml import MLClient

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

Attribute

batch_deployments

Eine Sammlung von Batchbereitstellungsvorgängen.

Gibt zurück

Batchbereitstellungsvorgänge.

Rückgabetyp

BatchDeploymentOperations

batch_endpoints

Eine Sammlung von Vorgängen im Zusammenhang mit Batchendpunkten.

Gibt zurück

Batchendpunktvorgänge

Rückgabetyp

BatchEndpointOperations

components

Eine Auflistung von komponentenbezogenen Vorgängen.

Gibt zurück

Komponentenvorgänge.

Rückgabetyp

ComponentOperations

compute

Eine Sammlung von Computevorgängen.

Gibt zurück

Computevorgänge

Rückgabetyp

ComputeOperations

connections

Eine Sammlung von Arbeitsbereichsverbindungsvorgängen.

Gibt zurück

Vorgänge für Arbeitsbereichsverbindungen

Rückgabetyp

WorkspaceConnectionsOperations

data

Eine Sammlung von datenbezogenen Vorgängen.

Gibt zurück

Datenvorgänge.

Rückgabetyp

DataOperations

datastores

Eine Sammlung von Datenspeichervorgängen.

Gibt zurück

Datenspeichervorgänge.

Rückgabetyp

DatastoreOperations

environments

Eine Sammlung von umgebungsbezogenen Vorgängen.

Gibt zurück

Umgebungsvorgänge.

Rückgabetyp

EnvironmentOperations

feature_sets

aka.ms/azuremlexperimental weitere Informationen.

Eine Sammlung von Vorgängen im Zusammenhang mit Featuregruppen.

Gibt zurück

FeatureSet-Vorgänge

Rückgabetyp

FeatureSetOperations

feature_store_entities

aka.ms/azuremlexperimental weitere Informationen.

Eine Sammlung von Vorgängen im Zusammenhang mit Featurespeicherentität.

Gibt zurück

FeatureStoreEntity-Vorgänge

Rückgabetyp

FeatureStoreEntityOperations

feature_stores

aka.ms/azuremlexperimental weitere Informationen.

Eine Sammlung von Funktionsspeichervorgängen.

Gibt zurück

FeatureStore-Vorgänge

Rückgabetyp

FeatureStoreOperations

jobs

Eine Sammlung von auftragsbezogenen Vorgängen.

Gibt zurück

Auftragsvorgänge

Rückgabetyp

JobOperations

models

Eine Auflistung von modellbezogenen Vorgängen.

Gibt zurück

Modellvorgänge

Rückgabetyp

ModelOperations

online_deployments

Eine Sammlung von Onlinebereitstellungsvorgängen.

Gibt zurück

Onlinebereitstellungsvorgänge

Rückgabetyp

OnlineDeploymentOperations

online_endpoints

Eine Sammlung von Vorgängen im Zusammenhang mit Onlineendpunkten.

Gibt zurück

Onlineendpunktvorgänge

Rückgabetyp

OnlineEndpointOperations

registries

aka.ms/azuremlexperimental weitere Informationen.

Eine Sammlung von registrierungsbezogenen Vorgängen.

Gibt zurück

Registrierungsvorgänge

Rückgabetyp

RegistryOperations

resource_group_name

Rufen Sie den Ressourcengruppennamen eines MLClient-Objekts ab.

Gibt zurück

Ein Azure-Ressourcengruppenname.

Rückgabetyp

str

schedules

Eine Sammlung von zeitplanbezogenen Vorgängen.

Gibt zurück

Planen von Vorgängen.

Rückgabetyp

ScheduleOperations

subscription_id

Ruft die Abonnement-ID eines MLClient-Objekts ab.

Gibt zurück

Eine Azure-Abonnement-ID.

Rückgabetyp

str

workspace_hubs

aka.ms/azuremlexperimental weitere Informationen.

Eine Sammlung von Arbeitsbereichshub-bezogenen Vorgängen.

Gibt zurück

Hub-Vorgänge

Rückgabetyp

<xref:HubOperations>

workspace_name

Der Name des Arbeitsbereichs, in dem arbeitsbereichsabhängige Vorgänge ausgeführt werden.

Gibt zurück

Der Name des Standardarbeitsbereichs.

Rückgabetyp

Optional[str]

workspace_outbound_rules

Eine Sammlung von Vorgängen im Zusammenhang mit ausgehenden Regeln für den Arbeitsbereich.

Gibt zurück

Ausgehende Regelvorgänge des Arbeitsbereichs

Rückgabetyp

WorkspaceOutboundRuleOperations

workspaces

Eine Sammlung von arbeitsbereichsbezogenen Vorgängen.

Gibt zurück

Arbeitsbereichsvorgänge

Rückgabetyp

WorkspaceOperations

R 

R = ~R

T 

T = ~T