Workspace Klasa

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:

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

subscription_id
str
Wymagane

Identyfikator subskrypcji platformy Azure zawierający obszar roboczy.

resource_group
str
Wymagane

Grupa zasobów zawierająca obszar roboczy.

workspace_name
str
Wymagane

Nazwa istniejącego obszaru roboczego.

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

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
str
wartość domyślna: None

Tylko do użytku wewnętrznego.

_disable_service_check
bool
wartość domyślna: False

Tylko do użytku wewnętrznego.

_workspace_id
str
wartość domyślna: None

Tylko do użytku wewnętrznego.

sku
str
wartość domyślna: basic

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

_cloud
str
wartość domyślna: None

Tylko do użytku wewnętrznego.

_cloud
wartość domyślna: AzureCloud

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ń dotyczących obszaru roboczego nie są spełnione.

delete

Usuń zasoby skojarzone z obszarem roboczym 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 usługi Azure Resource Manager (ARM) obszaru roboczego 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 zasobu, który już ma (dotyczy tylko rejestru kontenerów).

write_config

Zapisz właściwości obszaru roboczego usługi Azure Resource Manager (ARM) 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ści path domyślne to ".azureml/" w bieżącym katalogu roboczym i file_name domyślnie mają wartość "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

private_endpoint_config
PrivateEndPointConfig
Wymagane

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

private_endpoint_auto_approval
bool
wartość domyślna: True

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.

location
string
wartość domyślna: None

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

show_output
bool
wartość domyślna: True

Flaga przedstawiająca postęp tworzenia obszaru roboczego

tags
dict
wartość domyślna: None

Tagi do skojarzenia z obszarem roboczym.

Zwraca

Utworzony obiekt PrivateEndPoint.

Typ zwracany

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ń dotyczących 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

name
str
Wymagane

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. Białe znaki są niedozwolone.

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

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ń.

subscription_id
str
wartość domyślna: None

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.

resource_group
str
wartość domyślna: None

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

location
str
wartość domyślna: None

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

create_resource_group
bool
wartość domyślna: True

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

sku
str
wartość domyślna: basic

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

tags
dict
wartość domyślna: None

Tagi do skojarzenia z obszarem roboczym.

friendly_name
str
wartość domyślna: None

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

storage_account
str
wartość domyślna: None

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.

key_vault
str
wartość domyślna: None

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.

app_insights
str
wartość domyślna: None

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.

container_registry
str
wartość domyślna: None

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.

adb_workspace
str
wartość domyślna: None

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.

primary_user_assigned_identity
str
wartość domyślna: None

Identyfikator zasobu tożsamości przypisanej przez użytkownika używanej do reprezentowania obszaru roboczego

cmk_keyvault
str
wartość domyślna: None

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 poniższych uwagach, aby uzyskać więcej informacji na temat formatu identyfikatora zasobu platformy Azure.

resource_cmk_uri
str
wartość domyślna: None

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 pobierania jego identyfikatora URI.

hbi_workspace
bool
wartość domyślna: False

Określa, czy obszar roboczy zawiera dane o dużym wpływie na działalność biznesową (HBI), tj. zawiera poufne informacje biznesowe. Tę flagę można ustawić tylko podczas tworzenia obszaru roboczego. Nie można zmienić jej 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 informacje w danych telemetrycznych zbieranych wewnętrznie. 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 w rozwiązywaniu problemów. Może się tak 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 to używa wartości domyślnej False dla tej flagi, chyba że jest to ściśle wymagane, aby mieć wartość True.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
wartość domyślna: None

(PRZESTARZAŁE) Konfiguracja, która będzie używana do tworzenia obliczeń 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.

default_gpu_compute_target
AmlComputeProvisioningConfiguration
wartość domyślna: None

(PRZESTARZAŁE) Konfiguracja, która będzie używana do tworzenia obliczeń procesora GPU. Domyślnie parametr {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Jeśli brak, nie zostaną utworzone żadne obliczenia.

private_endpoint_config
PrivateEndPointConfig
wartość domyślna: None

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

private_endpoint_auto_approval
bool
wartość domyślna: True

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.

exist_ok
bool
wartość domyślna: False

Wskazuje, czy ta metoda powiedzie się, jeśli obszar roboczy już istnieje. Jeśli wartość False, ta metoda nie powiedzie się, jeśli obszar roboczy istnieje. Jeśli wartość True, ta metoda zwraca istniejący obszar roboczy, jeśli istnieje.

show_output
bool
wartość domyślna: True

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

user_assigned_identity_for_cmk_encryption
str
wartość domyślna: None

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

system_datastores_auth_mode
str
wartość domyślna: accessKey

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ń.

v1_legacy_mode
bool
wartość domyślna: None

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

Zwraca

Obiekt obszaru roboczego.

Typ zwracany

Wyjątki

Podniesione 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 ponownie 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ń zasoby skojarzone z obszarem roboczym usługi Azure Machine Learning.

delete(delete_dependent_resources=False, no_wait=False)

Parametry

delete_dependent_resources
bool
wartość domyślna: False

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

no_wait
bool
wartość domyślna: False

Czy poczekać na zakończenie usuwania obszaru roboczego.

Zwraca

Brak w przypadku powodzenia; w przeciwnym razie zgłasza błąd.

Typ zwracany

delete_connection

Usuń połączenie obszaru roboczego.

delete_connection(name)

Parametry

name
str
Wymagane

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

private_endpoint_connection_name
str
Wymagane

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

diagnose_parameters
<xref:_restclient.models.DiagnoseWorkspaceParameters>
Wymagane

Parametr diagnozowania kondycji obszaru roboczego

Zwraca

Wystąpienie elementu AzureOperationPoller zwracające polecenie DiagnoseResponseResult

Typ zwracany

AzureOperationPoller[<xref:_restclient.models.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 usługi Azure Resource Manager (ARM) obszaru roboczego 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

path
str
wartość domyślna: None

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

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

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ń.

_logger
Logger
wartość domyślna: None

Umożliwia zastąpienie domyślnego rejestratora.

_file_name
str
wartość domyślna: None

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

Zwraca

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

Typ zwracany

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

name
str
Wymagane

Nazwa obszaru roboczego do pobrania.

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

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ń.

subscription_id
str
wartość domyślna: None

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

resource_group
str
wartość domyślna: None

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

location
str
wartość domyślna: None

Lokalizacja obszaru roboczego.

cloud
str
wartość domyślna: AzureCloud

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

id
str
wartość domyślna: None

Identyfikator obszaru roboczego.

Zwraca

Obiekt obszaru roboczego.

Typ zwracany

get_connection

Uzyskiwanie połączenia z obszarem roboczym.

get_connection(name)

Parametry

name
str
Wymagane

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

type
str
Wymagane

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

Zwraca

Domyślny cel obliczeniowy dla danego typu obliczeniowego.

Typ zwracany

get_default_datastore

Pobierz domyślny magazyn danych dla obszaru roboczego.

get_default_datastore()

Zwraca

Domyślny magazyn danych.

Typ zwracany

get_default_keyvault

Pobierz domyślny obiekt magazynu kluczy dla obszaru roboczego.

get_default_keyvault()

Zwraca

Obiekt KeyVault skojarzony z obszarem roboczym.

Typ zwracany

get_details

Zwróć szczegóły obszaru roboczego.

get_details()

Zwraca

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

Typ zwracany

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

_with_auth
bool
wartość domyślna: False

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

Zwraca

Identyfikator URI śledzenia zgodny z platformą MLflow.

Typ zwracany

str

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

run_id
string
Wymagane

Identyfikator przebiegu.

Zwraca

Przesłany przebieg.

Typ zwracany

Run

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

subscription_id
str
Wymagane

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

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

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.

resource_group
str
wartość domyślna: None

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.

Zwraca

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

Typ zwracany

list_connections

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

list_connections(category=None, target=None)

Parametry

type
str
wartość domyślna: None

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

target
str
wartość domyślna: None

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

list_keys

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

list_keys()

Typ zwracany

set_connection

Dodaj lub zaktualizuj połączenie w obszarze roboczym.

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

Parametry

name
str
Wymagane

Unikatowa nazwa połączenia w obszarze roboczym

category
str
Wymagane

Kategoria tego połączenia

target
str
Wymagane

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

authType
str
Wymagane

typ autoryzacji tego połączenia

value
str
Wymagane

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

set_default_datastore

Ustaw domyślny magazyn danych dla obszaru roboczego.

set_default_datastore(name)

Parametry

name
str
Wymagane

Nazwa elementu Datastore do ustawienia jako domyślna.

setup

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

static setup()

Zwraca

Obiekt Obszaru roboczego.

Typ zwracany

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

no_wait
bool
wartość domyślna: False

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

Zwraca

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

Typ zwracany

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

friendly_name
str
wartość domyślna: None

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

description
str
wartość domyślna: None

Opis obszaru roboczego.

tags
dict
wartość domyślna: None

Tagi do skojarzenia z obszarem roboczym.

image_build_compute
str
wartość domyślna: None

Nazwa obliczeniowa kompilacji obrazu.

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

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

primary_user_assigned_identity
str
wartość domyślna: None

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

allow_public_access_when_behind_vnet
bool
wartość domyślna: None

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

v1_legacy_mode
bool
wartość domyślna: None

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

Zwraca

Słownik zaktualizowanych informacji.

Typ zwracany

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 zasobu, który już ma (dotyczy tylko rejestru kontenerów).

update_dependencies(container_registry=None, force=False)

Parametry

container_registry
str
wartość domyślna: None

Identyfikator usługi ARM dla rejestru kontenerów.

force
bool
wartość domyślna: False

Jeśli wymusisz aktualizowanie zasobów zależnych bez monitowania o potwierdzenie.

write_config

Zapisz właściwości obszaru roboczego usługi Azure Resource Manager (ARM) 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ści path domyślne to ".azureml/" w bieżącym katalogu roboczym i file_name domyślnie mają wartość "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

path
str
wartość domyślna: None

Lokalizacja podana przez użytkownika do zapisania pliku config.json. Parametr domyślnie ma wartość ".azureml/" w bieżącym katalogu roboczym.

file_name
str
wartość domyślna: None

Nazwa do użycia dla pliku konfiguracji. Parametr jest domyślnie ustawiony na plik config.json.

Atrybuty

compute_targets

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

Zwraca

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

Typ zwracany

datasets

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

Zwraca

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

Typ zwracany

datastores

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

Zwraca

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

Typ zwracany

discovery_url

Zwróć adres URL odnajdywania tego obszaru roboczego.

Zwraca

Adres URL odnajdywania tego obszaru roboczego.

Typ zwracany

str

environments

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

Zwraca

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

Typ zwracany

experiments

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

Zwraca

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

Typ zwracany

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

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

Typ zwracany

Wyjątki

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

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

Typ zwracany

location

Zwróć lokalizację tego obszaru roboczego.

Zwraca

Lokalizacja tego obszaru roboczego.

Typ zwracany

str

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

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

Typ zwracany

Wyjątki

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

name

Zwróć nazwę obszaru roboczego.

Zwraca

Nazwa obszaru roboczego.

Typ zwracany

str

private_endpoints

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

Zwraca

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

Typ zwracany

resource_group

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

Zwraca

Nazwa grupy zasobów.

Typ zwracany

str

service_context

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

Zwraca

Zwraca obiekt ServiceContext.

Typ zwracany

<xref:azureml._restclient.service_context.ServiceContext>

sku

Zwróć jednostkę SKU tego obszaru roboczego.

Zwraca

Jednostka SKU tego obszaru roboczego.

Typ zwracany

str

subscription_id

Zwróć identyfikator subskrypcji dla tego obszaru roboczego.

Zwraca

Identyfikator subskrypcji.

Typ zwracany

str

tags

Zwróć tagi tego obszaru roboczego.

Zwraca

Tagi tego obszaru roboczego.

Typ zwracany

webservices

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

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

Zwraca

Lista usług internetowych w obszarze roboczym.

Typ zwracany

Wyjątki

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'