MLClient Klasa

Klasa klienta do interakcji z usługami Azure ML.

Ten klient służy do zarządzania zasobami usługi Azure ML, takimi jak obszary robocze, zadania, modele itd.

Dziedziczenie

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)

Parametry

credential

TokenCredential

Wymagane

Poświadczenie do użycia do uwierzytelniania.

subscription_id

Optional[str]

wartość domyślna: None

Identyfikator subskrypcji platformy Azure. Opcjonalnie tylko dla zasobów rejestru. Domyślnie wartość Brak.

resource_group_name

Optional[str]

wartość domyślna: None

Grupa zasobów platformy Azure. Opcjonalnie tylko dla zasobów rejestru. Domyślnie wartość Brak.

workspace_name

Optional[str]

wartość domyślna: None

Obszar roboczy do użycia w kliencie. Opcjonalnie tylko w przypadku operacji, które nie są zależne od obszaru roboczego. Domyślnie wartość Brak.

registry_name

Optional[str]

wartość domyślna: None

Rejestr do użycia w kliencie. Opcjonalnie tylko w przypadku operacji, które nie są zależne od obszaru roboczego. Domyślnie wartość Brak.

show_progress

Optional[bool]

Określa, czy mają być wyświetlane paski postępu dla długotrwałych operacji (np. klienci mogą rozważyć ustawienie wartości False, jeśli nie używa tego zestawu SDK w konfiguracji interakcyjnej). Wartość domyślna to True.

enable_telemetry

Optional[bool]

Określa, czy włączyć telemetrię. Zostanie zastąpiona wartością False, jeśli nie w Jupyter Notebook. Wartość domyślna to True, jeśli w Jupyter Notebook.

cloud

Optional[str]

Nazwa chmury do użycia. Wartość domyślna to "AzureCloud".

Przykłady

W przypadku korzystania z domen suwerennych (tj. dowolnej chmury innej niż AZURE_PUBLIC_CLOUD) należy przekazać nazwę chmury w kwargs i należy użyć urzędu z ustawieniem 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,
   )

Metody

begin_create_or_update	Tworzy lub aktualizuje asynchronicznie zasób usługi Azure ML.
create_or_update	Tworzy lub aktualizuje zasób usługi Azure ML.
from_config	Zwraca klienta z istniejącego obszaru roboczego usługi Azure Machine Learning przy użyciu konfiguracji pliku. Ta metoda zapewnia prosty sposób ponownego użycia tego samego obszaru roboczego w wielu notesach lub projektach języka Python. Właściwości usługi Azure Resource Manager (ARM) obszaru roboczego można zapisać w pliku konfiguracji JSON przy użyciu następującego formatu: { "subscription_id": "<subscription-id>", "resource_group": "<resource-group>", "workspace_name": "<workspace-name>" } Następnie możesz użyć tej metody, aby załadować ten sam obszar roboczy w różnych notesach lub projektach języka Python bez ponownego pisania właściwości usługi ARM obszaru roboczego.

begin_create_or_update

Tworzy lub aktualizuje asynchronicznie zasób usługi Azure ML.

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

Parametry

entity

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

Wymagane

Zasób do utworzenia lub zaktualizowania.

Zwraca

Zasób po operacji tworzenia/aktualizowania.

Typ zwracany

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

create_or_update

Tworzy lub aktualizuje zasób usługi Azure ML.

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

Parametry

entity

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

Wymagane

Zasób do utworzenia lub zaktualizowania.

Zwraca

Utworzony lub zaktualizowany zasób.

Typ zwracany

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

from_config

Zwraca klienta z istniejącego obszaru roboczego usługi Azure Machine Learning przy użyciu konfiguracji pliku.

Ta metoda zapewnia prosty sposób ponownego użycia tego samego obszaru roboczego w wielu notesach lub projektach języka Python. Właściwości usługi Azure Resource Manager (ARM) obszaru roboczego można zapisać w pliku konfiguracji JSON przy użyciu następującego formatu:

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

Następnie możesz użyć tej metody, aby załadować ten sam obszar roboczy w różnych notesach lub projektach języka Python bez ponownego pisania właściwości usługi ARM obszaru roboczego.

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

Parametry

credential

TokenCredential

Wymagane

Obiekt poświadczeń dla obszaru roboczego.

path

Optional[Union[PathLike, str]]

Ścieżka do pliku konfiguracji lub katalogu początkowego do wyszukania pliku konfiguracji. Domyślnie wartość Brak wskazująca, że zostanie użyty bieżący katalog.

file_name

Optional[str]

Nazwa pliku konfiguracji do wyszukania, gdy ścieżka jest ścieżką katalogu. Wartość domyślna to "config.json".

cloud

Optional[str]

Nazwa chmury do użycia. Wartość domyślna to "AzureCloud".

Zwraca

Klient istniejącego obszaru roboczego usługi Azure ML.

Typ zwracany

MLClient

Wyjątki

ValidationException

Podniesione, jeśli plik "config.json" lub file_name, jeśli zostanie zastąpiony, nie można odnaleźć w katalogu. Szczegóły zostaną podane w komunikacie o błędzie.

Przykłady

Tworzenie klasy MLClient z pliku o nazwie "config.json" w katalogu "src".

   from azure.ai.ml import MLClient

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

Tworzenie obiektu MLClient z pliku o nazwie "team_workspace_configuration.json" w bieżącym katalogu.

   from azure.ai.ml import MLClient

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

Atrybuty

batch_deployments

Kolekcja operacji związanych z wdrażaniem wsadowym.

Zwraca

Operacje wdrażania wsadowego.

Typ zwracany

BatchDeploymentOperations

batch_endpoints

Kolekcja operacji związanych z punktem końcowym wsadowym.

Zwraca

Operacje punktu końcowego usługi Batch

Typ zwracany

BatchEndpointOperations

components

Kolekcja operacji związanych z składnikami.

Zwraca

Operacje składników.

Typ zwracany

ComponentOperations

compute

Kolekcja operacji związanych z obliczeniami.

Zwraca

Operacje obliczeniowe

Typ zwracany

ComputeOperations

connections

Kolekcja operacji związanych z połączeniem obszaru roboczego.

Zwraca

Operacje połączeń obszaru roboczego

Typ zwracany

WorkspaceConnectionsOperations

data

Kolekcja operacji związanych z danymi.

Zwraca

Operacje na danych.

Typ zwracany

DataOperations

datastores

Kolekcja operacji związanych z magazynem danych.

Zwraca

Operacje magazynu danych.

Typ zwracany

DatastoreOperations

environments

Kolekcja operacji związanych ze środowiskiem.

Zwraca

Operacje środowiskowe.

Typ zwracany

EnvironmentOperations

feature_sets

aka.ms/azuremlexperimental, aby uzyskać więcej informacji.

Kolekcja operacji powiązanych z zestawem funkcji.

Zwraca

Operacje zestawu funkcji

Typ zwracany

FeatureSetOperations

feature_store_entities

aka.ms/azuremlexperimental, aby uzyskać więcej informacji.

Kolekcja operacji związanych z jednostką magazynu funkcji.

Zwraca

Operacje FeatureStoreEntity

Typ zwracany

FeatureStoreEntityOperations

feature_stores

aka.ms/azuremlexperimental, aby uzyskać więcej informacji.

Kolekcja operacji związanych z magazynem funkcji.

Zwraca

Operacje magazynu funkcji

Typ zwracany

FeatureStoreOperations

jobs

Kolekcja operacji związanych z zadaniami.

Zwraca

Operacje zadań

Typ zwracany

JobOperations

models

Kolekcja operacji związanych z modelem.

Zwraca

Operacje modelu

Typ zwracany

ModelOperations

online_deployments

Kolekcja operacji związanych z wdrażaniem online.

Zwraca

Operacje wdrażania online

Typ zwracany

OnlineDeploymentOperations

online_endpoints

Kolekcja operacji związanych z punktem końcowym online.

Zwraca

Operacje punktu końcowego online

Typ zwracany

OnlineEndpointOperations

registries

aka.ms/azuremlexperimental, aby uzyskać więcej informacji.

Kolekcja operacji związanych z rejestrem.

Zwraca

Operacje rejestru

Typ zwracany

RegistryOperations

resource_group_name

Pobierz nazwę grupy zasobów obiektu MLClient.

Zwraca

Nazwa grupy zasobów platformy Azure.

Typ zwracany

str

schedules

Kolekcja operacji związanych z harmonogramem.

Zwraca

Planowanie operacji.

Typ zwracany

ScheduleOperations

subscription_id

Pobierz identyfikator subskrypcji obiektu MLClient.

Zwraca

Identyfikator subskrypcji platformy Azure.

Typ zwracany

str

workspace_hubs

aka.ms/azuremlexperimental, aby uzyskać więcej informacji.

Kolekcja operacji związanych z centrum obszaru roboczego.

Zwraca

Operacje koncentratora

Typ zwracany

<xref:HubOperations>

workspace_name

Nazwa obszaru roboczego, w którym zostaną wykonane operacje zależne od obszaru roboczego.

Zwraca

Nazwa domyślnego obszaru roboczego.

Typ zwracany

Optional[str]

workspace_outbound_rules

Kolekcja operacji związanych z regułą ruchu wychodzącego obszaru roboczego.

Zwraca

Operacje reguły ruchu wychodzącego obszaru roboczego

Typ zwracany

WorkspaceOutboundRuleOperations

workspaces

Kolekcja operacji związanych z obszarem roboczym.

Zwraca

Operacje obszaru roboczego

Typ zwracany

WorkspaceOperations

R

R = ~R

T

T = ~T