Workspace Klasa

  • Odwołanie

Definiuje zasób usługi Azure Machine Learning do zarządzania artefaktami trenowania i wdrażania.

Obszar roboczy to podstawowy zasób uczenia maszynowego w usłudze Azure Machine Learning. Obszar roboczy służy do eksperymentowania, trenowania i wdrażania modeli uczenia maszynowego. Każdy obszar roboczy jest powiązany z subskrypcją platformy Azure i grupą zasobów oraz ma skojarzona jednostkę SKU.

Aby uzyskać więcej informacji na temat obszarów roboczych, zobacz:

Konstruktor obszaru roboczego klasy w celu załadowania istniejącego obszaru roboczego usługi Azure Machine Learning.

Dziedziczenie
builtins.object
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')

Parametry

Nazwa Opis
subscription_id
Wymagane
str

Identyfikator subskrypcji platformy Azure zawierający obszar roboczy.
resource_group
Wymagane
str

Grupa zasobów zawierająca obszar roboczy.
workspace_name
Wymagane
str

Nazwa istniejącego obszaru roboczego.
auth
ServicePrincipalAuthentication lub InteractiveLoginAuthentication lub MsiAuthentication

Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń.

wartość domyślna: None
_location
str

Tylko do użytku wewnętrznego.

wartość domyślna: None
_disable_service_check
bool

Tylko do użytku wewnętrznego.

wartość domyślna: False
_workspace_id
str

Tylko do użytku wewnętrznego.

wartość domyślna: None
sku
str

Parametr jest obecny dla zgodności z poprzednimi wersjami i jest ignorowany.

wartość domyślna: basic
_cloud
str

Tylko do użytku wewnętrznego.

wartość domyślna: AzureCloud
subscription_id
Wymagane
str

Identyfikator subskrypcji platformy Azure zawierający obszar roboczy.
resource_group
Wymagane
str

Grupa zasobów zawierająca obszar roboczy.
workspace_name
Wymagane
str

Nazwa obszaru roboczego. Nazwa musi mieć długość od 2 do 32 znaków. Pierwszy znak nazwy musi być alfanumeryczny (litera lub cyfra), ale reszta nazwy może zawierać alfanumeryczne, łączniki i podkreślenia. Białe znaki są niedozwolone.
auth
Wymagane
ServicePrincipalAuthentication lub InteractiveLoginAuthentication lub MsiAuthentication

Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń.
_location
Wymagane
str

Tylko do użytku wewnętrznego.
_disable_service_check
Wymagane
bool

Tylko do użytku wewnętrznego.
_workspace_id
Wymagane
str

Tylko do użytku wewnętrznego.
sku
Wymagane
str

Parametr jest obecny dla zgodności z poprzednimi wersjami i jest ignorowany.
tags
dict

Tagi do skojarzenia z obszarem roboczym.

wartość domyślna: None
_cloud
Wymagane
str

Tylko do użytku wewnętrznego.

Uwagi

W poniższym przykładzie pokazano, jak utworzyć obszar roboczy.


   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
               subscription_id='<azure-subscription-id>',
               resource_group='myresourcegroup',
               create_resource_group=True,
               location='eastus2'
               )

Ustaw create_resource_group wartość Fałsz, jeśli masz istniejącą grupę zasobów platformy Azure, której chcesz użyć dla obszaru roboczego.

Aby użyć tego samego obszaru roboczego w wielu środowiskach, utwórz plik konfiguracji JSON. Plik konfiguracji zapisuje nazwę subskrypcji, zasobu i obszaru roboczego, aby można je było łatwo załadować. Aby zapisać konfigurację, użyj write_config metody .


   ws.write_config(path="./file-path", file_name="ws_config.json")

Zobacz Tworzenie pliku konfiguracji obszaru roboczego , aby zapoznać się z przykładem pliku konfiguracji.

Aby załadować obszar roboczy z pliku konfiguracji, użyj from_config metody .


   ws = Workspace.from_config()
   ws.get_details()

Możesz też użyć get metody , aby załadować istniejący obszar roboczy bez używania plików konfiguracji.


   ws = Workspace.get(name="myworkspace",
               subscription_id='<azure-subscription-id>',
               resource_group='myresourcegroup')

Powyższe przykłady mogą wyświetlić monit o podanie poświadczeń uwierzytelniania platformy Azure przy użyciu interaktywnego okna dialogowego logowania. Inne przypadki użycia, w tym używanie interfejsu wiersza polecenia platformy Azure do uwierzytelniania i uwierzytelniania w zautomatyzowanych przepływach pracy, można znaleźć w temacie Authentication in Azure Machine Learning (Uwierzytelnianie w usłudze Azure Machine Learning).

Metody

add_private_endpoint

Dodaj prywatny punkt końcowy do obszaru roboczego.
create

Utwórz nowy obszar roboczy usługi Azure Machine Learning.

Zgłasza wyjątek, jeśli obszar roboczy już istnieje lub którekolwiek z wymagań obszaru roboczego nie są spełnione.
delete

Usuń skojarzone zasoby obszaru roboczego usługi Azure Machine Learning.
delete_connection

Usuń połączenie obszaru roboczego.
delete_private_endpoint_connection

Usuń połączenie prywatnego punktu końcowego z obszarem roboczym.
diagnose_workspace

Diagnozowanie problemów z konfiguracją obszaru roboczego.
from_config

Zwróć obiekt obszaru roboczego z istniejącego obszaru roboczego usługi Azure Machine Learning.

Odczytuje konfigurację obszaru roboczego z pliku. Zgłasza wyjątek, jeśli nie można odnaleźć pliku konfiguracji.

Metoda zapewnia prosty sposób ponownego użycia tego samego obszaru roboczego w wielu notesach lub projektach języka Python. Użytkownicy mogą zapisywać właściwości obszaru roboczego usługi Azure Resource Manager (ARM) przy użyciu write_config metody i użyć tej metody do załadowania tego samego obszaru roboczego w różnych notesach lub projektach języka Python bez ponownego pisania właściwości usługi ARM obszaru roboczego.
get

Zwróć obiekt obszaru roboczego dla istniejącego obszaru roboczego usługi Azure Machine Learning.

Zgłasza wyjątek, jeśli obszar roboczy nie istnieje lub wymagane pola nie identyfikują jednoznacznie obszaru roboczego.
get_connection

Uzyskiwanie połączenia z obszarem roboczym.
get_default_compute_target

Pobierz domyślny docelowy obiekt obliczeniowy dla obszaru roboczego.
get_default_datastore

Pobierz domyślny magazyn danych dla obszaru roboczego.
get_default_keyvault

Pobierz domyślny obiekt magazynu kluczy dla obszaru roboczego.
get_details

Zwróć szczegóły obszaru roboczego.
get_mlflow_tracking_uri

Pobierz identyfikator URI śledzenia MLflow dla obszaru roboczego.

MLflow (https://mlflow.org/) to platforma typu open source do śledzenia eksperymentów uczenia maszynowego i zarządzania modelami. Interfejsy API rejestrowania MLflow można używać z usługą Azure Machine Learning, aby metryki, modele i artefakty zostały zarejestrowane w obszarze roboczym usługi Azure Machine Learning.
get_run

Zwróć przebieg z określonym run_id w obszarze roboczym.
list

Wyświetl listę wszystkich obszarów roboczych, do których użytkownik ma dostęp w ramach subskrypcji.

Listę obszarów roboczych można filtrować na podstawie grupy zasobów.
list_connections

Wyświetl listę połączeń w tym obszarze roboczym.
list_keys

Wyświetl listę kluczy dla bieżącego obszaru roboczego.
set_connection

Dodaj lub zaktualizuj połączenie w obszarze roboczym.
set_default_datastore

Ustaw domyślny magazyn danych dla obszaru roboczego.
setup

Utwórz nowy obszar roboczy lub pobierz istniejący obszar roboczy.
sync_keys

Wyzwala obszar roboczy, aby natychmiast zsynchronizować klucze.

Jeśli klucze dla dowolnego zasobu w obszarze roboczym zostaną zmienione, może upłynąć około godziny, aby mogły zostać automatycznie zaktualizowane. Ta funkcja umożliwia aktualizowanie kluczy po żądaniu. Przykładowy scenariusz wymaga natychmiastowego dostępu do magazynu po wygenerowaniu kluczy magazynu.
update

Zaktualizuj przyjazną nazwę, opis, tagi, obliczenia kompilacji obrazu i inne ustawienia skojarzone z obszarem roboczym.
update_dependencies

Zaktualizuj istniejące skojarzone zasoby dla obszaru roboczego w następujących przypadkach.

a) Gdy użytkownik przypadkowo usunie istniejący skojarzony zasób i chce zaktualizować go przy użyciu nowego bez konieczności ponownego tworzenia całego obszaru roboczego. b) Gdy użytkownik ma istniejący skojarzony zasób i chce zastąpić bieżący, skojarzony z obszarem roboczym. c) Jeśli skojarzony zasób nie został jeszcze utworzony i chce użyć istniejącego, który już ma (dotyczy tylko rejestru kontenerów).
write_config

Zapisz właściwości usługi Azure Resource Manager (ARM) obszaru roboczego w pliku konfiguracji.

Właściwości usługi ARM obszaru roboczego from_config można załadować później przy użyciu metody . Wartość domyślna path to ".azureml/" w bieżącym katalogu roboczym i file_name wartość domyślna to "config.json".

Metoda umożliwia proste ponowne użycie tego samego obszaru roboczego w wielu notesach lub projektach języka Python. Użytkownicy mogą zapisywać właściwości usługi ARM obszaru roboczego przy użyciu tej funkcji i używać from_config do ładowania tego samego obszaru roboczego w różnych notesach lub projektach języka Python bez ponownego pisania właściwości usługi ARM obszaru roboczego.

add_private_endpoint

Dodaj prywatny punkt końcowy do obszaru roboczego.

add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)

Parametry

Nazwa Opis
private_endpoint_config
Wymagane
PrivateEndPointConfig

Konfiguracja prywatnego punktu końcowego w celu utworzenia prywatnego punktu końcowego w obszarze roboczym.
private_endpoint_auto_approval
bool

Flaga logiczna określająca, czy tworzenie prywatnego punktu końcowego powinno zostać automatycznie zatwierdzone lub zatwierdzone ręcznie z centrum Azure Private Link. W przypadku ręcznego zatwierdzania użytkownicy mogą wyświetlać oczekujące żądanie w portalu Private Link, aby zatwierdzić/odrzucić żądanie.

wartość domyślna: True
location
string

Lokalizacja prywatnego punktu końcowego, wartość domyślna to lokalizacja obszaru roboczego

wartość domyślna: None
show_output
bool

Flaga przedstawiająca postęp tworzenia obszaru roboczego

wartość domyślna: True
tags
dict

Tagi do skojarzenia z obszarem roboczym.

wartość domyślna: None

Zwraca

Typ Opis
PrivateEndPoint

Utworzony obiekt PrivateEndPoint.

create

Utwórz nowy obszar roboczy usługi Azure Machine Learning.

Zgłasza wyjątek, jeśli obszar roboczy już istnieje lub którekolwiek z wymagań obszaru roboczego nie są spełnione.

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)

Parametry

Nazwa Opis
name
Wymagane
str

Nazwa nowego obszaru roboczego. Nazwa musi mieć długość od 2 do 32 znaków. Pierwszy znak nazwy musi być alfanumeryczny (litera lub cyfra), ale reszta nazwy może zawierać alfanumeryczne, łączniki i podkreślenia. Odstęp jest niedozwolony.
auth
ServicePrincipalAuthentication lub InteractiveLoginAuthentication

Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o poświadczenia.

wartość domyślna: None
subscription_id
str

Identyfikator subskrypcji zawierającej subskrypcję dla nowego obszaru roboczego. Parametr jest wymagany, jeśli użytkownik ma dostęp do więcej niż jednej subskrypcji.

wartość domyślna: None
resource_group
str

Grupa zasobów platformy Azure zawierająca obszar roboczy. Parametr domyślnie określa mutację nazwy obszaru roboczego.

wartość domyślna: None
location
str

Lokalizacja obszaru roboczego. Parametr jest domyślnie ustawiony na lokalizację grupy zasobów. Lokalizacja musi być obsługiwanym regionem usługi Azure Machine Learning.

wartość domyślna: None
create_resource_group
bool

Wskazuje, czy należy utworzyć grupę zasobów, jeśli nie istnieje.

wartość domyślna: True
sku
str

Parametr jest obecny dla zgodności z poprzednimi wersjami i jest ignorowany.

wartość domyślna: basic
tags
dict

Tagi do skojarzenia z obszarem roboczym.

wartość domyślna: None
friendly_name
str

Opcjonalna przyjazna nazwa obszaru roboczego, który można wyświetlić w interfejsie użytkownika.

wartość domyślna: None
storage_account
str

Istniejące konto magazynu w formacie identyfikatora zasobu platformy Azure. Magazyn będzie używany przez obszar roboczy do zapisywania danych wyjściowych uruchamiania, kodu, dzienników itp. Jeśli brak, zostanie utworzone nowe konto magazynu.

wartość domyślna: None
key_vault
str

Istniejący magazyn kluczy w formacie identyfikatora zasobu platformy Azure. Zobacz przykładowy kod poniżej, aby uzyskać szczegółowe informacje o formacie identyfikatora zasobu platformy Azure. Magazyn kluczy będzie używany przez obszar roboczy do przechowywania poświadczeń dodanych do obszaru roboczego przez użytkowników. Jeśli brak, zostanie utworzony nowy magazyn kluczy.

wartość domyślna: None
app_insights
str

Istniejąca usługa Application Insights w formacie identyfikatora zasobu platformy Azure. Zobacz przykładowy kod poniżej, aby uzyskać szczegółowe informacje o formacie identyfikatora zasobu platformy Azure. Usługa Application Insights będzie używana przez obszar roboczy do rejestrowania zdarzeń usług internetowych. Jeśli brak, zostanie utworzona nowa usługa Application Insights.

wartość domyślna: None
container_registry
str

Istniejący rejestr kontenerów w formacie identyfikatora zasobu platformy Azure (zobacz przykładowy kod poniżej, aby uzyskać szczegółowe informacje o formacie identyfikatora zasobu platformy Azure). Rejestr kontenerów będzie używany przez obszar roboczy do ściągania i wypychania obrazów eksperymentowania i usług internetowych. Jeśli brak, nowy rejestr kontenerów zostanie utworzony tylko wtedy, gdy jest to konieczne, a nie wraz z tworzeniem obszaru roboczego.

wartość domyślna: None
adb_workspace
str

Istniejący obszar roboczy usługi Adb w formacie identyfikatora zasobu platformy Azure (zobacz przykładowy kod poniżej, aby uzyskać szczegółowe informacje o formacie identyfikatora zasobu platformy Azure). Obszar roboczy usługi Adb będzie używany do łączenia z obszarem roboczym. Jeśli brak, link obszaru roboczego nie zostanie wyświetlony.

wartość domyślna: None
primary_user_assigned_identity
str

Identyfikator zasobu tożsamości przypisanej przez użytkownika, która była używana do reprezentowania obszaru roboczego

wartość domyślna: None
cmk_keyvault
str

Magazyn kluczy zawierający klucz zarządzany przez klienta w formacie identyfikatora zasobu platformy Azure:/subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Na przykład: "/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault" Zobacz przykładowy kod w uwagach poniżej, aby uzyskać więcej informacji na temat formatu identyfikatora zasobu platformy Azure.

wartość domyślna: None
resource_cmk_uri
str

Identyfikator URI klucza zarządzanego przez klienta w celu zaszyfrowania danych magazynowanych. Format identyfikatora URI to: https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Na przykład "https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b". Zapoznaj się z https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal instrukcjami dotyczącymi tworzenia klucza i uzyskiwania identyfikatora URI.

wartość domyślna: None
hbi_workspace
bool

Określa, czy obszar roboczy zawiera dane o wysokim wpływie biznesowym (HBI), tj. zawiera poufne informacje biznesowe. Tę flagę można ustawić tylko podczas tworzenia obszaru roboczego. Nie można zmienić jego wartości po utworzeniu obszaru roboczego. Wartość domyślna to False.

Po ustawieniu wartości True są wykonywane dalsze kroki szyfrowania, a w zależności od składnika zestawu SDK wyniki są redagowane w wewnętrznie zebranych danych telemetrycznych. Aby uzyskać więcej informacji, zobacz Szyfrowanie danych.

Gdy ta flaga ma wartość True, jednym z możliwych skutków jest zwiększenie trudności z rozwiązywaniem problemów. Może się to zdarzyć, ponieważ niektóre dane telemetryczne nie są wysyłane do firmy Microsoft i nie ma mniejszego wglądu w współczynniki powodzenia lub typy problemów, a zatem może nie być w stanie reagować tak aktywnie, gdy ta flaga ma wartość True. Zalecenie jest używane jako wartość domyślna False dla tej flagi, chyba że jest to ściśle wymagane do wartości True.

wartość domyślna: False
default_cpu_compute_target
AmlComputeProvisioningConfiguration

(PRZESTARZAŁE) Konfiguracja, która zostanie użyta do utworzenia zasobów obliczeniowych procesora CPU. Domyślnie parametr {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} If None, nie zostaną utworzone żadne obliczenia.

wartość domyślna: None
default_gpu_compute_target
AmlComputeProvisioningConfiguration

(PRZESTARZAŁE) Konfiguracja, która zostanie użyta do utworzenia obliczeń procesora GPU. Domyślnie parametr {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} If None, nie zostaną utworzone żadne obliczenia.

wartość domyślna: None
private_endpoint_config
PrivateEndPointConfig

Konfiguracja prywatnego punktu końcowego w celu utworzenia prywatnego punktu końcowego w obszarze roboczym usługi Azure ML.

wartość domyślna: None
private_endpoint_auto_approval
bool

Flaga logiczna określająca, czy tworzenie prywatnego punktu końcowego powinno zostać automatycznie zatwierdzone lub zatwierdzone ręcznie z centrum Azure Private Link. W przypadku ręcznego zatwierdzania użytkownicy mogą wyświetlać oczekujące żądanie w portalu Private Link, aby zatwierdzić/odrzucić żądanie.

wartość domyślna: True
exist_ok
bool

Wskazuje, czy ta metoda powiedzie się, jeśli obszar roboczy już istnieje. Jeśli fałsz, ta metoda zakończy się niepowodzeniem, jeśli obszar roboczy istnieje. Jeśli wartość True, ta metoda zwraca istniejący obszar roboczy, jeśli istnieje.

wartość domyślna: False
show_output
bool

Wskazuje, czy ta metoda wyświetli postęp przyrostowy.

wartość domyślna: True
user_assigned_identity_for_cmk_encryption
str

Identyfikator zasobu tożsamości przypisanej przez użytkownika, która musi być używana do uzyskiwania dostępu do klucza zarządzania klientem

wartość domyślna: None
system_datastores_auth_mode
str

Określa, czy należy używać poświadczeń dla systemowych magazynów danych obszaru roboczego "workspaceblobstore" i "workspacefilestore". Wartość domyślna to "accessKey", w tym przypadku obszar roboczy utworzy systemowe magazyny danych z poświadczeniami. Jeśli zostanie ustawiona wartość "identity", obszar roboczy utworzy systemowe magazyny danych bez poświadczeń.

wartość domyślna: accessKey
v1_legacy_mode
bool

Zapobieganie używaniu usługi interfejsu API w wersji 2 w publicznej usłudze Azure Resource Manager

wartość domyślna: None

Zwraca

Typ Opis
Workspace

Obiekt obszaru roboczego.

Wyjątki

Typ Opis
WorkspaceException

Zgłoszone w przypadku problemów z tworzeniem obszaru roboczego.

Uwagi

Ten pierwszy przykład wymaga tylko minimalnej specyfikacji, a wszystkie zasoby zależne, a także grupa zasobów zostaną utworzone automatycznie.


   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=True,
                         location='eastus2')

W poniższym przykładzie pokazano, jak używać istniejących zasobów platformy Azure przy użyciu formatu identyfikatora zasobu platformy Azure. Określone identyfikatory zasobów platformy Azure można pobrać za pośrednictwem witryny Azure Portal lub zestawu SDK. Przyjęto założenie, że grupa zasobów, konto magazynu, magazyn kluczy, usługa App Insights i rejestr kontenerów już istnieją.


   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

Usuń skojarzone zasoby obszaru roboczego usługi Azure Machine Learning.

delete(delete_dependent_resources=False, no_wait=False)

Parametry

Nazwa Opis
delete_dependent_resources
bool

Czy usunąć zasoby skojarzone z obszarem roboczym, tj. rejestr kontenerów, konto magazynu, magazyn kluczy i usługa Application Insights. Wartość domyślna to False. Ustaw wartość True, aby usunąć te zasoby.

wartość domyślna: False
no_wait
bool

Czy poczekać na zakończenie usuwania obszaru roboczego.

wartość domyślna: False

Zwraca

Typ Opis
None

Brak, jeśli się powiedzie; w przeciwnym razie zgłasza błąd.

delete_connection

Usuń połączenie obszaru roboczego.

delete_connection(name)

Parametry

Nazwa Opis
name
Wymagane
str

Unikatowa nazwa połączenia w obszarze roboczym

delete_private_endpoint_connection

Usuń połączenie prywatnego punktu końcowego z obszarem roboczym.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parametry

Nazwa Opis
private_endpoint_connection_name
Wymagane
str

Unikatowa nazwa połączenia prywatnego punktu końcowego w obszarze roboczym

diagnose_workspace

Diagnozowanie problemów z konfiguracją obszaru roboczego.

diagnose_workspace(diagnose_parameters)

Parametry

Nazwa Opis
diagnose_parameters
Wymagane
<xref:_restclient.models.DiagnoseWorkspaceParameters>

Parametr diagnozowania kondycji obszaru roboczego

Zwraca

Typ Opis
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]

Wystąpienie klasy AzureOperationPoller zwracające polecenie DiagnoseResponseResult

from_config

Zwróć obiekt obszaru roboczego z istniejącego obszaru roboczego usługi Azure Machine Learning.

Odczytuje konfigurację obszaru roboczego z pliku. Zgłasza wyjątek, jeśli nie można odnaleźć pliku konfiguracji.

Metoda zapewnia prosty sposób ponownego użycia tego samego obszaru roboczego w wielu notesach lub projektach języka Python. Użytkownicy mogą zapisywać właściwości obszaru roboczego usługi Azure Resource Manager (ARM) przy użyciu write_config metody i użyć tej metody do załadowania tego samego obszaru roboczego w różnych notesach lub projektach języka Python bez ponownego pisania właściwości usługi ARM obszaru roboczego.

static from_config(path=None, auth=None, _logger=None, _file_name=None)

Parametry

Nazwa Opis
path
str

Ścieżka do pliku konfiguracji lub początkowego katalogu do wyszukania. Parametr domyślnie uruchamia wyszukiwanie w bieżącym katalogu.

wartość domyślna: None
auth
ServicePrincipalAuthentication lub InteractiveLoginAuthentication

Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o poświadczenia.

wartość domyślna: None
_logger
Logger

Umożliwia zastąpienie domyślnego rejestratora.

wartość domyślna: None
_file_name
str

Umożliwia zastąpienie nazwy pliku konfiguracji do wyszukiwania, gdy ścieżka jest ścieżką katalogu.

wartość domyślna: None

Zwraca

Typ Opis
Workspace

Obiekt obszaru roboczego dla istniejącego obszaru roboczego usługi Azure ML.

get

Zwróć obiekt obszaru roboczego dla istniejącego obszaru roboczego usługi Azure Machine Learning.

Zgłasza wyjątek, jeśli obszar roboczy nie istnieje lub wymagane pola nie identyfikują jednoznacznie obszaru roboczego.

static get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)

Parametry

Nazwa Opis
name
Wymagane
str

Nazwa obszaru roboczego do pobrania.
auth
ServicePrincipalAuthentication lub InteractiveLoginAuthentication

Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o poświadczenia.

wartość domyślna: None
subscription_id
str

Identyfikator subskrypcji do użycia. Parametr jest wymagany, jeśli użytkownik ma dostęp do więcej niż jednej subskrypcji.

wartość domyślna: None
resource_group
str

Grupa zasobów do użycia. Jeśli brak, metoda będzie przeszukiwać wszystkie grupy zasobów w subskrypcji.

wartość domyślna: None
location
str

Lokalizacja obszaru roboczego.

wartość domyślna: None
cloud
str

Nazwa chmury docelowej. Może to być jeden z "AzureCloud", "AzureChinaCloud" lub "AzureUSGovernment". Jeśli nie określono chmury "AzureCloud" jest używana.

wartość domyślna: AzureCloud
id
str

Identyfikator obszaru roboczego.

wartość domyślna: None

Zwraca

Typ Opis
Workspace

Obiekt obszaru roboczego.

get_connection

Uzyskiwanie połączenia z obszarem roboczym.

get_connection(name)

Parametry

Nazwa Opis
name
Wymagane
str

Unikatowa nazwa połączenia w obszarze roboczym

get_default_compute_target

Pobierz domyślny docelowy obiekt obliczeniowy dla obszaru roboczego.

get_default_compute_target(type)

Parametry

Nazwa Opis
type
Wymagane
str

Typ obliczeń. Możliwe wartości to "CPU" lub "GPU".

Zwraca

Typ Opis
ComputeTarget

Domyślny cel obliczeniowy dla danego typu obliczeniowego.

get_default_datastore

Pobierz domyślny magazyn danych dla obszaru roboczego.

get_default_datastore()

Zwraca

Typ Opis
Datastore

Domyślny magazyn danych.

get_default_keyvault

Pobierz domyślny obiekt magazynu kluczy dla obszaru roboczego.

get_default_keyvault()

Zwraca

Typ Opis
Keyvault

Obiekt KeyVault skojarzony z obszarem roboczym.

get_details

Zwróć szczegóły obszaru roboczego.

get_details()

Zwraca

Typ Opis
dict[str, str]

Szczegóły obszaru roboczego w formacie słownika.

Uwagi

Zwrócony słownik zawiera następujące pary klucz-wartość.

  • id: identyfikator URI wskazujący ten zasób obszaru roboczego, zawierający identyfikator subskrypcji, grupę zasobów i nazwę obszaru roboczego.

  • name: nazwa tego obszaru roboczego.

  • location: region obszaru roboczego.

  • type: identyfikator URI formatu "{providerName}/workspaces".

  • tagi: obecnie nie są używane.

  • workspaceid: identyfikator tego obszaru roboczego.

  • opis: Obecnie nie jest używany.

  • friendlyName: przyjazna nazwa obszaru roboczego wyświetlanego w interfejsie użytkownika.

  • creationTime: czas utworzenia tego obszaru roboczego w formacie ISO8601.

  • containerRegistry: rejestr kontenerów obszaru roboczego używany do ściągania i wypychania obrazów eksperymentowania i usług internetowych.

  • keyVault: magazyn kluczy obszaru roboczego używany do przechowywania poświadczeń dodanych do obszaru roboczego przez użytkowników.

  • applicationInsights: usługa Application Insights będzie używana przez obszar roboczy do rejestrowania zdarzeń usług internetowych.

  • identityPrincipalId:

  • identityTenantId

  • Identitytype

  • storageAccount: magazyn będzie używany przez obszar roboczy do zapisywania danych wyjściowych uruchamiania, kodu, dzienników itp.

  • sku: jednostka SKU obszaru roboczego (nazywana również wersją). Parametr jest obecny dla zgodności z poprzednimi wersjami i jest ignorowany.

  • resourceCmkUri: identyfikator URI klucza zarządzanego przez klienta do szyfrowania danych magazynowanych. Zapoznaj się z https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 instrukcjami dotyczącymi tworzenia klucza i uzyskiwania identyfikatora URI.

  • hbiWorkspace: określa, czy dane klienta mają duży wpływ na firmę.

  • imageBuildCompute: obiekt docelowy obliczeniowy kompilacji obrazu.

  • systemDatastoresAuthMode: określa, czy należy używać poświadczeń dla systemowych magazynów danych obszaru roboczego "workspaceblobstore" i "workspacefilestore". Wartość domyślna to "accessKey", w tym przypadku obszar roboczy utworzy systemowe magazyny danych z poświadczeniami. Jeśli zostanie ustawiona wartość "identity", obszar roboczy utworzy systemowe magazyny danych bez poświadczeń.

Aby uzyskać więcej informacji na temat tych par klucz-wartość, zobacz create.

get_mlflow_tracking_uri

Pobierz identyfikator URI śledzenia MLflow dla obszaru roboczego.

MLflow (https://mlflow.org/) to platforma typu open source do śledzenia eksperymentów uczenia maszynowego i zarządzania modelami. Interfejsy API rejestrowania MLflow można używać z usługą Azure Machine Learning, aby metryki, modele i artefakty zostały zarejestrowane w obszarze roboczym usługi Azure Machine Learning.

get_mlflow_tracking_uri(_with_auth=False)

Parametry

Nazwa Opis
_with_auth
bool

(PRZESTARZAŁE) Dodaj informacje o uwierzytelnieniu do śledzenia identyfikatora URI.

wartość domyślna: False

Zwraca

Typ Opis
str

Identyfikator URI śledzenia zgodny z platformą MLflow.

Uwagi

Użyj następującego przykładu, aby skonfigurować śledzenie MLflow w celu wysyłania danych do obszaru roboczego usługi Azure ML:


   import mlflow
   from azureml.core import Workspace
   workspace = Workspace.from_config()
   mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())

get_run

Zwróć przebieg z określonym run_id w obszarze roboczym.

get_run(run_id)

Parametry

Nazwa Opis
run_id
Wymagane
string

Identyfikator przebiegu.

Zwraca

Typ Opis
Run

Przesłany przebieg.

list

Wyświetl listę wszystkich obszarów roboczych, do których użytkownik ma dostęp w ramach subskrypcji.

Listę obszarów roboczych można filtrować na podstawie grupy zasobów.

static list(subscription_id, auth=None, resource_group=None)

Parametry

Nazwa Opis
subscription_id
Wymagane
str

Identyfikator subskrypcji, dla której mają być wyświetlone obszary robocze.
auth
ServicePrincipalAuthentication lub InteractiveLoginAuthentication

Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o poświadczenia.

wartość domyślna: None
resource_group
str

Grupa zasobów do filtrowania zwróconych obszarów roboczych. Jeśli brak, metoda wyświetli listę wszystkich obszarów roboczych w ramach określonej subskrypcji.

wartość domyślna: None

Zwraca

Typ Opis
dict

Słownik, w którym klucz jest nazwą obszaru roboczego, a wartość jest listą obiektów obszaru roboczego.

list_connections

Wyświetl listę połączeń w tym obszarze roboczym.

list_connections(category=None, target=None)

Parametry

Nazwa Opis
type
Wymagane
str

Typ tego połączenia, który zostanie odfiltrowany
target
str

element docelowy tego połączenia, który zostanie odfiltrowany

wartość domyślna: None
category
wartość domyślna: None

list_keys

Wyświetl listę kluczy dla bieżącego obszaru roboczego.

list_keys()

Zwraca

Typ Opis
object

set_connection

Dodaj lub zaktualizuj połączenie w obszarze roboczym.

set_connection(name, category, target, authType, value)

Parametry

Nazwa Opis
name
Wymagane
str

Unikatowa nazwa połączenia w obszarze roboczym
category
Wymagane
str

Kategoria tego połączenia
target
Wymagane
str

element docelowy, z którymi łączy się to połączenie
authType
Wymagane
str

typ autoryzacji tego połączenia
value
Wymagane
str

parametry serializacji formatu json szczegółów połączenia

set_default_datastore

Ustaw domyślny magazyn danych dla obszaru roboczego.

set_default_datastore(name)

Parametry

Nazwa Opis
name
Wymagane
str

Nazwa elementu Datastore do ustawienia jako domyślna.

setup

Utwórz nowy obszar roboczy lub pobierz istniejący obszar roboczy.

static setup()

Zwraca

Typ Opis
Workspace

Obiekt Obszaru roboczego.

sync_keys

Wyzwala obszar roboczy, aby natychmiast zsynchronizować klucze.

Jeśli klucze dla dowolnego zasobu w obszarze roboczym zostaną zmienione, może upłynąć około godziny, aby mogły zostać automatycznie zaktualizowane. Ta funkcja umożliwia aktualizowanie kluczy po żądaniu. Przykładowy scenariusz wymaga natychmiastowego dostępu do magazynu po wygenerowaniu kluczy magazynu.

sync_keys(no_wait=False)

Parametry

Nazwa Opis
no_wait
bool

Czy poczekać na ukończenie kluczy synchronizacji obszaru roboczego.

wartość domyślna: False

Zwraca

Typ Opis
None

Brak, jeśli się powiedzie; w przeciwnym razie zgłasza błąd.

update

Zaktualizuj przyjazną nazwę, opis, tagi, obliczenia kompilacji obrazu i inne ustawienia skojarzone z obszarem roboczym.

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)

Parametry

Nazwa Opis
friendly_name
str

Przyjazna nazwa obszaru roboczego, który można wyświetlić w interfejsie użytkownika.

wartość domyślna: None
description
str

Opis obszaru roboczego.

wartość domyślna: None
tags
dict

Tagi do skojarzenia z obszarem roboczym.

wartość domyślna: None
image_build_compute
str

Nazwa obliczeniowa kompilacji obrazu.

wartość domyślna: None
service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>

Ustawienia zasobów zarządzanych przez usługę.

wartość domyślna: None
primary_user_assigned_identity
str

Identyfikator zasobu tożsamości przypisanej przez użytkownika, który reprezentuje tożsamość obszaru roboczego.

wartość domyślna: None
allow_public_access_when_behind_vnet
bool

Zezwalaj na dostęp publiczny do obszaru roboczego łącza prywatnego.

wartość domyślna: None
v1_legacy_mode
bool

Zapobieganie używaniu usługi interfejsu API w wersji 2 w publicznej usłudze Azure Resource Manager

wartość domyślna: None

Zwraca

Typ Opis
dict[str, str]

Słownik zaktualizowanych informacji.

update_dependencies

Zaktualizuj istniejące skojarzone zasoby dla obszaru roboczego w następujących przypadkach.

a) Gdy użytkownik przypadkowo usunie istniejący skojarzony zasób i chce zaktualizować go przy użyciu nowego bez konieczności ponownego tworzenia całego obszaru roboczego. b) Gdy użytkownik ma istniejący skojarzony zasób i chce zastąpić bieżący, skojarzony z obszarem roboczym. c) Jeśli skojarzony zasób nie został jeszcze utworzony i chce użyć istniejącego, który już ma (dotyczy tylko rejestru kontenerów).

update_dependencies(container_registry=None, force=False)

Parametry

Nazwa Opis
container_registry
str

Identyfikator usługi ARM dla rejestru kontenerów.

wartość domyślna: None
force
bool

Wymuś aktualizowanie zasobów zależnych bez monitu o potwierdzenie.

wartość domyślna: False

Zwraca

Typ Opis
Workspace

write_config

Zapisz właściwości usługi Azure Resource Manager (ARM) obszaru roboczego w pliku konfiguracji.

Właściwości usługi ARM obszaru roboczego from_config można załadować później przy użyciu metody . Wartość domyślna path to ".azureml/" w bieżącym katalogu roboczym i file_name wartość domyślna to "config.json".

Metoda umożliwia proste ponowne użycie tego samego obszaru roboczego w wielu notesach lub projektach języka Python. Użytkownicy mogą zapisywać właściwości usługi ARM obszaru roboczego przy użyciu tej funkcji i używać from_config do ładowania tego samego obszaru roboczego w różnych notesach lub projektach języka Python bez ponownego pisania właściwości usługi ARM obszaru roboczego.

write_config(path=None, file_name=None)

Parametry

Nazwa Opis
path
str

Użytkownik podał lokalizację zapisu pliku config.json. Parametr domyślnie ma wartość ".azureml/" w bieżącym katalogu roboczym.

wartość domyślna: None
file_name
str

Nazwa do użycia dla pliku konfiguracji. Wartość domyślna parametru to config.json.

wartość domyślna: None

Atrybuty

compute_targets

Wyświetl listę wszystkich docelowych obiektów obliczeniowych w obszarze roboczym.

Zwraca

Typ Opis
dict[str, ComputeTarget]

Słownik z kluczem jako nazwą docelową obliczeniową i wartością jako ComputeTarget obiektem.

datasets

Wyświetl listę wszystkich zestawów danych w obszarze roboczym.

Zwraca

Typ Opis
dict[str, Dataset]

Słownik z kluczem jako nazwą zestawu danych i wartością jako Dataset obiektem.

datastores

Wyświetl listę wszystkich magazynów danych w obszarze roboczym. Ta operacja nie zwraca poświadczeń magazynów danych.

Zwraca

Typ Opis
dict[str, Datastore]

Słownik z kluczem jako nazwą magazynu danych i wartością jako Datastore obiektem.

discovery_url

Zwróć adres URL odnajdywania tego obszaru roboczego.

Zwraca

Typ Opis
str

Adres URL odnajdywania tego obszaru roboczego.

environments

Wyświetl listę wszystkich środowisk w obszarze roboczym.

Zwraca

Typ Opis
dict[str, Environment]

Słownik z kluczem jako nazwą środowiska i wartością jako Environment obiektem.

experiments

Wyświetl listę wszystkich eksperymentów w obszarze roboczym.

Zwraca

Typ Opis
dict[str, Experiment]

Słownik z kluczem jako nazwą eksperymentu i wartością jako Experiment obiektem.

images

Zwróć listę obrazów w obszarze roboczym.

WebserviceException Zgłasza błąd, jeśli wystąpił problem podczas interakcji z usługą zarządzania modelami.

Zwraca

Typ Opis
dict[str, Image]

Słownik z kluczem jako nazwą obrazu i wartością jako Image obiektem.

Wyjątki

Typ Opis
WebserviceException

Wystąpił problem podczas interakcji z usługą zarządzania modelami.

linked_services

Wyświetl listę wszystkich połączonych usług w obszarze roboczym.

Zwraca

Typ Opis
dict[str, LinkedService]

Słownik, w którym klucz jest połączoną nazwą usługi, a wartość jest obiektem LinkedService .

location

Zwróć lokalizację tego obszaru roboczego.

Zwraca

Typ Opis
str

Lokalizacja tego obszaru roboczego.

models

Zwróć listę modelu w obszarze roboczym.

WebserviceException Zgłasza błąd, jeśli wystąpił problem podczas interakcji z usługą zarządzania modelami.

Zwraca

Typ Opis
dict[str, Model]

Słownik modelu z kluczem jako nazwą modelu i wartością jako Model obiektem.

Wyjątki

Typ Opis
WebserviceException

Wystąpił problem podczas interakcji z usługą zarządzania modelami.

name

Zwróć nazwę obszaru roboczego.

Zwraca

Typ Opis
str

Nazwa obszaru roboczego.

private_endpoints

Wyświetl listę wszystkich prywatnych punktów końcowych obszaru roboczego.

Zwraca

Typ Opis
dict[str, PrivateEndPoint]

Dykt obiektów PrivateEndPoint skojarzonych z obszarem roboczym. Klucz jest nazwą prywatnego punktu końcowego.

resource_group

Zwróć nazwę grupy zasobów dla tego obszaru roboczego.

Zwraca

Typ Opis
str

Nazwa grupy zasobów.

service_context

Zwróć kontekst usługi dla tego obszaru roboczego.

Zwraca

Typ Opis
<xref:azureml._restclient.service_context.ServiceContext>

Zwraca obiekt ServiceContext.

sku

Zwróć jednostkę SKU tego obszaru roboczego.

Zwraca

Typ Opis
str

Jednostka SKU tego obszaru roboczego.

subscription_id

Zwróć identyfikator subskrypcji dla tego obszaru roboczego.

Zwraca

Typ Opis
str

Identyfikator subskrypcji.

tags

Zwróć tagi tego obszaru roboczego.

Zwraca

Typ Opis
dict

Tagi tego obszaru roboczego.

webservices

Zwróć listę usług internetowych w obszarze roboczym.

Zgłasza błąd WebserviceException , jeśli wystąpił problem z zwróceniem listy.

Zwraca

Typ Opis
dict[str, Webservice]

Lista usług internetowych w obszarze roboczym.

Wyjątki

Typ Opis
WebserviceException

Wystąpił problem podczas zwracania listy.

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'