Workspace Klasse
Definiert eine Azure Machine Learning-Ressource zum Verwalten von Trainings- und Bereitstellungsartefakten.
Ein Arbeitsbereich ist eine grundlegende Ressource für das maschinelle Lernen in Azure Machine Learning. Sie verwenden einen Arbeitsbereich zum Experimentieren, Trainieren und Bereitstellen von Machine Learning-Modellen. Jeder Arbeitsbereich ist an ein Azure-Abonnement und eine Ressourcengruppe gebunden und verfügt über eine zugeordnete SKU.
Weitere Informationen zu Arbeitsbereichen finden Sie hier:
Klassenarbeitsbereichskonstruktor zum Laden eines vorhandenen Azure Machine Learning-Arbeitsbereichs.
- Vererbung
-
builtins.objectWorkspace
Konstruktor
Workspace(subscription_id, resource_group, workspace_name, auth=None, _location=None, _disable_service_check=False, _workspace_id=None, sku='basic', tags=None, _cloud='AzureCloud')Parameter
Das Authentication-Objekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Bei None werden die Standardanmeldeinformationen für Azure CLI verwendet oder die API fragt nach Anmeldeinformationen.
- sku
- str
Der Parameter ist aus Gründen der Abwärtskompatibilität vorhanden und wird ignoriert.
- workspace_name
- str
Der Arbeitsbereichsname. Der Name muss zwischen 2 und 32 Zeichen lang sein. Das erste Zeichen des Namens muss alphanumerisch sein (Buchstabe oder Zahl), der Rest des Namens kann jedoch alphanumerische Zeichen, Bindestriche und Unterstriche enthalten. Leerzeichen sind nicht zulässig.
Das Authentication-Objekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Bei None werden die Standardanmeldeinformationen für Azure CLI verwendet oder die API fragt nach Anmeldeinformationen.
- sku
- str
Der Parameter ist aus Gründen der Abwärtskompatibilität vorhanden und wird ignoriert.
Hinweise
Das folgende Beispiel zeigt, wie Sie einen Arbeitsbereich erstellen.
from azureml.core import Workspace
ws = Workspace.create(name='myworkspace',
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup',
create_resource_group=True,
location='eastus2'
)
Legen Sie create_resource_group auf „False“ fest, wenn Sie über eine vorhandene Azure-Ressourcengruppe verfügen, die Sie für den Arbeitsbereich verwenden möchten.
Wenn Sie den gleichen Arbeitsbereich in mehreren Umgebungen verwenden möchten, erstellen Sie eine JSON-Konfigurationsdatei. In der Konfigurationsdatei werden Ihr Abonnement, die Ressource und der Arbeitsbereichsname gespeichert, sodass der Arbeitsbereich ganz einfach geladen werden kann. Verwenden Sie zum Speichern der Konfiguration die write_config-Methode.
ws.write_config(path="./file-path", file_name="ws_config.json")
Ein Beispiel für die Konfigurationsdatei finden Sie unter Erstellen einer Konfigurationsdatei für den Arbeitsbereich.
Verwenden Sie die from_config-Methode, um den Arbeitsbereich aus der Konfigurationsdatei zu laden.
ws = Workspace.from_config()
ws.get_details()
Alternativ können Sie mit der get-Methode einen vorhandenen Arbeitsbereich laden, ohne Konfigurationsdateien zu verwenden.
ws = Workspace.get(name="myworkspace",
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup')
Bei den obigen Beispielen werden Sie möglicherweise in einem interaktiven Anmeldedialogfeld zur Eingabe von Anmeldeinformationen für die Azure-Authentifizierung aufgefordert. Weitere Anwendungsfälle, einschließlich Authentifizierung mithilfe der Azure CLI und Authentifizierung in automatisierten Workflows, finden Sie unter Authentifizierung in Azure Machine Learning.
Methoden
| add_private_endpoint |
Hinzufügen eines privaten Endpunkts zum Arbeitsbereich. |
| create |
Erstellen Sie einen neuen Azure Machine Learning-Arbeitsbereich. Löst eine Ausnahme aus, wenn der Arbeitsbereich bereits vorhanden oder eine der Arbeitsbereichsanforderungen nicht erfüllt ist. |
| delete |
Löschen Sie den Azure Machine Learning-Arbeitsbereich und die zugeordneten Ressourcen. |
| delete_connection |
Löschen Sie eine Verbindung des Arbeitsbereichs. |
| delete_private_endpoint_connection |
Löschen der Verbindung mit privatem Endpunkt für den Arbeitsbereich. |
| diagnose_workspace |
Diagnostizieren von Problemen beim Einrichten des Arbeitsbereichs. |
| from_config |
Geben Sie ein Arbeitsbereichsobjekts aus einem vorhandenen Azure Machine Learning-Arbeitsbereich zurück. Liest die Arbeitsbereichskonfiguration aus einer Datei. Löst eine Ausnahme aus, wenn die Konfigurationsdatei nicht gefunden wird. Diese Methode ermöglicht die einfache Wiederverwendung des gleichen Arbeitsbereichs in mehreren Python-Notebooks oder -Projekten. Benutzer können die Azure Resource Manager (ARM)-Eigenschaften des Arbeitsbereichs mithilfe der write_config-Methode speichern und den gleichen Arbeitsbereich mit dieser Methode in verschiedene Python-Notebooks oder -Projekte laden, ohne die ARM-Eigenschaften des Arbeitsbereichs erneut eingeben zu müssen. |
| get |
Geben Sie ein Arbeitsbereichsobjekt für einen vorhandenen Azure Machine Learning-Arbeitsbereich zurück. Löst eine Ausnahme aus, wenn der Arbeitsbereich nicht vorhanden ist oder die Pflichtfelder keinen Arbeitsbereich eindeutig identifizieren. |
| get_connection |
Abrufen einer Verbindung des Arbeitsbereichs. |
| get_default_compute_target |
Rufen Sie das Standardcomputeziel für den Arbeitsbereich ab. |
| get_default_datastore |
Abrufen des Standarddatenspeichers für den Arbeitsbereich. |
| get_default_keyvault |
Abrufen des Standardschlüsseltresor-Objekts für den Arbeitsbereich. |
| get_details |
Geben Sie die Details des Arbeitsbereichs zurück. |
| get_mlflow_tracking_uri |
Rufen Sie den MLflow-Nachverfolgungs-URI für den Arbeitsbereich ab. MLflow (https://mlflow.org/) ist eine Open-Source-Plattform zum Nachverfolgen von Machine Learning-Experimenten und Verwalten von Modellen. Sie können MLflow-Protokollierungs-APIs mit Azure Machine Learning verwenden, damit Metriken, Modelle und Artefakte in Ihrem Azure Machine Learning-Arbeitsbereich protokolliert werden. |
| get_run |
Geben Sie die Ausführung mit der angegebenen „run_id“ im Arbeitsbereich zurück. |
| list |
Listen Sie alle Arbeitsbereiche auf, zu denen der Benutzer innerhalb des Abonnements Zugriff hat. Die Liste der Arbeitsbereiche kann nach der Ressourcengruppe gefiltert werden. |
| list_connections |
Listen Sie die Verbindungen in diesem Arbeitsbereich auf. |
| list_keys |
Listen Sie die Schlüssel für den aktuellen Arbeitsbereich auf. |
| set_connection |
Fügen Sie eine Verbindung im Arbeitsbereich hinzu oder aktualisieren Sie diese. |
| set_default_datastore |
Legen Sie den Standarddatenspeicher für den Arbeitsbereich fest. |
| setup |
Erstellen eines neuen Arbeitsbereichs oder Abrufen eines vorhandenen Arbeitsbereichs. |
| sync_keys |
Löst eine sofortige Schlüsselsynchronisierung im Arbeitsbereich aus. Wenn Schlüssel für Ressourcen im Arbeitsbereich geändert werden, kann es etwa eine Stunde dauern, bis diese automatisch aktualisiert werden. Mit dieser Funktion können Schlüssel auf Anforderung aktualisiert werden. Sie kann z. B. verwendet werden, wenn nach dem erneuten Generieren von Speicherschlüsseln der sofortige Zugriff auf den Speicher erforderlich ist. |
| update |
Aktualisieren von Anzeigename, Beschreibung, Tags, Computename für die Imageerstellung und anderen Einstellungen eines Arbeitsbereichs. |
| update_dependencies |
Aktualisieren der vorhandenen zugeordneten Ressourcen für den Arbeitsbereich. Diese Methode kann in folgenden Fällen verwendet werden. a) Wenn ein Benutzer versehentlich eine vorhandene zugeordnete Ressource löscht und diese mit einer neuen Ressource aktualisieren möchte, ohne den gesamten Arbeitsbereich neu erstellen zu müssen. b) Wenn ein Benutzer über eine vorhandene zugeordnete Ressource verfügt und die Ressource ersetzen möchte, die dem Arbeitsbereich aktuell zugeordnet ist. c) Wenn noch keine zugeordnete Ressource erstellt wurde und eine bereits vorhandene Ressource verwendet werden soll (gilt nur für die Containerregistrierung). |
| write_config |
Schreiben Sie die Azure Resource Manager (ARM)-Eigenschaften des Arbeitsbereichs in eine Konfigurationsdatei. Die ARM-Eigenschaften des Arbeitsbereichs können später mit der from_config-Methode geladen werden. Der Standardwert von Diese Methode ermöglicht die einfache Wiederverwendung des gleichen Arbeitsbereichs in mehreren Python-Notebooks oder -Projekten. Benutzer können die ARM-Eigenschaften des Arbeitsbereichs mithilfe dieser Funktion speichern und den gleichen Arbeitsbereich mit from_config in verschiedene Python-Notebooks oder -Projekte laden, ohne die ARM-Eigenschaften des Arbeitsbereichs erneut eingeben zu müssen. |
add_private_endpoint
Hinzufügen eines privaten Endpunkts zum Arbeitsbereich.
add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)Parameter
- private_endpoint_config
- PrivateEndPointConfig
Die Konfiguration des privaten Endpunkts zum Erstellen eines privaten Endpunkts für den Arbeitsbereich.
- private_endpoint_auto_approval
- bool
Ein boolesches Flag, das angibt, ob die Erstellung des privaten Endpunkts automatisch oder manuell über das Azure Private Link Center genehmigt werden soll. Im Fall einer manuellen Genehmigung können Benutzer die ausstehende Anforderung im Private Link-Portal anzeigen, um sie zu genehmigen/abzulehnen.
- location
- string
Der Speicherort des privaten Endpunkts. Der Standardwert ist der Speicherort des Arbeitsbereichs
- show_output
- bool
Ein Flag zum Anzeigen des Fortschritts der Arbeitsbereichserstellung
Gibt zurück
Das erstellte PrivateEndPoint-Objekt.
Rückgabetyp
create
Erstellen Sie einen neuen Azure Machine Learning-Arbeitsbereich.
Löst eine Ausnahme aus, wenn der Arbeitsbereich bereits vorhanden oder eine der Arbeitsbereichsanforderungen nicht erfüllt ist.
static create(name, auth=None, subscription_id=None, resource_group=None, location=None, create_resource_group=True, sku='basic', tags=None, friendly_name=None, storage_account=None, key_vault=None, app_insights=None, container_registry=None, adb_workspace=None, primary_user_assigned_identity=None, cmk_keyvault=None, resource_cmk_uri=None, hbi_workspace=False, default_cpu_compute_target=None, default_gpu_compute_target=None, private_endpoint_config=None, private_endpoint_auto_approval=True, exist_ok=False, show_output=True, user_assigned_identity_for_cmk_encryption=None, system_datastores_auth_mode='accessKey', v1_legacy_mode=None)Parameter
- name
- str
Der Name des neuen Arbeitsbereichs. Der Name muss zwischen 2 und 32 Zeichen lang sein. Das erste Zeichen des Namens muss alphanumerisch sein (Buchstabe oder Zahl), der Rest des Namens kann jedoch alphanumerische Zeichen, Bindestriche und Unterstriche enthalten. Leerzeichen sind nicht zulässig.
Das Authentication-Objekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Bei None werden die Standardanmeldeinformationen für Azure CLI verwendet oder die API fragt nach Anmeldeinformationen.
- subscription_id
- str
Die Abonnement-ID des enthaltenden Abonnements für den neuen Arbeitsbereich. Der Parameter ist erforderlich, wenn der Benutzer Zugriff auf mehrere Abonnements hat.
- resource_group
- str
Die Azure-Ressourcengruppe, die den Arbeitsbereich enthält. Der Standardwert des Parameters ist eine Abwandlung des Arbeitsbereichsnamens.
- location
- str
Standort des Arbeitsbereichs. Der Standardwert des Parameters ist der Standort der Ressourcengruppe. Der Standort muss eine unterstützte Region für Azure Machine Learning sein.
- create_resource_group
- bool
Gibt an, ob die Ressourcengruppe erstellt werden soll, wenn sie nicht vorhanden ist.
- sku
- str
Der Parameter ist aus Gründen der Abwärtskompatibilität vorhanden und wird ignoriert.
- friendly_name
- str
Ein optionaler Anzeigename für den Arbeitsbereich, der auf der Benutzeroberfläche angezeigt werden kann.
- storage_account
- str
Ein vorhandenes Speicherkonto im Azure-Ressourcen-ID-Format. Der Speicher wird vom Arbeitsbereich verwendet, um Ausführungsausgaben, Code, Protokolle usw. zu speichern. Bei None wird ein neues Speicherkonto erstellt.
- key_vault
- str
Ein vorhandener Schlüsseltresor im Azure-Ressourcen-ID-Format. Weitere Informationen zum Azure-Ressourcen-ID-Format finden Sie unten im Beispielcode. Der Schlüsseltresor wird vom Arbeitsbereich verwendet, um Anmeldeinformationen zu speichern, die dem Arbeitsbereich von den Benutzern hinzugefügt werden. Bei None wird ein neuer Schlüsseltresor erstellt.
- app_insights
- str
Eine vorhandene Application Insights-Instanz im Azure-Ressourcen-ID-Format. Weitere Informationen zum Azure-Ressourcen-ID-Format finden Sie unten im Beispielcode. Die Application Insights-Instanz wird vom Arbeitsbereich verwendet, um Webdienstereignisse zu protokollieren. Bei None wird eine neue Application Insights-Instanz erstellt.
- container_registry
- str
Eine vorhandene Containerregistrierung im Azure-Ressourcen-ID-Format (weitere Informationen zum Azure-Ressourcen-ID-Format finden Sie unten im Beispielcode). Die Containerregistrierung wird vom Arbeitsbereich verwendet, um Experimente und Webdienstimages zu pullen und zu pushen. Bei None wird nicht im Rahmen der Erstellung des Arbeitsbereichs, sondern nur bei Bedarf eine neue Containerregistrierung erstellt.
- adb_workspace
- str
Ein vorhandener adb-Arbeitsbereich im Azure-Ressourcen-ID-Format (weitere Informationen zum Azure-Ressourcen-ID-Format finden Sie unten im Beispielcode). Der Adb-Arbeitsbereich wird zum Verknüpfen mit dem Arbeitsbereich verwendet. Bei „None“ wird der Arbeitsbereich nicht verknüpft.
- primary_user_assigned_identity
- str
Die Ressourcen-ID der benutzerseitig zugewiesenen Identität, die zum Darstellen des Arbeitsbereichs verwendet wird.
- cmk_keyvault
- str
Der Schlüsseltresor, der den kundenseitig verwalteten Schlüssel enthält, im Azure-Ressourcen-ID-Format: /subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Beispiel: ‚/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault‘. Weitere Informationen zum Azure-Ressourcen-ID-Format finden Sie unten im Beispielcode und unter Hinweise.
- resource_cmk_uri
- str
Der Schlüssel-URI des kundenseitig verwalteten Schlüssels zum Verschlüsseln ruhender Daten.
Das URI-Format ist https://<keyvault-dns-name>/keys/<key-name>/<key-version>.
Beispiel: „https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b“.
Anweisungen zum Erstellen eines Schlüssels und Abrufen des URI finden Sie unter https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal.
- hbi_workspace
- bool
Gibt an, ob der Arbeitsbereich Daten mit hohen geschäftlichen Auswirkungen (High Business Impact, HBI) enthält, d.h. vertrauliche Geschäftsinformationen. Dieses Flag kann nur während der Erstellung des Arbeitsbereichs festgelegt werden. Nach dem Erstellen des Arbeitsbereichs kann der Wert nicht mehr geändert werden. Der Standardwert ist False.
Wenn True festgelegt ist, werden weitere Verschlüsselungsschritte ausgeführt, und abhängig von der SDK-Komponente werden Informationen in intern erfassten Telemetriedaten unkenntlich gemacht. Weitere Informationen finden Sie unter Datenverschlüsselung.
Wenn dieses Flag auf True gesetzt ist, ist eine mögliche Auswirkung mehr Schwierigkeiten bei der Problembehandlung. Dies kann passieren, weil einige Telemetriedaten nicht an Microsoft gesendet werden und weniger Einblick in Erfolgsraten oder Problemtypen besteht und daher möglicherweise nicht so proaktiv reagieren kann, wenn dieses Flag auf True gesetzt ist. Es wird empfohlen, für dieses Flag den Standardwert False zu verwenden, sofern nicht unbedingt True festgelegt werden muss.
- default_cpu_compute_target
- AmlComputeProvisioningConfiguration
(VERALTET) Eine Konfiguration, die zum Erstellen einer CPU-Compute-Ressource verwendet wird. Der Standardwert des Parameters ist {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"}. Bei None wird keine Compute-Ressource erstellt.
- default_gpu_compute_target
- AmlComputeProvisioningConfiguration
(VERALTET) Eine Konfiguration, die zum Erstellen einer GPU-Compute-Ressource verwendet wird. Der Standardwert des Parameters ist {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"}. Bei None wird keine Compute-Ressource erstellt.
- private_endpoint_config
- PrivateEndPointConfig
Die Konfiguration des privaten Endpunkts zum Erstellen eines privaten Endpunkts für den Azure ML-Arbeitsbereich.
- private_endpoint_auto_approval
- bool
Ein boolesches Flag, das angibt, ob die Erstellung des privaten Endpunkts automatisch oder manuell über das Azure Private Link Center genehmigt werden soll. Im Fall einer manuellen Genehmigung können Benutzer die ausstehende Anforderung im Private Link-Portal anzeigen, um sie zu genehmigen/abzulehnen.
- exist_ok
- bool
Gibt an, ob diese Methode erfolgreich ist, wenn der Arbeitsbereich bereits vorhanden ist. Bei False tritt bei der Ausführung dieser Methode ein Fehler auf, wenn der Arbeitsbereich vorhanden ist. Bei True gibt diese Methode den vorhandenen Arbeitsbereich zurück.
- user_assigned_identity_for_cmk_encryption
- str
Die Ressourcen-ID der benutzerseitig zugewiesenen Identität, die für den Zugriff auf den kundenseitig verwalteten Schlüssel verwendet werden muss.
- system_datastores_auth_mode
- str
Bestimmt, ob Anmeldeinformationen für die Systemdatenspeicher „workspaceblobstore“ und „workspacefilestore“ des Arbeitsbereichs verwendet werden. Der Standardwert ist „accessKey“. In diesem Fall erstellt der Arbeitsbereich die Systemdatenspeicher mit Anmeldeinformationen. Wenn „identity“ festgelegt ist, erstellt der Arbeitsbereich die Systemdatenspeicher ohne Anmeldeinformationen.
- v1_legacy_mode
- bool
Verhindern der Verwendung des v2-API-Diensts in öffentlichen Azure-Resource Manager
Gibt zurück
Das Arbeitsbereichsobjekt.
Rückgabetyp
Ausnahmen
Wird bei Problemen beim Erstellen des Arbeitsbereichs ausgelöst.
Hinweise
Dieses erste Beispiel erfordert nur minimale Angaben, und alle abhängigen Ressourcen sowie die Ressourcengruppe werden automatisch erstellt.
from azureml.core import Workspace
ws = Workspace.create(name='myworkspace',
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup',
create_resource_group=True,
location='eastus2')
Das folgende Beispiel zeigt, wie Sie vorhandene Azure-Ressourcen mithilfe des Azure-Ressourcen-ID-Formats wiederverwenden. Die spezifischen Azure-Ressourcen-IDs können über das Azure-Portal oder das SDK abgerufen werden. Dieses Beispiel setzt voraus, dass die Ressourcengruppe, das Speicherkonto, der Schlüsseltresor, eine App Insights-Instanz und die Containerregistrierung bereits vorhanden sind.
import os
from azureml.core import Workspace
from azureml.core.authentication import ServicePrincipalAuthentication
service_principal_password = os.environ.get("AZUREML_PASSWORD")
service_principal_auth = ServicePrincipalAuthentication(
tenant_id="<tenant-id>",
username="<application-id>",
password=service_principal_password)
ws = Workspace.create(name='myworkspace',
auth=service_principal_auth,
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup',
create_resource_group=False,
location='eastus2',
friendly_name='My workspace',
storage_account='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.storage/storageaccounts/mystorageaccount',
key_vault='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault',
app_insights='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.insights/components/myappinsights',
container_registry='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.containerregistry/registries/mycontainerregistry',
exist_ok=False)
delete
Löschen Sie den Azure Machine Learning-Arbeitsbereich und die zugeordneten Ressourcen.
delete(delete_dependent_resources=False, no_wait=False)Parameter
- delete_dependent_resources
- bool
Gibt an, ob dem Arbeitsbereich zugeordnete Ressourcen gelöscht werden sollen, d.h. Containerregistrierung, Speicherkonto, Schlüsseltresor und Application Insights-Instanz. Die Standardeinstellung lautet „false“. Legen Sie True fest, um diese Ressourcen zu löschen.
- no_wait
- bool
Gibt an, ob auf den Abschluss des Löschvorgangs für den Arbeitsbereich gewartet werden soll.
Gibt zurück
Bei erfolgreicher Ausführung wird nichts zurückgegeben. Andernfalls wird ein Fehler ausgelöst.
Rückgabetyp
delete_connection
Löschen Sie eine Verbindung des Arbeitsbereichs.
delete_connection(name)Parameter
delete_private_endpoint_connection
Löschen der Verbindung mit privatem Endpunkt für den Arbeitsbereich.
delete_private_endpoint_connection(private_endpoint_connection_name)Parameter
- private_endpoint_connection_name
- str
Der eindeutige Name der Verbindung mit privatem Endpunkt im Arbeitsbereich
diagnose_workspace
Diagnostizieren von Problemen beim Einrichten des Arbeitsbereichs.
diagnose_workspace(diagnose_parameters)Parameter
- diagnose_parameters
- <xref:_restclient.models.DiagnoseWorkspaceParameters>
Der Parameter zum Diagnostizieren der Arbeitsbereichsintegrität.
Gibt zurück
Eine AzureOperationPoller-Instanz, die DiagnoseResponseResult zurückgibt.
Rückgabetyp
from_config
Geben Sie ein Arbeitsbereichsobjekts aus einem vorhandenen Azure Machine Learning-Arbeitsbereich zurück.
Liest die Arbeitsbereichskonfiguration aus einer Datei. Löst eine Ausnahme aus, wenn die Konfigurationsdatei nicht gefunden wird.
Diese Methode ermöglicht die einfache Wiederverwendung des gleichen Arbeitsbereichs in mehreren Python-Notebooks oder -Projekten. Benutzer können die Azure Resource Manager (ARM)-Eigenschaften des Arbeitsbereichs mithilfe der write_config-Methode speichern und den gleichen Arbeitsbereich mit dieser Methode in verschiedene Python-Notebooks oder -Projekte laden, ohne die ARM-Eigenschaften des Arbeitsbereichs erneut eingeben zu müssen.
static from_config(path=None, auth=None, _logger=None, _file_name=None)Parameter
- path
- str
Der Pfad zur Konfigurationsdatei oder zum Startverzeichnis, in dem gesucht werden soll. Beim Standardwert des Parameters beginnt die Suche im aktuellen Verzeichnis.
Das Authentication-Objekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Bei None werden die Standardanmeldeinformationen für Azure CLI verwendet oder die API fragt nach Anmeldeinformationen.
- _file_name
- str
Ermöglicht das Überschreiben des Konfigurationsdateinamens, nach dem gesucht wird, wenn der Pfad ein Verzeichnispfad ist.
Gibt zurück
Das Arbeitsbereichsobjekt für einen vorhandenen Azure ML-Arbeitsbereich.
Rückgabetyp
get
Geben Sie ein Arbeitsbereichsobjekt für einen vorhandenen Azure Machine Learning-Arbeitsbereich zurück.
Löst eine Ausnahme aus, wenn der Arbeitsbereich nicht vorhanden ist oder die Pflichtfelder keinen Arbeitsbereich eindeutig identifizieren.
static get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)Parameter
Das Authentication-Objekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Bei „None“ werden die Standardanmeldeinformationen für die Azure-Befehlszeilenschnittstelle (Azure CLI) verwendet, oder die API fordert zur Eingabe von Anmeldeinformationen auf.
- subscription_id
- str
Die zu verwendende Abonnement-ID. Der Parameter ist erforderlich, wenn der Benutzer Zugriff auf mehrere Abonnements hat.
- resource_group
- str
Die zu verwendende Ressourcengruppe. Bei „None“ durchsucht die Methode alle Ressourcengruppen im Abonnement.
- cloud
- str
Der Name der Zielcloud. Die möglichen Werte sind „AzureCloud“, „AzureChinaCloud“ und „AzureUSGovernment“. Wenn keine Cloud angegeben wird, wird „AzureCloud“ verwendet.
Gibt zurück
Das Workspace-Objekt.
Rückgabetyp
get_connection
Abrufen einer Verbindung des Arbeitsbereichs.
get_connection(name)Parameter
get_default_compute_target
Rufen Sie das Standardcomputeziel für den Arbeitsbereich ab.
get_default_compute_target(type)Parameter
Gibt zurück
Das Standardcomputeziel für den angegebenen Computetyp.
Rückgabetyp
get_default_datastore
Abrufen des Standarddatenspeichers für den Arbeitsbereich.
get_default_datastore()Gibt zurück
Der Standarddatenspeicher.
Rückgabetyp
get_default_keyvault
Abrufen des Standardschlüsseltresor-Objekts für den Arbeitsbereich.
get_default_keyvault()Gibt zurück
Das KeyVault-Objekt, das dem Arbeitsbereich zugeordnet ist.
Rückgabetyp
get_details
Geben Sie die Details des Arbeitsbereichs zurück.
get_details()Gibt zurück
Details zum Arbeitsbereich im Wörterbuchformat.
Rückgabetyp
Hinweise
Das zurückgegebene Wörterbuch enthält die folgenden Schlüssel-Wert-Paare.
id: Der URI, der auf diese Arbeitsbereichsressource verweist, die ID des enthaltenden Abonnements, die Ressourcengruppe und der Arbeitsbereichsname.
name: Der Name dieses Arbeitsbereichs.
location: Die Arbeitsbereichsregion.
type: Ein URI im Format „{providerName}/workspaces“.
tags: Wird derzeit nicht verwendet.
workspaceid: Die ID dieses Arbeitsbereichs.
description: Wird derzeit nicht verwendet.
friendlyName: Ein Anzeigename für den Arbeitsbereich, der auf der Benutzeroberfläche angezeigt wird.
creationTime: Der Zeitpunkt der Erstellung dieses Arbeitsbereichs im ISO8601-Format.
containerRegistry: Die Containerregistrierung des Arbeitsbereichs, die zum Pullen und Pushen von Experimenten und Webdienstimages verwendet wird.
keyVault: Der Schlüsseltresor des Arbeitsbereichs, der zum Speichern von Anmeldeinformationen verwendet wird, die dem Arbeitsbereich von den Benutzern hinzugefügt werden.
applicationInsights: Die Application Insights-Instanz wird vom Arbeitsbereich verwendet, um Webdienstereignisse zu protokollieren.
identityPrincipalId:
identityTenantId
identityType
storageAccount: Der Speicher wird vom Arbeitsbereich verwendet, um Ausführungsausgaben, Code, Protokolle usw. zu speichern.
sku: Die Arbeitsbereichs-SKU (wird auch als Edition bezeichnet). Der Parameter ist aus Gründen der Abwärtskompatibilität vorhanden und wird ignoriert.
resourceCmkUri: Der Schlüssel-URI des kundenseitig verwalteten Schlüssels zum Verschlüsseln ruhender Daten. Anweisungen zum Erstellen eines Schlüssels und Abrufen des URI finden Sie unter https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910.
hbiWorkspace: Gibt an, ob die Kundendaten hohe geschäftliche Auswirkungen haben.
imageBuildCompute: Das Computeziel für die Imageerstellung.
systemDatastoresAuthMode: Bestimmt, ob Anmeldeinformationen für die Systemdatenspeicher „workspaceblobstore“ und „workspacefilestore“ des Arbeitsbereichs verwendet werden. Der Standardwert ist „accessKey“. In diesem Fall erstellt der Arbeitsbereich die Systemdatenspeicher mit Anmeldeinformationen. Wenn „identity“ festgelegt ist, erstellt der Arbeitsbereich die Systemdatenspeicher ohne Anmeldeinformationen.
Weitere Informationen zu diesen Schlüssel-Wert-Paaren finden Sie unter create.
get_mlflow_tracking_uri
Rufen Sie den MLflow-Nachverfolgungs-URI für den Arbeitsbereich ab.
MLflow (https://mlflow.org/) ist eine Open-Source-Plattform zum Nachverfolgen von Machine Learning-Experimenten und Verwalten von Modellen. Sie können MLflow-Protokollierungs-APIs mit Azure Machine Learning verwenden, damit Metriken, Modelle und Artefakte in Ihrem Azure Machine Learning-Arbeitsbereich protokolliert werden.
get_mlflow_tracking_uri(_with_auth=False)Parameter
- _with_auth
- bool
(VERALTET) Hinzufügen von Authentifizierungsinformationen zum Nachverfolgungs-URI.
Gibt zurück
Der MLflow-kompatible Nachverfolgungs-URI.
Rückgabetyp
Hinweise
Verwenden Sie das folgende Beispiel, um die MLflow-Nachverfolgung zum Senden von Daten an den Azure ML-Arbeitsbereich zu konfigurieren:
import mlflow
from azureml.core import Workspace
workspace = Workspace.from_config()
mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())
get_run
Geben Sie die Ausführung mit der angegebenen „run_id“ im Arbeitsbereich zurück.
get_run(run_id)Parameter
Gibt zurück
Die übermittelte Ausführung.
Rückgabetyp
list
Listen Sie alle Arbeitsbereiche auf, zu denen der Benutzer innerhalb des Abonnements Zugriff hat.
Die Liste der Arbeitsbereiche kann nach der Ressourcengruppe gefiltert werden.
static list(subscription_id, auth=None, resource_group=None)Parameter
- subscription_id
- str
Die Abonnement-ID, für die Arbeitsbereiche aufgelistet werden sollen.
Das Authentication-Objekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Bei „None“ werden die Standardanmeldeinformationen für die Azure-Befehlszeilenschnittstelle (Azure CLI) verwendet, oder die API fordert zur Eingabe von Anmeldeinformationen auf.
- resource_group
- str
Eine Ressourcengruppe zum Filtern der zurückgegebenen Arbeitsbereiche. Bei None listet die Methode alle Arbeitsbereiche im angegebenen Abonnement auf.
Gibt zurück
Ein Wörterbuch, bei dem der Schlüssel der Name des Arbeitsbereichs und der Wert eine Liste von Arbeitsbereichsobjekten ist.
Rückgabetyp
list_connections
Listen Sie die Verbindungen in diesem Arbeitsbereich auf.
list_connections(category=None, target=None)Parameter
- category
list_keys
set_connection
Fügen Sie eine Verbindung im Arbeitsbereich hinzu oder aktualisieren Sie diese.
set_connection(name, category, target, authType, value)Parameter
set_default_datastore
Legen Sie den Standarddatenspeicher für den Arbeitsbereich fest.
set_default_datastore(name)Parameter
setup
Erstellen eines neuen Arbeitsbereichs oder Abrufen eines vorhandenen Arbeitsbereichs.
static setup()Gibt zurück
Ein Arbeitsbereichsobjekt.
Rückgabetyp
sync_keys
Löst eine sofortige Schlüsselsynchronisierung im Arbeitsbereich aus.
Wenn Schlüssel für Ressourcen im Arbeitsbereich geändert werden, kann es etwa eine Stunde dauern, bis diese automatisch aktualisiert werden. Mit dieser Funktion können Schlüssel auf Anforderung aktualisiert werden. Sie kann z. B. verwendet werden, wenn nach dem erneuten Generieren von Speicherschlüsseln der sofortige Zugriff auf den Speicher erforderlich ist.
sync_keys(no_wait=False)Parameter
- no_wait
- bool
Gibt an, ob auf den Abschluss der Schlüsselsynchronisierung im Arbeitsbereich gewartet werden soll.
Gibt zurück
Bei erfolgreicher Ausführung wird nichts zurückgegeben. Andernfalls wird ein Fehler ausgelöst.
Rückgabetyp
update
Aktualisieren von Anzeigename, Beschreibung, Tags, Computename für die Imageerstellung und anderen Einstellungen eines Arbeitsbereichs.
update(friendly_name=None, description=None, tags=None, image_build_compute=None, service_managed_resources_settings=None, primary_user_assigned_identity=None, allow_public_access_when_behind_vnet=None, v1_legacy_mode=None)Parameter
- friendly_name
- str
Ein Anzeigename für den Arbeitsbereich, der auf der Benutzeroberfläche angezeigt werden kann.
- service_managed_resources_settings
- <xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
Die vom Dienst verwalteten Ressourceneinstellungen.
- primary_user_assigned_identity
- str
Die Ressourcen-ID für die benutzerseitig zugewiesene Identität, die die Arbeitsbereichsidentität darstellt.
- allow_public_access_when_behind_vnet
- bool
Zulassen des öffentlichen Zugriffs auf den Private Link-Arbeitsbereich.
- v1_legacy_mode
- bool
Verhindern der Verwendung des v2-API-Diensts in öffentlichen Azure-Resource Manager
Gibt zurück
Ein Wörterbuch mit aktualisierten Informationen.
Rückgabetyp
update_dependencies
Aktualisieren der vorhandenen zugeordneten Ressourcen für den Arbeitsbereich. Diese Methode kann in folgenden Fällen verwendet werden.
a) Wenn ein Benutzer versehentlich eine vorhandene zugeordnete Ressource löscht und diese mit einer neuen Ressource aktualisieren möchte, ohne den gesamten Arbeitsbereich neu erstellen zu müssen. b) Wenn ein Benutzer über eine vorhandene zugeordnete Ressource verfügt und die Ressource ersetzen möchte, die dem Arbeitsbereich aktuell zugeordnet ist. c) Wenn noch keine zugeordnete Ressource erstellt wurde und eine bereits vorhandene Ressource verwendet werden soll (gilt nur für die Containerregistrierung).
update_dependencies(container_registry=None, force=False)Parameter
- force
- bool
Bei der Verwendung von „force“ werden abhängige Ressourcen ohne Bestätigungsaufforderung aktualisiert.
Rückgabetyp
write_config
Schreiben Sie die Azure Resource Manager (ARM)-Eigenschaften des Arbeitsbereichs in eine Konfigurationsdatei.
Die ARM-Eigenschaften des Arbeitsbereichs können später mit der from_config-Methode geladen werden. Der Standardwert von path ist „.azureml/“ im aktuellen Arbeitsverzeichnis. Der Standardwert von file_name ist „config.json“.
Diese Methode ermöglicht die einfache Wiederverwendung des gleichen Arbeitsbereichs in mehreren Python-Notebooks oder -Projekten. Benutzer können die ARM-Eigenschaften des Arbeitsbereichs mithilfe dieser Funktion speichern und den gleichen Arbeitsbereich mit from_config in verschiedene Python-Notebooks oder -Projekte laden, ohne die ARM-Eigenschaften des Arbeitsbereichs erneut eingeben zu müssen.
write_config(path=None, file_name=None)Parameter
- path
- str
Ein vom Benutzer angegebener Speicherort zum Schreiben der Datei „config.json“. Der Standardwert dieses Parameters ist im aktuellen Arbeitsverzeichnis azureml/.
- file_name
- str
Der Name, der für die Konfigurationsdatei verwendet werden soll. Der Standardwert dieses Parameters ist config.json.
Attribute
compute_targets
Auflisten aller Computeziele im Arbeitsbereich.
Gibt zurück
Ein Wörterbuch, bei dem der Schlüssel der Name des Computeziels und der Wert ein ComputeTarget-Objekt ist.
Rückgabetyp
datasets
Auflisten aller Datasets im Arbeitsbereich.
Gibt zurück
Ein Wörterbuch, bei dem der Schlüssel der Name des Datasets und der Wert ein Dataset-Objekt ist.
Rückgabetyp
datastores
Auflisten aller Datenspeicher im Arbeitsbereich. Dieser Vorgang gibt die Anmeldeinformationen der Datenspeicher nicht zurück.
Gibt zurück
Ein Wörterbuch, bei dem der Schlüssel der Name des Datenspeichers und der Wert ein Datastore-Objekt ist.
Rückgabetyp
discovery_url
Dient zum Zurückgeben der Ermittlungs-URL dieses Arbeitsbereichs.
Gibt zurück
Die Ermittlungs-URL dieses Arbeitsbereichs.
Rückgabetyp
environments
Auflisten aller Umgebungen im Arbeitsbereich.
Gibt zurück
Ein Wörterbuch, bei dem der Schlüssel der Name der Umgebung und der Wert ein Environment-Objekt ist.
Rückgabetyp
experiments
Auflisten aller Experimente im Arbeitsbereich.
Gibt zurück
Ein Wörterbuch, bei dem der Schlüssel der Name des Experiments und der Wert ein Experiment-Objekt ist.
Rückgabetyp
images
Geben Sie die Liste der Images im Arbeitsbereich.
Löst eine WebserviceException aus, wenn bei der Interaktion mit dem Modellverwaltungsdienst ein Problem aufgetreten ist.
Gibt zurück
Ein Wörterbuch, bei dem der Schlüssel der Name des Images und der Wert ein Image-Objekt ist.
Rückgabetyp
Ausnahmen
Bei der Interaktion mit dem Modellverwaltungsdienst ist ein Problem aufgetreten.
linked_services
Auflisten aller verknüpften Dienste im Arbeitsbereich.
Gibt zurück
Ein Wörterbuch, bei dem der Schlüssel der Name des verknüpften Diensts und der Wert ein LinkedService-Objekt ist.
Rückgabetyp
location
Geben Sie den Speicherort dieses Arbeitsbereichs zurück.
Gibt zurück
Der Speicherort des Arbeitsbereichs.
Rückgabetyp
models
Geben Sie eine Liste der Modelle im Arbeitsbereich zurück.
Löst eine WebserviceException aus, wenn bei der Interaktion mit dem Modellverwaltungsdienst ein Problem aufgetreten ist.
Gibt zurück
Ein Wörterbuch von Modellen, bei dem der Schlüssel der Name des Modells und der Wert ein Model-Objekt ist.
Rückgabetyp
Ausnahmen
Bei der Interaktion mit dem Modellverwaltungsdienst ist ein Problem aufgetreten.
name
Geben Sie den Namen des Arbeitsbereichs zurück.
Gibt zurück
Der Arbeitsbereichsname.
Rückgabetyp
private_endpoints
Listen Sie alle privaten Endpunkte des Arbeitsbereichs auf.
Gibt zurück
Ein Wörterbuch von PrivateEndPoint-Objekten, die dem Arbeitsbereich zugeordnet sind. Der Schlüssel ist der Name des privaten Endpunkts.
Rückgabetyp
resource_group
Geben Sie den Namen der Ressourcengruppe für diesen Arbeitsbereich zurück.
Gibt zurück
Der Name der Ressourcengruppe.
Rückgabetyp
service_context
Geben Sie den Dienstkontext für diesen Arbeitsbereich zurück.
Gibt zurück
Geben Sie das ServiceContext-Objekt zurück.
Rückgabetyp
sku
Geben Sie die SKU dieses Arbeitsbereichs zurück.
Gibt zurück
Die SKU dieses Arbeitsbereichs.
Rückgabetyp
subscription_id
Geben Sie die Abonnement-ID für diesen Arbeitsbereich zurück.
Gibt zurück
Die Abonnement-ID.
Rückgabetyp
tags
Geben Sie die Tags dieses Arbeitsbereichs zurück.
Gibt zurück
Die Tags dieses Arbeitsbereichs.
Rückgabetyp
webservices
Geben Sie eine Liste der Webdienste im Arbeitsbereich zurück.
Löst eine WebserviceException aus, wenn beim Zurückgeben der Liste ein Problem aufgetreten ist.
Gibt zurück
Eine Liste der Webdienste im Arbeitsbereich.
Rückgabetyp
Ausnahmen
Beim Zurückgeben der Liste ist ein Problem aufgetreten.
DEFAULT_CPU_CLUSTER_CONFIGURATION
DEFAULT_CPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>DEFAULT_CPU_CLUSTER_NAME
DEFAULT_CPU_CLUSTER_NAME = 'cpu-cluster'DEFAULT_GPU_CLUSTER_CONFIGURATION
DEFAULT_GPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>DEFAULT_GPU_CLUSTER_NAME
DEFAULT_GPU_CLUSTER_NAME = 'gpu-cluster'Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für