Workspace Klasse
Definiert eine Azure Machine Learning-Ressource zum Verwalten von Schulungs- und Bereitstellungsartefakten.
Ein Arbeitsbereich ist eine grundlegende Ressource für maschinelles Lernen in Azure Machine Learning. Sie verwenden einen Arbeitsbereich, um Machine Learning-Modelle zu experimentieren, zu trainieren und bereitzustellen. Jeder Arbeitsbereich ist an ein Azure-Abonnement und eine Ressourcengruppe gebunden und verfügt über eine zugeordnete SKU.
Weitere Informationen zu Arbeitsbereichen finden Sie unter:
Class Workspace-Konstruktor zum Laden eines vorhandenen Azure Machine Learning Workspace.
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
| Name | Beschreibung |
|---|---|
|
subscription_id
Erforderlich
|
Die Azure-Abonnement-ID, die den Arbeitsbereich enthält. |
|
resource_group
Erforderlich
|
Die Ressourcengruppe mit dem Arbeitsbereich. |
|
workspace_name
Erforderlich
|
Der vorhandene Arbeitsbereichsname. |
|
auth
|
Das Authentifizierungsobjekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Wenn keine, werden die standardmäßigen Azure CLI-Anmeldeinformationen verwendet, oder die API fordert Anmeldeinformationen ein. Standardwert: None
|
|
_location
|
Nur zur internen Verwendung. Standardwert: None
|
|
_disable_service_check
|
Nur zur internen Verwendung. Standardwert: False
|
|
_workspace_id
|
Nur zur internen Verwendung. Standardwert: None
|
|
sku
|
Der Parameter ist zur Abwärtskompatibilität vorhanden und wird ignoriert. Standardwert: basic
|
|
_cloud
|
Nur zur internen Verwendung. Standardwert: AzureCloud
|
|
subscription_id
Erforderlich
|
Die Azure-Abonnement-ID, die den Arbeitsbereich enthält. |
|
resource_group
Erforderlich
|
Die Ressourcengruppe mit dem Arbeitsbereich. |
|
workspace_name
Erforderlich
|
Der Arbeitsbereichsname. Der Name muss zwischen 2 und 32 Zeichen lang sein. Das erste Zeichen des Namens muss alphanumerisch (Buchstabe oder Zahl) sein, aber der Rest des Namens kann Alphanumerik, Bindestriche und Unterstriche enthalten. Leerzeichen sind nicht zulässig. |
|
auth
Erforderlich
|
Das Authentifizierungsobjekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Wenn keine, werden die standardmäßigen Azure CLI-Anmeldeinformationen verwendet, oder die API fordert Anmeldeinformationen ein. |
|
_location
Erforderlich
|
Nur zur internen Verwendung. |
|
_disable_service_check
Erforderlich
|
Nur zur internen Verwendung. |
|
_workspace_id
Erforderlich
|
Nur zur internen Verwendung. |
|
sku
Erforderlich
|
Der Parameter ist zur Abwärtskompatibilität vorhanden und wird ignoriert. |
|
tags
|
Tags, die dem Arbeitsbereich zugeordnet werden sollen. Standardwert: None
|
|
_cloud
Erforderlich
|
Nur zur internen Verwendung. |
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.
Um denselben Arbeitsbereich in mehreren Umgebungen zu verwenden, erstellen Sie eine JSON-Konfigurationsdatei. Die Konfigurationsdatei speichert Ihren Abonnement-, Ressourcen- und Arbeitsbereichsnamen, damit sie problemlos geladen werden kann. Verwenden Sie zum Speichern der Konfiguration die write_config Methode.
ws.write_config(path="./file-path", file_name="ws_config.json")
Unter Erstellen einer Arbeitsbereichskonfigurationsdatei finden Sie ein Beispiel für die Konfigurationsdatei.
Verwenden Sie die from_config Methode, um den Arbeitsbereich aus der Konfigurationsdatei zu laden.
ws = Workspace.from_config()
ws.get_details()
Verwenden Sie alternativ die get Methode, um einen vorhandenen Arbeitsbereich zu laden, ohne Konfigurationsdateien zu verwenden.
ws = Workspace.get(name="myworkspace",
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup')
In den obigen Beispielen werden Sie möglicherweise über ein interaktives Anmeldedialogfeld zur Eingabe von Azure-Authentifizierungsanmeldeinformationen aufgefordert. Weitere Anwendungsfälle, einschließlich der Verwendung der Azure CLI zur Authentifizierung und Authentifizierung in automatisierten Workflows, finden Sie unter "Authentifizierung in Azure Machine Learning".
Methoden
| add_private_endpoint |
Fügen Sie dem Arbeitsbereich einen privaten Endpunkt hinzu. |
| create |
Erstellen Sie einen neuen Azure Machine Learning-Arbeitsbereich. Löst eine Ausnahme aus, wenn der Arbeitsbereich bereits vorhanden ist oder eine der Arbeitsbereichsanforderungen nicht erfüllt ist. |
| delete |
Löschen Sie die zugeordneten Ressourcen des Azure Machine Learning Workspace. |
| delete_connection |
Löschen einer Verbindung des Arbeitsbereichs. |
| delete_private_endpoint_connection |
Löschen Sie die private Endpunktverbindung mit dem Arbeitsbereich. |
| diagnose_workspace |
Diagnostizieren von Problemen beim Einrichten des Arbeitsbereichs. |
| from_config |
Zurückgeben eines Arbeitsbereichsobjekts aus einem vorhandenen Azure Machine Learning Workspace. Liest die Arbeitsbereichskonfiguration aus einer Datei. Löst eine Ausnahme aus, wenn die Konfigurationsdatei nicht gefunden werden kann. Die Methode bietet eine einfache Möglichkeit, denselben Arbeitsbereich in mehreren Python-Notizbüchern oder Projekten wiederzuverwenden. Benutzer können die Eigenschaften des Arbeitsbereichs Azure Resource Manager (ARM) mithilfe der write_config Methode speichern und diese Methode verwenden, um denselben Arbeitsbereich in verschiedenen Python-Notizbüchern oder -Projekten zu laden, ohne die Arbeitsbereichs-ARM-Eigenschaften neu einzugeben. |
| get |
Zurückgeben eines Arbeitsbereichsobjekts für einen vorhandenen Azure Machine Learning Workspace. Löst eine Ausnahme aus, wenn der Arbeitsbereich nicht vorhanden ist oder die erforderlichen Felder einen Arbeitsbereich nicht eindeutig identifizieren. |
| get_connection |
Ruft eine Verbindung des Arbeitsbereichs ab. |
| get_default_compute_target |
Rufen Sie das Standardmäßige Computeziel für den Arbeitsbereich ab. |
| get_default_datastore |
Rufen Sie den Standarddatenspeicher für den Arbeitsbereich ab. |
| get_default_keyvault |
Rufen Sie das Standardschlüsseltresorobjekt für den Arbeitsbereich ab. |
| get_details |
Geben Sie die Details des Arbeitsbereichs zurück. |
| get_mlflow_tracking_uri |
Rufen Sie den MLflow-Tracking-URI für den Arbeitsbereich ab. MLflow (https://mlflow.org/) ist eine Open-Source-Plattform zum Nachverfolgen von Machine Learning-Experimenten und Zum 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 |
Gibt die Ausführung mit dem angegebenen run_id im Arbeitsbereich zurück. |
| list |
Listet alle Arbeitsbereiche auf, auf die der Benutzer innerhalb des Abonnements zugreifen kann. Die Liste der Arbeitsbereiche kann basierend auf der Ressourcengruppe gefiltert werden. |
| list_connections |
Listen Sie Verbindungen unter diesem Arbeitsbereich auf. |
| list_keys |
Listenschlüssel für den aktuellen Arbeitsbereich. |
| set_connection |
Hinzufügen oder Aktualisieren einer Verbindung unter dem Arbeitsbereich. |
| set_default_datastore |
Legen Sie den Standarddatenspeicher für den Arbeitsbereich fest. |
| setup |
Erstellen Sie einen neuen Arbeitsbereich, oder rufen Sie einen vorhandenen Arbeitsbereich ab. |
| sync_keys |
Löst den Arbeitsbereich aus, um die Tasten sofort zu synchronisieren. Wenn Schlüssel für eine Ressource im Arbeitsbereich geändert werden, kann es etwa eine Stunde dauern, bis sie automatisch aktualisiert werden. Mit dieser Funktion können Schlüssel auf Anfrage aktualisiert werden. Ein Beispielszenario benötigt unmittelbaren Zugriff auf den Speicher nach der Neugenerierung von Speicherschlüsseln. |
| update |
Aktualisieren Sie Anzeigename, Beschreibung, Tags, Bildbuild-Compute und andere Einstellungen, die einem Arbeitsbereich zugeordnet sind. |
| update_dependencies |
Aktualisieren Sie die zugeordneten Ressourcen für den Arbeitsbereich in den folgenden Fällen. a) Wenn ein Benutzer versehentlich eine vorhandene zugeordnete Ressource löscht und sie mit einem neuen 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 aktuelle Ressource ersetzen möchte, die dem Arbeitsbereich zugeordnet ist. c) Wenn eine zugeordnete Ressource noch nicht erstellt wurde und sie eine vorhandene Ressource verwenden möchten, die sie bereits besitzen (gilt nur für die Containerregistrierung). |
| write_config |
Schreiben Sie die Arbeitsbereichseigenschaften des Azure Resource Manager (ARM) in eine Konfigurationsdatei. Arbeitsbereich ARM-Eigenschaften können später mithilfe der from_config Methode geladen werden. Die Die Methode bietet eine einfache Möglichkeit, denselben Arbeitsbereich in mehreren Python-Notizbüchern oder Projekten wiederzuverwenden. Benutzer können die Arbeitsbereichs-ARM-Eigenschaften mithilfe dieser Funktion speichern und from_config verwenden, um denselben Arbeitsbereich in verschiedenen Python-Notizbüchern oder -Projekten zu laden, ohne die Arbeitsbereichs-ARM-Eigenschaften neu einzugeben. |
add_private_endpoint
Fügen Sie dem Arbeitsbereich einen privaten Endpunkt hinzu.
add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)Parameter
| Name | Beschreibung |
|---|---|
|
private_endpoint_config
Erforderlich
|
Die Konfiguration des privaten Endpunkts zum Erstellen eines privaten Endpunkts für den Arbeitsbereich. |
|
private_endpoint_auto_approval
|
Ein boolesches Flag, das angibt, ob die Erstellung privater Endpunkte automatisch genehmigt oder manuell vom Azure Private Link Center genehmigt werden soll. Bei manueller Genehmigung können Benutzer die ausstehende Anforderung im Portal für private Links anzeigen, um die Anforderung zu genehmigen/abzulehnen. Standardwert: True
|
|
location
|
Speicherort des privaten Endpunkts, Standard ist der Arbeitsbereichsspeicherort. Standardwert: None
|
|
show_output
|
Kennzeichnung zum Anzeigen des Fortschritts der Arbeitsbereicherstellung Standardwert: True
|
|
tags
|
Tags, die dem Arbeitsbereich zugeordnet werden sollen. Standardwert: None
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Das privateEndPoint-Objekt wurde erstellt. |
create
Erstellen Sie einen neuen Azure Machine Learning-Arbeitsbereich.
Löst eine Ausnahme aus, wenn der Arbeitsbereich bereits vorhanden ist 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 | Beschreibung |
|---|---|
|
name
Erforderlich
|
Der name des neuen Arbeitsbereichs. Der Name muss zwischen 2 und 32 Zeichen lang sein. Das erste Zeichen des Namens muss alphanumerisch (Buchstabe oder Zahl) sein, aber der Rest des Namens kann Alphanumerik, Bindestriche und Unterstriche enthalten. Leerzeichen sind nicht zulässig. |
|
auth
|
Das Authentifizierungsobjekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Wenn keine, werden die standardmäßigen Azure CLI-Anmeldeinformationen verwendet, oder die API fordert Anmeldeinformationen ein. Standardwert: None
|
|
subscription_id
|
Die Abonnement-ID des enthaltenden Abonnements für den neuen Arbeitsbereich. Der Parameter ist erforderlich, wenn der Benutzer Zugriff auf mehrere Abonnements hat. Standardwert: None
|
|
resource_group
|
Die Azure-Ressourcengruppe, die den Arbeitsbereich enthält. Der Parameter entspricht standardmäßig einer Mutation des Arbeitsbereichsnamens. Standardwert: None
|
|
location
|
Standort des Arbeitsbereichs. Der Parameter ist standardmäßig für den Speicherort der Ressourcengruppe festgelegt. Der Standort muss eine unterstützte Region für Azure Machine Learning sein. Standardwert: None
|
|
create_resource_group
|
Gibt an, ob die Ressourcengruppe erstellt werden soll, wenn sie nicht vorhanden ist. Standardwert: True
|
|
sku
|
Der Parameter ist zur Abwärtskompatibilität vorhanden und wird ignoriert. Standardwert: basic
|
|
tags
|
Tags, die dem Arbeitsbereich zugeordnet werden sollen. Standardwert: None
|
|
friendly_name
|
Ein optionaler Anzeigename für den Arbeitsbereich, der in der Benutzeroberfläche angezeigt werden kann. Standardwert: None
|
|
storage_account
|
Ein vorhandenes Speicherkonto im Azure-Ressourcen-ID-Format. Der Speicher wird vom Arbeitsbereich zum Speichern von Ausführungsausgaben, Code, Protokollen usw. verwendet. Wenn keines vorhanden ist, wird ein neues Speicherkonto erstellt. Standardwert: None
|
|
key_vault
|
Ein vorhandener Schlüsseltresor im Azure-Ressourcen-ID-Format. Details zum Azure-Ressourcen-ID-Format finden Sie im folgenden Beispielcode. Der Schlüsseltresor wird vom Arbeitsbereich zum Speichern von Anmeldeinformationen verwendet, die den Benutzern zum Arbeitsbereich hinzugefügt wurden. Wenn keines vorhanden ist, wird ein neuer Schlüsseltresor erstellt. Standardwert: None
|
|
app_insights
|
Eine vorhandene Application Insights im Azure-Ressourcen-ID-Format. Details zum Azure-Ressourcen-ID-Format finden Sie im folgenden Beispielcode. Application Insights wird vom Arbeitsbereich zum Protokollieren von Webservices-Ereignissen verwendet. Wenn keines vorhanden ist, wird eine neue Application Insights erstellt. Standardwert: None
|
|
container_registry
|
Eine vorhandene Containerregistrierung im Azure-Ressourcen-ID-Format (details zum Azure-Ressourcen-ID-Format finden Sie im folgenden Beispielcode). Die Containerregistrierung wird vom Arbeitsbereich verwendet, um sowohl Experiment- als auch Webservices-Images abzurufen und zu übertragen. Wenn keine, wird nur bei Bedarf eine neue Containerregistrierung erstellt und nicht zusammen mit der Arbeitsbereichserstellung. Standardwert: None
|
|
adb_workspace
|
Ein vorhandener Adb-Arbeitsbereich im Azure-Ressourcen-ID-Format (siehe Beispielcode unten für Details zum Azure-Ressourcen-ID-Format). Der Adb-Arbeitsbereich wird verwendet, um eine Verknüpfung mit dem Arbeitsbereich zu erstellen. If None, the workspace link will't happen. Standardwert: None
|
|
primary_user_assigned_identity
|
Die Ressourcen-ID der vom Benutzer zugewiesenen Identität, die zum Darstellen des Arbeitsbereichs verwendet wurde Standardwert: None
|
|
cmk_keyvault
|
Der Schlüsseltresor, der den vom Kunden verwalteten Schlüssel im Azure-Ressourcen-ID-Format enthält:
Standardwert: None
|
|
resource_cmk_uri
|
Der Schlüssel-URI des vom Kunden verwalteten Schlüssels zum Verschlüsseln der ruhenden Daten.
Das URI-Format lautet: Standardwert: None
|
|
hbi_workspace
|
Gibt an, ob der Arbeitsbereich Daten von High Business Impact (HBI) enthält, d. h. vertrauliche Geschäftsinformationen. Dieses Kennzeichen kann nur während der Arbeitsbereicherstellung festgelegt werden. Der Wert kann nicht geändert werden, nachdem der Arbeitsbereich erstellt wurde. Der Standardwert ist False. Bei Festlegung auf "True" werden weitere Verschlüsselungsschritte ausgeführt, und abhängig von der SDK-Komponente ergeben sich redacted-Informationen in intern gesammelter Telemetrie. Weitere Informationen finden Sie unter Datenverschlüsselung. Wenn dieses Kennzeichen auf "True" festgelegt ist, ist eine mögliche Auswirkung auf die Problembehandlung bei Problemen erhöht. Dies kann passieren, da einige Telemetriedaten nicht an Microsoft gesendet werden und es weniger Einblicke in Erfolgsraten oder Problemtypen gibt und daher möglicherweise nicht proaktiv reagieren kann, wenn diese Kennzeichnung "True" ist. Die Empfehlung ist die Standardeinstellung "False" für dieses Flag, es sei denn, dies muss unbedingt "True" sein. Standardwert: False
|
|
default_cpu_compute_target
|
(VERALTET) Eine Konfiguration, die zum Erstellen einer CPU-Berechnung verwendet wird. Der Parameter ist standardmäßig auf {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} If None, no compute will be created. Standardwert: None
|
|
default_gpu_compute_target
|
(VERALTET) Eine Konfiguration, die zum Erstellen einer GPU-Berechnung verwendet wird. Der Parameter ist standardmäßig auf {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} If None, no compute will be created. Standardwert: None
|
|
private_endpoint_config
|
Die Konfiguration des privaten Endpunkts zum Erstellen eines privaten Endpunkts im Azure ML-Arbeitsbereich. Standardwert: None
|
|
private_endpoint_auto_approval
|
Ein boolesches Flag, das angibt, ob die Erstellung privater Endpunkte automatisch genehmigt oder manuell vom Azure Private Link Center genehmigt werden soll. Bei manueller Genehmigung können Benutzer die ausstehende Anforderung im Portal für private Links anzeigen, um die Anforderung zu genehmigen/abzulehnen. Standardwert: True
|
|
exist_ok
|
Gibt an, ob diese Methode erfolgreich ist, wenn der Arbeitsbereich bereits vorhanden ist. Wenn False, schlägt diese Methode fehl, wenn der Arbeitsbereich vorhanden ist. Wenn True, gibt diese Methode den vorhandenen Arbeitsbereich zurück, falls vorhanden. Standardwert: False
|
|
show_output
|
Gibt an, ob diese Methode den inkrementellen Fortschritt ausgibt. Standardwert: True
|
|
user_assigned_identity_for_cmk_encryption
|
Die Ressourcen-ID der vom Benutzer zugewiesenen Identität, die für den Zugriff auf den Kundenverwaltungsschlüssel verwendet werden muss Standardwert: None
|
|
system_datastores_auth_mode
|
Bestimmt, ob Anmeldeinformationen für die Systemdatenspeicher des Arbeitsbereichs "workspaceblobstore" und "workspacefilestore" verwendet werden sollen. Der Standardwert ist "accessKey", in diesem Fall erstellt der Arbeitsbereich die Systemdatenspeicher mit Anmeldeinformationen. Bei Festlegung auf "Identität" erstellt der Arbeitsbereich die Systemdatenspeicher ohne Anmeldeinformationen. Standardwert: accessKey
|
|
v1_legacy_mode
|
Verhindern der Verwendung des v2-API-Diensts im öffentlichen Azure Resource Manager Standardwert: None
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Das Arbeitsbereichsobjekt. |
Ausnahmen
| Typ | Beschreibung |
|---|---|
|
Wird bei Problemen beim Erstellen des Arbeitsbereichs ausgelöst. |
Hinweise
In diesem ersten Beispiel ist nur eine minimale Spezifikation erforderlich, 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 Vorhandene Azure-Ressourcen mithilfe des Azure-Ressourcen-ID-Formats wiederverwendet werden. Die spezifischen Azure-Ressourcen-IDs können über das Azure-Portal oder SDK abgerufen werden. Dabei wird davon ausgegangen, dass die Ressourcengruppe, das Speicherkonto, der Schlüsseltresor, die App Insights 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 die zugeordneten Ressourcen des Azure Machine Learning Workspace.
delete(delete_dependent_resources=False, no_wait=False)Parameter
| Name | Beschreibung |
|---|---|
|
delete_dependent_resources
|
Gibt an, ob Ressourcen gelöscht werden sollen, die dem Arbeitsbereich zugeordnet sind, z. B. Containerregistrierung, Speicherkonto, Schlüsseltresor und Anwendungserkenntnisse. Der Standardwert ist False. Auf True festgelegt, um diese Ressourcen zu löschen. Standardwert: False
|
|
no_wait
|
Gibt an, ob auf den Abschluss des Arbeitsbereichslöschvorgangs gewartet werden soll. Standardwert: False
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Keine bei erfolgreicher Ausführung; andernfalls wird ein Fehler ausgelöst. |
delete_connection
Löschen einer Verbindung des Arbeitsbereichs.
delete_connection(name)Parameter
| Name | Beschreibung |
|---|---|
|
name
Erforderlich
|
Der eindeutige Name der Verbindung unter dem Arbeitsbereich |
delete_private_endpoint_connection
Löschen Sie die private Endpunktverbindung mit dem Arbeitsbereich.
delete_private_endpoint_connection(private_endpoint_connection_name)Parameter
| Name | Beschreibung |
|---|---|
|
private_endpoint_connection_name
Erforderlich
|
Der eindeutige Name der privaten Endpunktverbindung unter dem Arbeitsbereich |
diagnose_workspace
Diagnostizieren von Problemen beim Einrichten des Arbeitsbereichs.
diagnose_workspace(diagnose_parameters)Parameter
| Name | Beschreibung |
|---|---|
|
diagnose_parameters
Erforderlich
|
<xref:_restclient.models.DiagnoseWorkspaceParameters>
Der Parameter für die Diagnose der Arbeitsbereichsintegrität |
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]
|
Eine Instanz von AzureOperationPoller, die DiagnoseResponseResult zurückgibt |
from_config
Zurückgeben eines Arbeitsbereichsobjekts aus einem vorhandenen Azure Machine Learning Workspace.
Liest die Arbeitsbereichskonfiguration aus einer Datei. Löst eine Ausnahme aus, wenn die Konfigurationsdatei nicht gefunden werden kann.
Die Methode bietet eine einfache Möglichkeit, denselben Arbeitsbereich in mehreren Python-Notizbüchern oder Projekten wiederzuverwenden. Benutzer können die Eigenschaften des Arbeitsbereichs Azure Resource Manager (ARM) mithilfe der write_config Methode speichern und diese Methode verwenden, um denselben Arbeitsbereich in verschiedenen Python-Notizbüchern oder -Projekten zu laden, ohne die Arbeitsbereichs-ARM-Eigenschaften neu einzugeben.
static from_config(path=None, auth=None, _logger=None, _file_name=None)Parameter
| Name | Beschreibung |
|---|---|
|
path
|
Der Pfad zur Konfigurationsdatei oder zum Starten des zu durchsuchenden Verzeichnisses. Der Parameter startet standardmäßig die Suche im aktuellen Verzeichnis. Standardwert: None
|
|
auth
|
Das Authentifizierungsobjekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Wenn keine, werden die standardmäßigen Azure CLI-Anmeldeinformationen verwendet, oder die API fordert Anmeldeinformationen ein. Standardwert: None
|
|
_logger
|
Ermöglicht das Überschreiben des Standardprotokollierers. Standardwert: None
|
|
_file_name
|
Ermöglicht das Überschreiben des Konfigurationsdateinamens, nach dem der Pfad ein Verzeichnispfad ist. Standardwert: None
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Das Arbeitsbereichsobjekt für einen vorhandenen Azure ML Workspace. |
get
Zurückgeben eines Arbeitsbereichsobjekts für einen vorhandenen Azure Machine Learning Workspace.
Löst eine Ausnahme aus, wenn der Arbeitsbereich nicht vorhanden ist oder die erforderlichen Felder einen Arbeitsbereich nicht eindeutig identifizieren.
static get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)Parameter
| Name | Beschreibung |
|---|---|
|
name
Erforderlich
|
Der Name des abzurufenden Arbeitsbereichs. |
|
auth
|
Das Authentifizierungsobjekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Wenn keine, werden die standardmäßigen Azure CLI-Anmeldeinformationen verwendet, oder die API fordert Anmeldeinformationen ein. Standardwert: None
|
|
subscription_id
|
Die zu verwendende Abonnement-ID. Der Parameter ist erforderlich, wenn der Benutzer Zugriff auf mehrere Abonnements hat. Standardwert: None
|
|
resource_group
|
Die zu verwendende Ressourcengruppe. Wenn keine, durchsucht die Methode alle Ressourcengruppen im Abonnement. Standardwert: None
|
|
location
|
Der Arbeitsbereichsspeicherort. Standardwert: None
|
|
cloud
|
Der Name der Zielcloud. Kann eine von "AzureCloud", "AzureChinaCloud" oder "AzureUSGovernment" sein. Wenn keine Cloud angegeben ist, wird "AzureCloud" verwendet. Standardwert: AzureCloud
|
|
id
|
Die ID des Arbeitsbereichs. Standardwert: None
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Das Arbeitsbereichsobjekt. |
get_connection
Ruft eine Verbindung des Arbeitsbereichs ab.
get_connection(name)Parameter
| Name | Beschreibung |
|---|---|
|
name
Erforderlich
|
Der eindeutige Name der Verbindung unter dem Arbeitsbereich |
get_default_compute_target
Rufen Sie das Standardmäßige Computeziel für den Arbeitsbereich ab.
get_default_compute_target(type)Parameter
| Name | Beschreibung |
|---|---|
|
type
Erforderlich
|
Der Computetyp. Mögliche Werte sind "CPU" oder "GPU". |
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Das Standardmäßige Computeziel für den angegebenen Computetyp. |
get_default_datastore
Rufen Sie den Standarddatenspeicher für den Arbeitsbereich ab.
get_default_datastore()Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Der Standarddatenspeicher. |
get_default_keyvault
Rufen Sie das Standardschlüsseltresorobjekt für den Arbeitsbereich ab.
get_default_keyvault()Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Das keyVault-Objekt, das dem Arbeitsbereich zugeordnet ist. |
get_details
Geben Sie die Details des Arbeitsbereichs zurück.
get_details()Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Arbeitsbereichsdetails im Wörterbuchformat. |
Hinweise
Das zurückgegebene Wörterbuch enthält die folgenden Schlüsselwertpaare.
ID: URI, der auf diese Arbeitsbereichsressource verweist, die Abonnement-ID, Ressourcengruppe und Arbeitsbereichsname enthält.
name: Der Name dieses Arbeitsbereichs.
location: The workspace region.
type: A URI of the format "{providerName}/workspaces".
Tags: Zurzeit nicht verwendet.
workspaceid: Die ID dieses Arbeitsbereichs.
beschreibung: Zurzeit nicht verwendet.
friendlyName: Ein Anzeigename für den Arbeitsbereich, der in der Benutzeroberfläche angezeigt wird.
creationTime: Zeitpunkt, zu dem dieser Arbeitsbereich erstellt wurde, im ISO8601 Format.
containerRegistry: Die Arbeitsbereichscontainerregistrierung, die zum Abrufen und Übertragen von Experiment- und Webservices-Images verwendet wird.
keyVault: Der Arbeitsbereichsschlüsseltresor, der zum Speichern von Anmeldeinformationen verwendet wird, die den Benutzern zum Arbeitsbereich hinzugefügt wurden.
applicationInsights: Application Insights wird vom Arbeitsbereich zum Protokollieren von Webservices-Ereignissen verwendet.
identityPrincipalId:
identityTenantId
identityType
storageAccount: Der Speicher wird vom Arbeitsbereich zum Speichern von Ausführungsausgaben, Code, Protokollen usw. verwendet.
sku: Die Arbeitsbereichs-SKU (auch als Edition bezeichnet). Der Parameter ist zur Abwärtskompatibilität vorhanden und wird ignoriert.
resourceCmkUri: Der Schlüssel-URI des vom Kunden verwalteten Schlüssels zum Verschlüsseln der ruhenden Daten. https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 Weitere Informationen zum Erstellen eines Schlüssels und zum Abrufen des URI finden Sie in den Schritten.
hbiWorkspace: Gibt an, ob die Kundendaten einen hohen geschäftlichen Einfluss haben.
imageBuildCompute: Das Computeziel für den Imagebuild.
systemDatastoresAuthMode: Bestimmt, ob Anmeldeinformationen für die Systemdatenspeicher des Arbeitsbereichs 'workspaceblobstore' und 'workspacefilestore' verwendet werden sollen. Der Standardwert ist "accessKey", in diesem Fall erstellt der Arbeitsbereich die Systemdatenspeicher mit Anmeldeinformationen. Bei Festlegung auf "Identität" erstellt der Arbeitsbereich die Systemdatenspeicher ohne Anmeldeinformationen.
Weitere Informationen zu diesen Schlüsselwertpaaren finden Sie unter create.
get_mlflow_tracking_uri
Rufen Sie den MLflow-Tracking-URI für den Arbeitsbereich ab.
MLflow (https://mlflow.org/) ist eine Open-Source-Plattform zum Nachverfolgen von Machine Learning-Experimenten und Zum 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
| Name | Beschreibung |
|---|---|
|
_with_auth
|
(VERALTET) Fügen Sie Authentifizierungsinformationen zum Nachverfolgen des URI hinzu. Standardwert: False
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Der MLflow-kompatible Tracking-URI. |
Hinweise
Verwenden Sie das folgende Beispiel, um die MLflow-Nachverfolgung so zu konfigurieren, dass Daten an den Azure ML-Arbeitsbereich gesendet werden:
import mlflow
from azureml.core import Workspace
workspace = Workspace.from_config()
mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())
get_run
list
Listet alle Arbeitsbereiche auf, auf die der Benutzer innerhalb des Abonnements zugreifen kann.
Die Liste der Arbeitsbereiche kann basierend auf der Ressourcengruppe gefiltert werden.
static list(subscription_id, auth=None, resource_group=None)Parameter
| Name | Beschreibung |
|---|---|
|
subscription_id
Erforderlich
|
Die Abonnement-ID, für die Arbeitsbereiche aufgeführt werden sollen. |
|
auth
|
Das Authentifizierungsobjekt. Weitere Informationen finden Sie unter https://aka.ms/aml-notebook-auth. Wenn keine, werden die standardmäßigen Azure CLI-Anmeldeinformationen verwendet, oder die API fordert Anmeldeinformationen ein. Standardwert: None
|
|
resource_group
|
Eine Ressourcengruppe zum Filtern der zurückgegebenen Arbeitsbereiche. If None, the method will list all the workspaces within the specified subscription. Standardwert: None
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Wörterbuch, bei dem der Schlüssel arbeitsbereichsname ist und der Wert eine Liste von Arbeitsbereichsobjekten ist. |
list_connections
Listen Sie Verbindungen unter diesem Arbeitsbereich auf.
list_connections(category=None, target=None)Parameter
| Name | Beschreibung |
|---|---|
|
type
Erforderlich
|
Der Typ dieser Verbindung, nach der gefiltert wird |
|
target
|
das Ziel dieser Verbindung, nach der gefiltert wird Standardwert: None
|
|
category
|
Standardwert: None
|
list_keys
set_connection
Hinzufügen oder Aktualisieren einer Verbindung unter dem Arbeitsbereich.
set_connection(name, category, target, authType, value)Parameter
| Name | Beschreibung |
|---|---|
|
name
Erforderlich
|
Der eindeutige Name der Verbindung unter dem Arbeitsbereich |
|
category
Erforderlich
|
Die Kategorie dieser Verbindung |
|
target
Erforderlich
|
das Ziel, mit dem diese Verbindung verbunden ist |
|
authType
Erforderlich
|
der Autorisierungstyp dieser Verbindung |
|
value
Erforderlich
|
die JSON-Format serialisierungszeichenfolge der Verbindungsdetails |
set_default_datastore
setup
Erstellen Sie einen neuen Arbeitsbereich, oder rufen Sie einen vorhandenen Arbeitsbereich ab.
static setup()Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Workspace-Objekt. |
sync_keys
Löst den Arbeitsbereich aus, um die Tasten sofort zu synchronisieren.
Wenn Schlüssel für eine Ressource im Arbeitsbereich geändert werden, kann es etwa eine Stunde dauern, bis sie automatisch aktualisiert werden. Mit dieser Funktion können Schlüssel auf Anfrage aktualisiert werden. Ein Beispielszenario benötigt unmittelbaren Zugriff auf den Speicher nach der Neugenerierung von Speicherschlüsseln.
sync_keys(no_wait=False)Parameter
| Name | Beschreibung |
|---|---|
|
no_wait
|
Gibt an, ob auf den Abschluss der Arbeitsbereichssynchronisierungsschlüssel gewartet werden soll. Standardwert: False
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Keine bei erfolgreicher Ausführung; andernfalls wird ein Fehler ausgelöst. |
update
Aktualisieren Sie Anzeigename, Beschreibung, Tags, Bildbuild-Compute und andere Einstellungen, die einem Arbeitsbereich zugeordnet sind.
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
| Name | Beschreibung |
|---|---|
|
friendly_name
|
Ein Anzeigename für den Arbeitsbereich, der in der Benutzeroberfläche angezeigt werden kann. Standardwert: None
|
|
description
|
Eine Beschreibung des Arbeitsbereichs. Standardwert: None
|
|
tags
|
Tags, die dem Arbeitsbereich zugeordnet werden sollen. Standardwert: None
|
|
image_build_compute
|
Der Computename für den Imagebuild. Standardwert: None
|
|
service_managed_resources_settings
|
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
Die Einstellungen für verwaltete Ressourcen des Diensts. Standardwert: None
|
|
primary_user_assigned_identity
|
Die Vom Benutzer zugewiesene Identitätsressourcen-ID, die die Arbeitsbereichsidentität darstellt. Standardwert: None
|
|
allow_public_access_when_behind_vnet
|
Zulassen des öffentlichen Zugriffs auf den Arbeitsbereich für private Links. Standardwert: None
|
|
v1_legacy_mode
|
Verhindern der Verwendung des v2-API-Diensts im öffentlichen Azure Resource Manager Standardwert: None
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Wörterbuch mit aktualisierten Informationen. |
update_dependencies
Aktualisieren Sie die zugeordneten Ressourcen für den Arbeitsbereich in den folgenden Fällen.
a) Wenn ein Benutzer versehentlich eine vorhandene zugeordnete Ressource löscht und sie mit einem neuen 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 aktuelle Ressource ersetzen möchte, die dem Arbeitsbereich zugeordnet ist. c) Wenn eine zugeordnete Ressource noch nicht erstellt wurde und sie eine vorhandene Ressource verwenden möchten, die sie bereits besitzen (gilt nur für die Containerregistrierung).
update_dependencies(container_registry=None, force=False)Parameter
| Name | Beschreibung |
|---|---|
|
container_registry
|
ARM-ID für die Containerregistrierung. Standardwert: None
|
|
force
|
Wenn sie die Aktualisierung abhängiger Ressourcen erzwingen, ohne dass eine Bestätigung angezeigt wird. Standardwert: False
|
Gibt zurück
| Typ | Beschreibung |
|---|---|
write_config
Schreiben Sie die Arbeitsbereichseigenschaften des Azure Resource Manager (ARM) in eine Konfigurationsdatei.
Arbeitsbereich ARM-Eigenschaften können später mithilfe der from_config Methode geladen werden. Die path Standardwerte sind ".azureml/" im aktuellen Arbeitsverzeichnis und file_name standardmäßig auf "config.json".
Die Methode bietet eine einfache Möglichkeit, denselben Arbeitsbereich in mehreren Python-Notizbüchern oder Projekten wiederzuverwenden. Benutzer können die Arbeitsbereichs-ARM-Eigenschaften mithilfe dieser Funktion speichern und from_config verwenden, um denselben Arbeitsbereich in verschiedenen Python-Notizbüchern oder -Projekten zu laden, ohne die Arbeitsbereichs-ARM-Eigenschaften neu einzugeben.
write_config(path=None, file_name=None)Parameter
| Name | Beschreibung |
|---|---|
|
path
|
Der vom Benutzer bereitgestellte Speicherort zum Schreiben der config.json Datei. Der Parameter ist standardmäßig auf ".azureml/" im aktuellen Arbeitsverzeichnis festgelegt. Standardwert: None
|
|
file_name
|
Name, der für die Konfigurationsdatei verwendet werden soll. Der Parameter ist standardmäßig auf config.jsonfestgelegt. Standardwert: None
|
Attribute
compute_targets
Listet alle Computeziele im Arbeitsbereich auf.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Wörterbuch mit Schlüssel als Computezielname und -wert als ComputeTarget Objekt. |
datasets
datastores
discovery_url
Gibt die Ermittlungs-URL dieses Arbeitsbereichs zurück.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Die Ermittlungs-URL dieses Arbeitsbereichs. |
environments
Listet alle Umgebungen im Arbeitsbereich auf.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Wörterbuch mit Schlüssel als Umgebungsname und Wert als Environment Objekt. |
experiments
Listet alle Experimente im Arbeitsbereich auf.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Wörterbuch mit Schlüssel als Experimentname und Wert als Experiment Objekt. |
images
Gibt die Liste der Bilder im Arbeitsbereich zurück.
Löst ein WebserviceException Problem aus, das mit dem Modellverwaltungsdienst interagiert.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Wörterbuch mit Schlüssel als Bildname und Wert als Image Objekt. |
Ausnahmen
| Typ | Beschreibung |
|---|---|
|
Es gab ein Problem bei der Interaktion mit dem Modellverwaltungsdienst. |
linked_services
Listet alle verknüpften Dienste im Arbeitsbereich auf.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Wörterbuch, bei dem der Schlüssel ein verknüpfter Dienstname und -wert ist, ist ein LinkedService Objekt. |
location
Gibt den Speicherort dieses Arbeitsbereichs zurück.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Der Speicherort dieses Arbeitsbereichs. |
models
Gibt eine Liste des Modells im Arbeitsbereich zurück.
Löst ein WebserviceException Problem aus, das mit dem Modellverwaltungsdienst interagiert.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Wörterbuch des Modells mit Schlüssel als Modellname und Wert als Model Objekt. |
Ausnahmen
| Typ | Beschreibung |
|---|---|
|
Es gab ein Problem bei der Interaktion mit dem Modellverwaltungsdienst. |
name
Geben Sie den Arbeitsbereichsnamen zurück.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Der Arbeitsbereichsname. |
private_endpoints
Listet alle privaten Endpunkte des Arbeitsbereichs auf.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Ein Diktat von PrivateEndPoint-Objekten, die dem Arbeitsbereich zugeordnet sind. Der Schlüssel ist der Name des privaten Endpunkts. |
resource_group
Geben Sie den Ressourcengruppennamen für diesen Arbeitsbereich zurück.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Der Ressourcengruppenname. |
service_context
Gibt den Dienstkontext für diesen Arbeitsbereich zurück.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
<xref:azureml._restclient.service_context.ServiceContext>
|
Gibt das ServiceContext -Objekt zurück. |
sku
Gibt die SKU dieses Arbeitsbereichs zurück.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Die SKU dieses Arbeitsbereichs. |
subscription_id
Gibt die Abonnement-ID für diesen Arbeitsbereich zurück.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Die Abonnement-ID. |
tags
Gibt die Tags dieses Arbeitsbereichs zurück.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Die Tags dieses Arbeitsbereichs. |
webservices
Gibt eine Liste der Webservices im Arbeitsbereich zurück.
Löst ein WebserviceException Problem beim Zurückgeben der Liste aus.
Gibt zurück
| Typ | Beschreibung |
|---|---|
|
Eine Liste der Webservices im Arbeitsbereich. |
Ausnahmen
| Typ | Beschreibung |
|---|---|
|
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'