Sdílet prostřednictvím


MLClient Třída

Klientská třída pro interakci se službami Azure ML.

Pomocí tohoto klienta můžete spravovat prostředky Azure ML, jako jsou pracovní prostory, úlohy, modely atd.

Dědičnost
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
Vyžadováno

Přihlašovací údaje, které se mají použít pro ověřování.

subscription_id
Optional[str]
výchozí hodnota: None

ID předplatného Azure. Volitelné pouze pro prostředky registru. Výchozí hodnota je Žádná.

resource_group_name
Optional[str]
výchozí hodnota: None

Skupina prostředků Azure. Volitelné pouze pro prostředky registru. Výchozí hodnota je Žádná.

workspace_name
Optional[str]
výchozí hodnota: None

Pracovní prostor, který se má použít v klientovi. Volitelné pouze pro operace, které nejsou závislé na pracovním prostoru. Výchozí hodnota je Žádná.

registry_name
Optional[str]
výchozí hodnota: None

Registr, který se má použít v klientovi. Volitelné pouze pro operace, které nejsou závislé na pracovním prostoru. Výchozí hodnota je Žádná.

show_progress
Optional[bool]

Určuje, jestli se mají zobrazit indikátory průběhu pro dlouhotrvající operace (například zákazníci můžou zvážit nastavení na Hodnotu False, pokud tuto sadu SDK nepoužívají v interaktivním nastavení). Výchozí hodnota je Pravda.

enable_telemetry
Optional[bool]

Určuje, jestli se má povolit telemetrie. Pokud ne v Jupyter Notebook, přepíše se na False. Výchozí hodnota je True, pokud je v Jupyter Notebook.

cloud
Optional[str]

Název cloudu, který se má použít. Výchozí hodnota je AzureCloud.

Příklady

Při použití suverénních domén (tj. jakéhokoli jiného cloudu než AZURE_PUBLIC_CLOUD) musíte předat název cloudu v kwargs a musíte použít autoritu s 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

Vytvoří nebo aktualizuje prostředek Azure ML asynchronně.

create_or_update

Vytvoří nebo aktualizuje prostředek Azure ML.

from_config

Vrátí klienta z existujícího pracovního prostoru služby Azure Machine Learning pomocí konfigurace souboru.

Tato metoda poskytuje jednoduchý způsob opakovaného použití stejného pracovního prostoru v několika poznámkových blocích nebo projektech Pythonu. Vlastnosti Azure Resource Manager (ARM) pracovního prostoru můžete uložit do konfiguračního souboru JSON pomocí tohoto formátu:


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

Tuto metodu pak můžete použít k načtení stejného pracovního prostoru v různých poznámkových blocích Nebo projektech Pythonu bez přepsání vlastností ARM pracovního prostoru.

begin_create_or_update

Vytvoří nebo aktualizuje prostředek Azure ML asynchronně.

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

Parametry

entity
Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]
Vyžadováno

Prostředek, který chcete vytvořit nebo aktualizovat.

Návraty

Prostředek po operaci vytvoření/aktualizace.

Návratový typ

create_or_update

Vytvoří nebo aktualizuje prostředek Azure ML.

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

Parametry

entity
Union[Job , Model, Environment, Component , Datastore]
Vyžadováno

Prostředek, který chcete vytvořit nebo aktualizovat.

Návraty

Vytvořený nebo aktualizovaný prostředek.

Návratový typ

from_config

Vrátí klienta z existujícího pracovního prostoru služby Azure Machine Learning pomocí konfigurace souboru.

Tato metoda poskytuje jednoduchý způsob opakovaného použití stejného pracovního prostoru v několika poznámkových blocích nebo projektech Pythonu. Vlastnosti Azure Resource Manager (ARM) pracovního prostoru můžete uložit do konfiguračního souboru JSON pomocí tohoto formátu:


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

Tuto metodu pak můžete použít k načtení stejného pracovního prostoru v různých poznámkových blocích Nebo projektech Pythonu bez přepsání vlastností ARM pracovního prostoru.

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

Parametry

credential
TokenCredential
Vyžadováno

Objekt přihlašovacích údajů pro pracovní prostor.

path
Optional[Union[PathLike, str]]

Cesta ke konfiguračnímu souboru nebo počátečnímu adresáři, ve které chcete konfigurační soubor vyhledat. Výchozí hodnota je Žádná, což znamená, že se použije aktuální adresář.

file_name
Optional[str]

Název konfiguračního souboru, který se má vyhledat, když je cesta k adresáři. Výchozí hodnota je config.json.

cloud
Optional[str]

Název cloudu, který se má použít. Výchozí hodnota je AzureCloud.

Návraty

Klient existujícího pracovního prostoru Azure ML.

Návratový typ

Výjimky

Vyvolána, pokud soubor config.json nebo file_name, pokud je přepsán, nelze v adresáři najít. Podrobnosti budou uvedeny v chybové zprávě.

Příklady

Vytvoření MLClient ze souboru s názvem "config.json" v adresáři "src".


   from azure.ai.ml import MLClient

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

Vytvoření MLClient ze souboru s názvem "team_workspace_configuration.json" v aktuálním adresáři


   from azure.ai.ml import MLClient

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

Atributy

batch_deployments

Kolekce operací souvisejících s nasazením dávky.

Návraty

Operace nasazení služby Batch.

Návratový typ

batch_endpoints

Kolekce operací souvisejících s koncovým bodem dávky.

Návraty

Operace s koncovým bodem služby Batch

Návratový typ

components

Kolekce operací souvisejících se komponentou.

Návraty

Operace komponent.

Návratový typ

compute

Kolekce operací souvisejících s výpočetními prostředky.

Návraty

Výpočetní operace

Návratový typ

connections

Kolekce operací souvisejících s připojením k pracovnímu prostoru.

Návraty

Operace připojení pracovního prostoru

Návratový typ

data

Kolekce operací souvisejících s daty.

Návraty

Operace s daty.

Návratový typ

datastores

Kolekce operací souvisejících s úložištěm dat.

Návraty

Operace úložiště dat.

Návratový typ

environments

Kolekce operací souvisejících s prostředím.

Návraty

Operace prostředí.

Návratový typ

feature_sets

další informace aka.ms/azuremlexperimental.

Kolekce operací souvisejících se sadou funkcí.

Návraty

Operace FeatureSet

Návratový typ

feature_store_entities

další informace aka.ms/azuremlexperimental.

Kolekce operací souvisejících s entitou úložiště funkcí

Návraty

Operace FeatureStoreEntity

Návratový typ

feature_stores

další informace aka.ms/azuremlexperimental.

Kolekce operací souvisejících s úložištěm funkcí.

Návraty

Operace FeatureStore

Návratový typ

jobs

Kolekce operací souvisejících s úlohami.

Návraty

Operace úloh

Návratový typ

models

Kolekce operací souvisejících s modelem.

Návraty

Operace modelu

Návratový typ

online_deployments

Kolekce operací souvisejících s online nasazením.

Návraty

Operace online nasazení

Návratový typ

online_endpoints

Kolekce operací souvisejících s online koncovým bodem.

Návraty

Operace s online koncovým bodem

Návratový typ

registries

další informace aka.ms/azuremlexperimental.

Kolekce operací souvisejících s registrem.

Návraty

Operace registru

Návratový typ

resource_group_name

Získejte název skupiny prostředků objektu MLClient.

Návraty

Název skupiny prostředků Azure.

Návratový typ

str

schedules

Kolekce operací souvisejících s plánem.

Návraty

Plánování operací.

Návratový typ

subscription_id

Získejte ID předplatného objektu MLClient.

Návraty

ID předplatného Azure.

Návratový typ

str

workspace_hubs

další informace aka.ms/azuremlexperimental.

Kolekce operací souvisejících s centrem pracovního prostoru.

Návraty

Operace centra

Návratový typ

<xref:HubOperations>

workspace_name

Název pracovního prostoru, ve kterém se budou provádět operace závislé na pracovním prostoru.

Návraty

Název výchozího pracovního prostoru.

Návratový typ

workspace_outbound_rules

Kolekce operací souvisejících s pravidly odchozích přenosů pracovního prostoru.

Návraty

Operace odchozích pravidel pracovního prostoru

Návratový typ

workspaces

Kolekce operací souvisejících s pracovním prostorem.

Návraty

Operace pracovního prostoru

Návratový typ

R

R = ~R

T

T = ~T