MLClient Klas

Een clientklasse voor interactie met Azure ML-services.

Gebruik deze client voor het beheren van Azure ML-resources, zoals werkruimten, taken, modellen, enzovoort.

Overname
builtins.object
MLClient

Constructor

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)

Parameters

credential
TokenCredential
Vereist

De referentie die moet worden gebruikt voor verificatie.

subscription_id
Optional[str]
standaardwaarde: None

De Azure-abonnements-id. Alleen optioneel voor registerassets. De standaardwaarde is Geen.

resource_group_name
Optional[str]
standaardwaarde: None

De Azure-resourcegroep. Alleen optioneel voor registerassets. De standaardwaarde is Geen.

workspace_name
Optional[str]
standaardwaarde: None

De werkruimte die in de client moet worden gebruikt. Alleen optioneel voor bewerkingen die niet afhankelijk zijn van de werkruimte. De standaardwaarde is Geen.

registry_name
Optional[str]
standaardwaarde: None

Het register dat in de client moet worden gebruikt. Alleen optioneel voor bewerkingen die niet afhankelijk zijn van de werkruimte. De standaardwaarde is Geen.

show_progress
Optional[bool]

Hiermee geeft u op of voortgangsbalken moeten worden weergegeven voor langlopende bewerkingen (klanten kunnen bijvoorbeeld overwegen dit in te stellen op Onwaar als ze deze SDK niet gebruiken in een interactieve installatie). De standaardwaarde is Waar.

enable_telemetry
Optional[bool]

Hiermee geeft u op of telemetrie moet worden ingeschakeld. Wordt overschreven naar Onwaar als dit niet in een Jupyter Notebook. De standaardwaarde is Waar als deze zich in een Jupyter Notebook.

cloud
Optional[str]

De cloudnaam die moet worden gebruikt. Standaard ingesteld op 'AzureCloud'.

Voorbeelden

Wanneer u soevereine domeinen gebruikt (bijvoorbeeld een andere cloud dan AZURE_PUBLIC_CLOUD), moet u de naam van de cloud doorgeven in kwargs en moet u een instantie gebruiken met 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,
   )

Methoden

begin_create_or_update

Een Azure ML-resource asynchroon maken of bijwerken.

create_or_update

Hiermee maakt u een Azure ML-resource of werkt u deze bij.

from_config

Retourneert een client uit een bestaande Azure Machine Learning-werkruimte met behulp van een bestandsconfiguratie.

Deze methode biedt een eenvoudige manier om dezelfde werkruimte opnieuw te gebruiken in meerdere Python-notebooks of -projecten. U kunt de Eigenschappen van Azure Resource Manager (ARM) van een werkruimte opslaan in een JSON-configuratiebestand met deze indeling:


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

Vervolgens kunt u deze methode gebruiken om dezelfde werkruimte in verschillende Python-notebooks of -projecten te laden zonder de ARM-eigenschappen van de werkruimte opnieuw te typen.

begin_create_or_update

Een Azure ML-resource asynchroon maken of bijwerken.

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

Parameters

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

De resource die moet worden gemaakt of bijgewerkt.

Retouren

De resource na het maken/bijwerken.

Retourtype

create_or_update

Hiermee maakt u een Azure ML-resource of werkt u deze bij.

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

Parameters

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

De resource die moet worden gemaakt of bijgewerkt.

Retouren

De gemaakte of bijgewerkte resource.

Retourtype

from_config

Retourneert een client uit een bestaande Azure Machine Learning-werkruimte met behulp van een bestandsconfiguratie.

Deze methode biedt een eenvoudige manier om dezelfde werkruimte opnieuw te gebruiken in meerdere Python-notebooks of -projecten. U kunt de Eigenschappen van Azure Resource Manager (ARM) van een werkruimte opslaan in een JSON-configuratiebestand met deze indeling:


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

Vervolgens kunt u deze methode gebruiken om dezelfde werkruimte in verschillende Python-notebooks of -projecten te laden zonder de ARM-eigenschappen van de werkruimte opnieuw te typen.

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

Parameters

credential
TokenCredential
Vereist

Het referentieobject voor de werkruimte.

path
Optional[Union[PathLike, str]]

Het pad naar het configuratiebestand of de beginmap om het configuratiebestand in te zoeken. De standaardwaarde is Geen, waarmee wordt aangegeven dat de huidige map wordt gebruikt.

file_name
Optional[str]

De naam van het configuratiebestand waarop moet worden gezocht wanneer pad een mappad is. De standaardinstelling is 'config.json'.

cloud
Optional[str]

De cloudnaam die moet worden gebruikt. Standaard ingesteld op 'AzureCloud'.

Retouren

De client voor een bestaande Azure ML-werkruimte.

Retourtype

Uitzonderingen

Gegenereerd als 'config.json' of file_name indien overschreven, kan niet worden gevonden in de map. Details worden opgegeven in het foutbericht.

Voorbeelden

Een MLClient maken op basis van een bestand met de naam 'config.json' in de map 'src'.


   from azure.ai.ml import MLClient

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

Een MLClient maken op basis van een bestand met de naam 'team_workspace_configuration.json' in de huidige map.


   from azure.ai.ml import MLClient

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

Kenmerken

batch_deployments

Een verzameling batchimplementatiebewerkingen.

Retouren

Batchimplementatiebewerkingen.

Retourtype

batch_endpoints

Een verzameling batch-eindpuntgerelateerde bewerkingen.

Retouren

Batch-eindpuntbewerkingen

Retourtype

components

Een verzameling van onderdeelgerelateerde bewerkingen.

Retouren

Onderdeelbewerkingen.

Retourtype

compute

Een verzameling rekenbewerkingen.

Retouren

Rekenbewerkingen

Retourtype

connections

Een verzameling bewerkingen die betrekking hebben op werkruimteverbindingen.

Retouren

Bewerkingen voor werkruimteverbindingen

Retourtype

data

Een verzameling gegevensgerelateerde bewerkingen.

Retouren

Gegevensbewerkingen.

Retourtype

datastores

Een verzameling bewerkingen die betrekking hebben op het gegevensarchief.

Retouren

Gegevensopslagbewerkingen.

Retourtype

environments

Een verzameling omgevingsgerelateerde bewerkingen.

Retouren

Omgevingsbewerkingen.

Retourtype

feature_sets

aka.ms/azuremlexperimental voor meer informatie.

Een verzameling aan functieset gerelateerde bewerkingen.

Retouren

FeatureSet-bewerkingen

Retourtype

feature_store_entities

aka.ms/azuremlexperimental voor meer informatie.

Een verzameling met entiteitsgerelateerde bewerkingen voor functieopslag.

Retouren

FeatureStoreEntity-bewerkingen

Retourtype

feature_stores

aka.ms/azuremlexperimental voor meer informatie.

Een verzameling bewerkingen die betrekking hebben op het functiearchief.

Retouren

FeatureStore-bewerkingen

Retourtype

jobs

Een verzameling taakgerelateerde bewerkingen.

Retouren

Taakbewerkingen

Retourtype

models

Een verzameling modelgerelateerde bewerkingen.

Retouren

Modelbewerkingen

Retourtype

online_deployments

Een verzameling online implementatiebewerkingen.

Retouren

Online implementatiebewerkingen

Retourtype

online_endpoints

Een verzameling online eindpuntgerelateerde bewerkingen.

Retouren

Online-eindpuntbewerkingen

Retourtype

registries

aka.ms/azuremlexperimental voor meer informatie.

Een verzameling registergerelateerde bewerkingen.

Retouren

Registerbewerkingen

Retourtype

resource_group_name

Haal de naam van de resourcegroep van een MLClient-object op.

Retouren

De naam van een Azure-resourcegroep.

Retourtype

str

schedules

Een verzameling planningsgerelateerde bewerkingen.

Retouren

Planningsbewerkingen.

Retourtype

subscription_id

Haal de abonnements-id van een MLClient-object op.

Retouren

Een Azure-abonnements-id.

Retourtype

str

workspace_hubs

aka.ms/azuremlexperimental voor meer informatie.

Een verzameling hub-gerelateerde bewerkingen voor werkruimten.

Retouren

Hubbewerkingen

Retourtype

<xref:HubOperations>

workspace_name

De naam van de werkruimte waarin werkruimteafhankelijke bewerkingen worden uitgevoerd.

Retouren

De naam van de standaardwerkruimte.

Retourtype

workspace_outbound_rules

Een verzameling uitgaande regelbewerkingen voor werkruimten.

Retouren

Uitgaande regelbewerkingen voor werkruimten

Retourtype

workspaces

Een verzameling werkruimtegerelateerde bewerkingen.

Retouren

Werkruimtebewerkingen

Retourtype

R

R = ~R

T

T = ~T