MLClient Klass

Referens

En klientklass för att interagera med Azure ML-tjänster.

Använd den här klienten för att hantera Azure ML-resurser som arbetsytor, jobb, modeller och så vidare.

Arv: 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)

Parametrar

credential: TokenCredential

Obligatorisk

Den autentiseringsuppgift som ska användas för autentisering.

subscription_id: Optional[str]

standardvärde: None

Prenumerations-ID:t för Azure. Valfritt endast för registertillgångar. Standardvärdet är Ingen.

resource_group_name: Optional[str]

standardvärde: None

Azure-resursgruppen. Valfritt endast för registertillgångar. Standardvärdet är Ingen.

workspace_name: Optional[str]

standardvärde: None

Arbetsytan som ska användas i klienten. Endast valfritt för åtgärder som inte är arbetsyteberoende. Standardvärdet är Ingen.

registry_name: Optional[str]

standardvärde: None

Registret som ska användas i klienten. Endast valfritt för åtgärder som inte är arbetsyteberoende. Standardvärdet är Ingen.

show_progress: Optional[bool]

Anger om förloppsindikatorer ska visas eller inte för långvariga åtgärder (t.ex. kunder kan överväga att ställa in detta på Falskt om de inte använder denna SDK i en interaktiv installation). Standardvärdet är True.

enable_telemetry: Optional[bool]

Anger om telemetri ska aktiveras eller inte. Kommer att åsidosättas till False om det inte finns i en Jupyter Notebook. Standardvärdet är True om det finns i en Jupyter Notebook.

cloud: Optional[str]

Det molnnamn som ska användas. Standardvärdet är "AzureCloud".

Exempel

När du använder nationella domäner (dvs. andra moln än AZURE_PUBLIC_CLOUD) måste du skicka in molnnamnet i kwargs och du måste använda en utfärdare med 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,
   )

Metoder

begin_create_or_update

Skapar eller uppdaterar en Azure ML-resurs asynkront.

create_or_update

Skapar eller uppdaterar en Azure ML-resurs.

from_config

Returnerar en klient från en befintlig Azure Machine Learning-arbetsyta med hjälp av en filkonfiguration.

Den här metoden är ett enkelt sätt att återanvända samma arbetsyta i flera Python-notebook-filer eller -projekt. Du kan spara en arbetsytas Azure Resource Manager-egenskaper (ARM) i en JSON-konfigurationsfil med följande format:


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

Sedan kan du använda den här metoden för att läsa in samma arbetsyta i olika Python-notebook-filer eller -projekt utan att skriva om ARM-egenskaperna för arbetsytan.

begin_create_or_update

Skapar eller uppdaterar en Azure ML-resurs asynkront.

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

Parametrar

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

Obligatorisk

Resursen som ska skapas eller uppdateras.

Returer

Resursen efter åtgärden skapa/uppdatera.

Returtyp

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

create_or_update

Skapar eller uppdaterar en Azure ML-resurs.

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

Parametrar

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

Obligatorisk

Resursen som ska skapas eller uppdateras.

Returer

Den skapade eller uppdaterade resursen.

Returtyp

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

from_config

Returnerar en klient från en befintlig Azure Machine Learning-arbetsyta med hjälp av en filkonfiguration.


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

Sedan kan du använda den här metoden för att läsa in samma arbetsyta i olika Python-notebook-filer eller -projekt utan att skriva om ARM-egenskaperna för arbetsytan.

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

Parametrar

credential: TokenCredential

Obligatorisk

Autentiseringsobjektet för arbetsytan.

path: Optional[Union[PathLike, str]]

Sökvägen till konfigurationsfilen eller startkatalogen för att söka efter konfigurationsfilen i. Standardvärdet är Ingen, vilket anger att den aktuella katalogen kommer att användas.

file_name: Optional[str]

Namnet på konfigurationsfilen som ska sökas efter när sökvägen är en katalogsökväg. Standardvärdet är "config.json".

cloud: Optional[str]

Det molnnamn som ska användas. Standardvärdet är "AzureCloud".

Returer

Klienten för en befintlig Azure ML-arbetsyta.

Returtyp

MLClient

Undantag

ValidationException

Upphöjt om "config.json" eller file_name om den åsidosatts inte kan hittas i katalogen. Information kommer att anges i felmeddelandet.

Exempel

Skapa en MLClient från en fil med namnet "config.json" i katalogen "src".


   from azure.ai.ml import MLClient

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

Skapa en MLClient från en fil med namnet "team_workspace_configuration.json" i den aktuella katalogen.


   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 för mer information.

En samling relaterade åtgärder för funktionsuppsättningar.

Returer

FunktionerUppsättningsåtgärder

Returtyp

FeatureSetOperations

feature_store_entities

aka.ms/azuremlexperimental för mer information.

En samling entitetsrelaterade åtgärder för funktionsarkivet.

Returer

FeatureStoreEntity-åtgärder

Returtyp

FeatureStoreEntityOperations

feature_stores

registries

workspace_hubs

R

R = ~R

T

T = ~T