Workspace Klasa
Definiuje zasób usługi Azure Machine Learning na potrzeby 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 i ma skojarzą 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.
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
|
Identyfikator subskrypcji platformy Azure zawierający obszar roboczy. |
|
resource_group
Wymagane
|
Grupa zasobów zawierająca obszar roboczy. |
|
workspace_name
Wymagane
|
Nazwa istniejącego obszaru roboczego. |
|
auth
|
Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli wartość Brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń. Domyślna wartość: None
|
|
_location
|
Tylko do użytku wewnętrznego. Domyślna wartość: None
|
|
_disable_service_check
|
Tylko do użytku wewnętrznego. Domyślna wartość: False
|
|
_workspace_id
|
Tylko do użytku wewnętrznego. Domyślna wartość: None
|
|
sku
|
Parametr jest obecny dla zgodności z poprzednimi wersjami i jest ignorowany. Domyślna wartość: basic
|
|
_cloud
|
Tylko do użytku wewnętrznego. Domyślna wartość: AzureCloud
|
|
subscription_id
Wymagane
|
Identyfikator subskrypcji platformy Azure zawierający obszar roboczy. |
|
resource_group
Wymagane
|
Grupa zasobów zawierająca obszar roboczy. |
|
workspace_name
Wymagane
|
Nazwa obszaru roboczego. Nazwa musi mieć długość od 2 do 32 znaków. Pierwszy znak nazwy musi być alfanumeryczny (litera lub cyfra), ale pozostała część nazwy może zawierać alfanumeryczne, łączniki i podkreślenia. Odstępy nie są dozwolone. |
|
auth
Wymagane
|
Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli wartość 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
|
Tylko do użytku wewnętrznego. |
|
_disable_service_check
Wymagane
|
Tylko do użytku wewnętrznego. |
|
_workspace_id
Wymagane
|
Tylko do użytku wewnętrznego. |
|
sku
Wymagane
|
Parametr jest obecny dla zgodności z poprzednimi wersjami i jest ignorowany. |
|
tags
|
Tagi do skojarzenia z obszarem roboczym. Domyślna wartość: None
|
|
_cloud
Wymagane
|
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 było je ł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()
Alternatywnie użyj 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, zobacz 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ń 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 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 wpisywania 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 |
Uzyskaj połączenie 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 w celu natychmiastowej synchronizacji kluczy. Jeśli klucze dla dowolnego zasobu w obszarze roboczym zostaną zmienione, aktualizacja może potrwać około godziny. Ta funkcja umożliwia aktualizowanie kluczy po żądaniu. Przykładowy scenariusz wymaga natychmiastowego dostępu do magazynu po ponownej 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, który jest skojarzony z obszarem roboczym. c) Gdy 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 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 Metoda umożliwia proste 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
|
Konfiguracja prywatnego punktu końcowego w celu utworzenia prywatnego punktu końcowego w obszarze roboczym. |
|
private_endpoint_auto_approval
|
Flaga logiczna określająca, czy tworzenie prywatnego punktu końcowego powinno zostać zatwierdzone automatycznie lub zatwierdzone ręcznie z centrum usługi Azure Private Link. W przypadku ręcznego zatwierdzania użytkownicy mogą wyświetlać oczekujące żądanie w portalu usługi Private Link, aby zatwierdzić/odrzucić żądanie. Domyślna wartość: True
|
|
location
|
Lokalizacja prywatnego punktu końcowego, wartość domyślna to lokalizacja obszaru roboczego Domyślna wartość: None
|
|
show_output
|
Flaga przedstawiająca postęp tworzenia obszaru roboczego Domyślna wartość: True
|
|
tags
|
Tagi do skojarzenia z obszarem roboczym. Domyślna wartość: None
|
Zwraca
| Typ | Opis |
|---|---|
|
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ń 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
| Nazwa | Opis |
|---|---|
|
name
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 pozostała część nazwy może zawierać alfanumeryczne, łączniki i podkreślenia. Odstępy nie są dozwolone. |
|
auth
|
Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli wartość Brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń. Domyślna wartość: None
|
|
subscription_id
|
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. Domyślna wartość: None
|
|
resource_group
|
Grupa zasobów platformy Azure zawierająca obszar roboczy. Parametr domyślnie określa mutację nazwy obszaru roboczego. Domyślna wartość: None
|
|
location
|
Lokalizacja obszaru roboczego. Parametr jest domyślnie ustawiony na lokalizację grupy zasobów. Lokalizacja musi być obsługiwanym regionem usługi Azure Machine Learning. Domyślna wartość: None
|
|
create_resource_group
|
Wskazuje, czy należy utworzyć grupę zasobów, jeśli nie istnieje. Domyślna wartość: True
|
|
sku
|
Parametr jest obecny dla zgodności z poprzednimi wersjami i jest ignorowany. Domyślna wartość: basic
|
|
tags
|
Tagi do skojarzenia z obszarem roboczym. Domyślna wartość: None
|
|
friendly_name
|
Opcjonalna przyjazna nazwa obszaru roboczego, który można wyświetlić w interfejsie użytkownika. Domyślna wartość: None
|
|
storage_account
|
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. Domyślna wartość: None
|
|
key_vault
|
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. Domyślna wartość: None
|
|
app_insights
|
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. Domyślna wartość: None
|
|
container_registry
|
Istniejący rejestr kontenerów w formacie identyfikatora zasobu platformy Azure (zobacz poniższy kod, 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 eksperymentów i usług internetowych. Jeśli brak, nowy rejestr kontenerów zostanie utworzony tylko w razie potrzeby, a nie wraz z tworzeniem obszaru roboczego. Domyślna wartość: None
|
|
adb_workspace
|
Istniejący obszar roboczy usługi Adb w formacie identyfikatora zasobu platformy Azure (zobacz poniższy kod, 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. Domyślna wartość: None
|
|
primary_user_assigned_identity
|
Identyfikator zasobu tożsamości przypisanej przez użytkownika używanej do reprezentowania obszaru roboczego Domyślna wartość: None
|
|
cmk_keyvault
|
Magazyn kluczy zawierający klucz zarządzany przez klienta w formacie identyfikatora zasobu platformy Azure:
Domyślna wartość: None
|
|
resource_cmk_uri
|
Identyfikator URI klucza zarządzanego przez klienta w celu zaszyfrowania danych magazynowanych.
Format identyfikatora URI to: Domyślna wartość: None
|
|
hbi_workspace
|
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 i w zależności od składnika zestawu SDK powoduje zredagowanie informacji 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 z rozwiązywaniem 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 proaktywnie, 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, aby mieć wartość True. Domyślna wartość: False
|
|
default_cpu_compute_target
|
(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. Domyślna wartość: None
|
|
default_gpu_compute_target
|
(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"} If None, nie zostaną utworzone żadne obliczenia. Domyślna wartość: None
|
|
private_endpoint_config
|
Konfiguracja prywatnego punktu końcowego w celu utworzenia prywatnego punktu końcowego w obszarze roboczym usługi Azure ML. Domyślna wartość: None
|
|
private_endpoint_auto_approval
|
Flaga logiczna określająca, czy tworzenie prywatnego punktu końcowego powinno zostać zatwierdzone automatycznie lub zatwierdzone ręcznie z centrum usługi Azure Private Link. W przypadku ręcznego zatwierdzania użytkownicy mogą wyświetlać oczekujące żądanie w portalu usługi Private Link, aby zatwierdzić/odrzucić żądanie. Domyślna wartość: True
|
|
exist_ok
|
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. Domyślna wartość: False
|
|
show_output
|
Wskazuje, czy ta metoda wyświetli przyrostowy postęp. Domyślna wartość: True
|
|
user_assigned_identity_for_cmk_encryption
|
Identyfikator zasobu tożsamości przypisanej przez użytkownika, która musi być używana do uzyskiwania dostępu do klucza zarządzania klientem Domyślna wartość: None
|
|
system_datastores_auth_mode
|
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ń. Domyślna wartość: accessKey
|
|
v1_legacy_mode
|
Zapobieganie używaniu usługi interfejsu API w wersji 2 w publicznej usłudze Azure Resource Manager Domyślna wartość: None
|
Zwraca
| Typ | Opis |
|---|---|
|
Obiekt obszaru roboczego. |
Wyjątki
| Typ | Opis |
|---|---|
|
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 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ń skojarzone zasoby obszaru roboczego usługi Azure Machine Learning.
delete(delete_dependent_resources=False, no_wait=False)Parametry
| Nazwa | Opis |
|---|---|
|
delete_dependent_resources
|
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. Domyślna wartość: False
|
|
no_wait
|
Czy poczekać na zakończenie usuwania obszaru roboczego. Domyślna wartość: False
|
Zwraca
| Typ | Opis |
|---|---|
|
Brak w przypadku powodzenia; w przeciwnym razie zgłasza błąd. |
delete_connection
Usuń połączenie obszaru roboczego.
delete_connection(name)Parametry
| Nazwa | Opis |
|---|---|
|
name
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
| Nazwa | Opis |
|---|---|
|
private_endpoint_connection_name
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
| 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 obiektu 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 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 wpisywania 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
|
Ścieżka do pliku konfiguracji lub katalog początkowy do wyszukania. Parametr domyślnie rozpoczyna wyszukiwanie w bieżącym katalogu. Domyślna wartość: None
|
|
auth
|
Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli wartość Brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń. Domyślna wartość: None
|
|
_logger
|
Umożliwia zastąpienie domyślnego rejestratora. Domyślna wartość: None
|
|
_file_name
|
Umożliwia zastąpienie nazwy pliku konfiguracji do wyszukiwania, gdy ścieżka jest ścieżką katalogu. Domyślna wartość: None
|
Zwraca
| Typ | Opis |
|---|---|
|
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
|
Nazwa obszaru roboczego do pobrania. |
|
auth
|
Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli wartość Brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń. Domyślna wartość: None
|
|
subscription_id
|
Identyfikator subskrypcji do użycia. Parametr jest wymagany, jeśli użytkownik ma dostęp do więcej niż jednej subskrypcji. Domyślna wartość: None
|
|
resource_group
|
Grupa zasobów do użycia. Jeśli wartość None, metoda będzie przeszukiwać wszystkie grupy zasobów w subskrypcji. Domyślna wartość: None
|
|
location
|
Lokalizacja obszaru roboczego. Domyślna wartość: None
|
|
cloud
|
Nazwa chmury docelowej. Może to być jeden z "AzureCloud", "AzureChinaCloud" lub "AzureUSGovernment". Jeśli nie określono chmury "AzureCloud" jest używana. Domyślna wartość: AzureCloud
|
|
id
|
Identyfikator obszaru roboczego. Domyślna wartość: None
|
Zwraca
| Typ | Opis |
|---|---|
|
Obiekt obszaru roboczego. |
get_connection
Uzyskaj połączenie z obszarem roboczym.
get_connection(name)Parametry
| Nazwa | Opis |
|---|---|
|
name
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
| Nazwa | Opis |
|---|---|
|
type
Wymagane
|
Typ obliczeń. Możliwe wartości to "CPU" lub "GPU". |
Zwraca
| Typ | Opis |
|---|---|
|
Domyślny docelowy obiekt obliczeniowy dla danego typu obliczeniowego. |
get_default_datastore
Pobierz domyślny magazyn danych dla obszaru roboczego.
get_default_datastore()Zwraca
| Typ | Opis |
|---|---|
|
Domyślny magazyn danych. |
get_default_keyvault
Pobierz domyślny obiekt magazynu kluczy dla obszaru roboczego.
get_default_keyvault()Zwraca
| Typ | Opis |
|---|---|
|
Obiekt KeyVault skojarzony z obszarem roboczym. |
get_details
Zwróć szczegóły obszaru roboczego.
get_details()Zwraca
| Typ | Opis |
|---|---|
|
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 eksperymentów i webservices.
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 w celu zaszyfrowania 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 pobierania jego identyfikatora URI.
hbiWorkspace: określa, czy dane klienta mają duży wpływ na działalność biznesową.
imageBuildCompute: docelowy obiekt 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
|
(PRZESTARZAŁE) Dodaj informacje o uwierzytelnieniu do śledzenia identyfikatora URI. Domyślna wartość: False
|
Zwraca
| Typ | Opis |
|---|---|
|
Identyfikator URI śledzenia zgodny z biblioteką MLflow. |
Uwagi
Skorzystaj z poniższego 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
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
|
Identyfikator subskrypcji, dla której chcesz wyświetlić listę obszarów roboczych. |
|
auth
|
Obiekt uwierzytelniania. Aby uzyskać więcej informacji, zobacz https://aka.ms/aml-notebook-auth. Jeśli wartość Brak, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń. Domyślna wartość: None
|
|
resource_group
|
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. Domyślna wartość: None
|
Zwraca
| Typ | Opis |
|---|---|
|
Słownik, w którym klucz to nazwa 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
|
Typ tego połączenia, które zostanie odfiltrowane |
|
target
|
element docelowy tego połączenia, który zostanie odfiltrowany Domyślna wartość: None
|
|
category
|
Domyślna wartość: None
|
list_keys
set_connection
Dodaj lub zaktualizuj połączenie w obszarze roboczym.
set_connection(name, category, target, authType, value)Parametry
| Nazwa | Opis |
|---|---|
|
name
Wymagane
|
Unikatowa nazwa połączenia w obszarze roboczym |
|
category
Wymagane
|
Kategoria tego połączenia |
|
target
Wymagane
|
obiekt docelowy, z którymi łączy się to połączenie |
|
authType
Wymagane
|
typ autoryzacji tego połączenia |
|
value
Wymagane
|
parametry serializacji formatu JSON szczegółów połączenia |
set_default_datastore
setup
Utwórz nowy obszar roboczy lub pobierz istniejący obszar roboczy.
static setup()Zwraca
| Typ | Opis |
|---|---|
|
Obiekt Obszaru roboczego. |
sync_keys
Wyzwala obszar roboczy w celu natychmiastowej synchronizacji kluczy.
Jeśli klucze dla dowolnego zasobu w obszarze roboczym zostaną zmienione, aktualizacja może potrwać około godziny. Ta funkcja umożliwia aktualizowanie kluczy po żądaniu. Przykładowy scenariusz wymaga natychmiastowego dostępu do magazynu po ponownej wygenerowaniu kluczy magazynu.
sync_keys(no_wait=False)Parametry
| Nazwa | Opis |
|---|---|
|
no_wait
|
Czy poczekać na ukończenie kluczy synchronizacji obszaru roboczego. Domyślna wartość: False
|
Zwraca
| Typ | Opis |
|---|---|
|
Brak w przypadku powodzenia; 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
|
Przyjazna nazwa obszaru roboczego, który można wyświetlić w interfejsie użytkownika. Domyślna wartość: None
|
|
description
|
Opis obszaru roboczego. Domyślna wartość: None
|
|
tags
|
Tagi do skojarzenia z obszarem roboczym. Domyślna wartość: None
|
|
image_build_compute
|
Nazwa obliczeniowa kompilacji obrazu. Domyślna wartość: None
|
|
service_managed_resources_settings
|
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
Ustawienia zasobów zarządzanych przez usługę. Domyślna wartość: None
|
|
primary_user_assigned_identity
|
Identyfikator zasobu tożsamości przypisanej przez użytkownika, który reprezentuje tożsamość obszaru roboczego. Domyślna wartość: None
|
|
allow_public_access_when_behind_vnet
|
Zezwalaj na dostęp publiczny do obszaru roboczego łącza prywatnego. Domyślna wartość: None
|
|
v1_legacy_mode
|
Zapobieganie używaniu usługi interfejsu API w wersji 2 w publicznej usłudze Azure Resource Manager Domyślna wartość: None
|
Zwraca
| Typ | Opis |
|---|---|
|
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, który jest skojarzony z obszarem roboczym. c) Gdy 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
| Nazwa | Opis |
|---|---|
|
container_registry
|
Identyfikator usługi ARM dla rejestru kontenerów. Domyślna wartość: None
|
|
force
|
Jeśli wymusić aktualizację zasobów zależnych bez monitowania o potwierdzenie. Domyślna wartość: False
|
Zwraca
| Typ | Opis |
|---|---|
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 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
|
Użytkownik podał lokalizację zapisu pliku config.json. Parametr domyślnie ma wartość ".azureml/" w bieżącym katalogu roboczym. Domyślna wartość: None
|
|
file_name
|
Nazwa do użycia dla pliku konfiguracji. Wartość domyślna parametru to config.json. Domyślna wartość: None
|
Atrybuty
compute_targets
Wyświetl listę wszystkich obiektów docelowych obliczeniowych w obszarze roboczym.
Zwraca
| Typ | Opis |
|---|---|
|
Słownik z kluczem jako nazwą docelową i wartością obliczeniową jako ComputeTarget obiektem. |
datasets
datastores
discovery_url
Zwróć adres URL odnajdywania tego obszaru roboczego.
Zwraca
| Typ | Opis |
|---|---|
|
Adres URL odnajdywania tego obszaru roboczego. |
environments
Wyświetl listę wszystkich środowisk w obszarze roboczym.
Zwraca
| Typ | Opis |
|---|---|
|
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 |
|---|---|
|
Słownik z kluczem jako nazwą eksperymentu i wartością jako Experiment obiektem. |
images
Zwróć listę obrazów w obszarze roboczym.
Zgłasza problem WebserviceException podczas interakcji z usługą zarządzania modelami.
Zwraca
| Typ | Opis |
|---|---|
|
Słownik z kluczem jako nazwą obrazu i wartością jako Image obiektem. |
Wyjątki
| Typ | Opis |
|---|---|
|
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 |
|---|---|
|
Słownik, w którym klucz jest połączoną nazwą usługi, a wartość jest obiektem LinkedService . |
location
models
Zwróć listę modelu w obszarze roboczym.
Zgłasza problem WebserviceException podczas interakcji z usługą zarządzania modelami.
Zwraca
| Typ | Opis |
|---|---|
|
Słownik modelu z kluczem jako nazwą modelu i wartością jako Model obiektem. |
Wyjątki
| Typ | Opis |
|---|---|
|
Wystąpił problem podczas interakcji z usługą zarządzania modelami. |
name
private_endpoints
Wyświetl listę wszystkich prywatnych punktów końcowych obszaru roboczego.
Zwraca
| Typ | Opis |
|---|---|
|
Dykt obiektów PrivateEndPoint skojarzonych z obszarem roboczym. Klucz to nazwa prywatnego punktu końcowego. |
resource_group
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 |
|---|---|
|
Jednostka SKU tego obszaru roboczego. |
subscription_id
Zwróć identyfikator subskrypcji dla tego obszaru roboczego.
Zwraca
| Typ | Opis |
|---|---|
|
Identyfikator subskrypcji. |
tags
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 |
|---|---|
|
Lista usług internetowych w obszarze roboczym. |
Wyjątki
| Typ | Opis |
|---|---|
|
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'