Workspace Klasa

Definiuje zasób Azure Machine Learning na potrzeby zarządzania artefaktami szkoleń i wdrażania.

Obszar roboczy jest podstawowym zasobem uczenia maszynowego w Azure Machine Learning. Obszar roboczy służy do eksperymentowania, uczenia i wdrażania modeli uczenia maszynowego. Każdy obszar roboczy jest powiązany z subskrypcją platformy Azure i grupą zasobów i ma skojarzoną 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)

Parametry

subscription_id
<xref:str>

Identyfikator subskrypcji platformy Azure z obszarem roboczym.

resource_group
<xref:str>

Grupa zasobów zawierająca obszar roboczy.

workspace_name
<xref:str>

Istniejąca nazwa obszaru roboczego.

auth
ServicePrincipalAuthentication lub InteractiveLoginAuthentication lub MsiAuthentication

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

_location
<xref:str>

Tylko do użytku wewnętrznego.

_disable_service_check
<xref:bool>

Tylko do użytku wewnętrznego.

_workspace_id
<xref:str>

Tylko do użytku wewnętrznego.

sku
<xref:str>

Parametr jest obecny w celu zapewnienia zgodności z poprzednimi wersjami i jest ignorowany. Aby uzyskać więcej informacji, zobacz Azure Machine Learning jednostek SKU.

Uwagi

Poniższy przykład pokazuje, 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ść false, 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 subskrypcję, zasób i nazwę obszaru roboczego, aby można było go łatwo załadować. Aby zapisać konfigurację, użyj write_config metody.


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

Przykład pliku konfiguracji można znaleźć w temacie Tworzenie pliku konfiguracji obszaru roboczego .

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


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

Alternatywnie można użyć get metody do załadowania istniejącego obszaru roboczego bez używania plików konfiguracji.


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

Powyższe przykłady mogą monitować o poświadczenia uwierzytelniania platformy Azure przy użyciu interakcyjnego okna dialogowego logowania. W przypadku innych przypadków użycia, w tym za pomocą interfejsu wiersza polecenia platformy Azure do uwierzytelniania i uwierzytelniania w zautomatyzowanych przepływach pracy, zobacz uwierzytelnianie w 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ń Obszar roboczy usługi Azure Machine Learning skojarzone zasoby.

delete_connection

Usuń połączenie z obszarem roboczym.

delete_private_endpoint_connection

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

from_config

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

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

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

get

Zwróć obiekt obszaru roboczego dla istniejącego Obszar roboczy 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

Pobierz połączenie z obszarem roboczym.

get_default_compute_target

Pobierz domyślny element docelowy obliczeń 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 Open Source służąca do śledzenia eksperymentów uczenia maszynowego i zarządzania modelami. Interfejsów API rejestrowania MLflow można użyć z Azure Machine Learning, aby metryki, modele i artefakty były rejestrowane w obszarze roboczym 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.

Lista obszarów roboczych może być filtrowana na podstawie grupy zasobów.

list_connections

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

list_keys

Wyświetl klucze 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 możliwość natychmiastowego synchronizowania kluczy w obszarze roboczym.

Jeśli klucze dla dowolnego zasobu w obszarze roboczym zostaną zmienione, może upłynąć około godziny, zanim zostaną zaktualizowane automatycznie. Ta funkcja umożliwia zaktualizowanie kluczy na żądanie. Przykładowy scenariusz wymaga natychmiastowego dostępu do magazynu po ponownym generowaniu kluczy magazynu.

update

Aktualizowanie przyjaznej nazwy, opisu, tagów, obliczeń dla kompilacji obrazów i innych ustawień skojarzonych z obszarem roboczym.

update_dependencies

Zaktualizuj istniejące zasoby związane z obszarem roboczym w następujących przypadkach.

a), gdy użytkownik przypadkowo usunie istniejący skojarzony zasób i chce go zaktualizować 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 chcą korzystać z istniejącego już z nich (dotyczy tylko rejestru kontenerów).

write_config

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

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

Metoda zapewnia prosty sposób używania tego samego obszaru roboczego w wielu notesach lub projektach środowiska Python. Użytkownicy mogą zapisywać właściwości ARM obszaru roboczego za pomocą tej funkcji i używać from_config do ładowania tego samego obszaru roboczego w różnych notesach lub projektach w języku Python bez ponownego wpisywania właściwości 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

Konfiguracja prywatnego punktu końcowego służąca do tworzenia prywatnego punktu końcowego w obszarze roboczym.

private_endpoint_auto_approval
<xref:bool>
wartość domyślna: True

Flagę logiczną, która wskazuje, czy prywatne Tworzenie punktów końcowych powinno być zatwierdzane ręcznie, czy z poziomu prywatnego centrum linków platformy Azure. W przypadku zatwierdzania ręcznego użytkownicy mogą wyświetlić oczekujące żądanie w portalu łącza prywatnego, aby zatwierdzić/odrzucić żądanie.

location
string
wartość domyślna: None

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

show_output
<xref:bool>
wartość domyślna: True

Flaga pokazująca postęp tworzenia obszaru roboczego

tags
<xref:dict>
wartość domyślna: None

Tagi do skojarzenia z obszarem roboczym.

Zwraca

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

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')

Parametry

name
<xref: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 pozostała część nazwy może zawierać znaki alfanumeryczne, łączniki i podkreślenia. Biały znak jest niedozwolony.

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

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

subscription_id
<xref:str>
wartość domyślna: None

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

resource_group
<xref:str>
wartość domyślna: None

Grupa zasobów platformy Azure, która zawiera obszar roboczy. Wartość domyślna parametru to mutacja nazwy obszaru roboczego.

location
<xref:str>
wartość domyślna: None

Lokalizacja obszaru roboczego. Parametr domyślnie jest lokalizacją grupy zasobów. Lokalizacja musi być obsługiwanym regionem dla Azure Machine Learning.

create_resource_group
<xref:bool>
wartość domyślna: True

Wskazuje, czy grupa zasobów ma zostać utworzona, jeśli nie istnieje.

sku
<xref:str>
wartość domyślna: basic

Parametr jest obecny w celu zapewnienia zgodności z poprzednimi wersjami i jest ignorowany. Aby uzyskać więcej informacji, zobacz Azure Machine Learning jednostek SKU.

tags
<xref:dict>
wartość domyślna: None

Tagi do skojarzenia z obszarem roboczym.

friendly_name
<xref:str>
wartość domyślna: None

Opcjonalna przyjazna nazwa obszaru roboczego, który może być wyświetlany w interfejsie użytkownika.

storage_account
<xref: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 wyników uruchamiania, kodu, dzienników itp. Jeśli nie, zostanie utworzone nowe konto magazynu.

key_vault
<xref: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 nie, zostanie utworzony nowy magazyn kluczy.

app_insights
<xref:str>
wartość domyślna: None

Istniejący 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. Application Insights będzie używany przez obszar roboczy do rejestrowania zdarzeń usługi WebService. Jeśli nie, zostanie utworzony nowy Application Insights.

container_registry
<xref: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). W obszarze roboczym będzie używany rejestr kontenerów do ściągania i wypychania obrazów eksperymentowania i usług WebService. Jeśli nie, Nowy Rejestr kontenerów zostanie utworzony tylko w razie konieczności, a nie wraz z tworzeniem obszaru roboczego.

adb_workspace
<xref:str>
wartość domyślna: None

Istniejący obszar roboczy 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 ADB będzie używany do łączenia z obszarem roboczym. Jeśli nie, łącze obszaru roboczego nie zostanie wykonane.

primary_user_assigned_identity
<xref:str>
wartość domyślna: None

Identyfikator zasobu tożsamości przypisanej przez użytkownika, który służy do reprezentowania obszaru roboczego

cmk_keyvault
<xref: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" Zapoznaj się z przykładowym kodem w poniższych spostrzeżeniach, aby uzyskać więcej szczegółowych informacji na temat formatu identyfikatora zasobu platformy Azure.

resource_cmk_uri
<xref:str>
wartość domyślna: None

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

hbi_workspace
<xref:bool>
wartość domyślna: False

Określa, czy obszar roboczy zawiera dane dotyczące wysokiego wpływu na działalność biznesową (HBI), czyli 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 na wartość true są wykonywane dalsze kroki szyfrowania, a w zależności od składnika zestawu SDK wyniki redagowane są przechowywane w danych telemetrycznych zebranych wewnętrznie. Aby uzyskać więcej informacji, zobacz szyfrowanie danych.

Gdy ta flaga ma wartość true, jeden możliwy wpływ zwiększa problemy związane z rozwiązywaniem problemów. Może się tak zdarzyć, ponieważ niektóre dane telemetryczne nie są wysyłane do firmy Microsoft i jest mniej zauważalne według stawek sukcesów lub typów problemów, dlatego może nie być w stanie aktywnie reagować, gdy ta flaga ma wartość true. Zalecenie jest stosowane domyślnie wartość false dla tej flagi, chyba że musi być wymagana 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. Wartość domyślna parametru to {min_nodes = 0, max_nodes = 2, vm_size = "STANDARD_DS2_V2", vm_priority = "dedykowane"} Jeśli nie, żadne obliczenia nie zostaną utworzone.

default_gpu_compute_target
AmlComputeProvisioningConfiguration
wartość domyślna: None

PRZESTARZAŁE Konfiguracja, która będzie używana do tworzenia obliczeń procesora GPU. Wartość domyślna parametru to {min_nodes = 0, max_nodes = 2, vm_size = "STANDARD_NC6", vm_priority = "dedykowane"} Jeśli nie, żadne obliczenia nie zostaną utworzone.

private_endpoint_config
PrivateEndPointConfig
wartość domyślna: None

Konfiguracja prywatnego punktu końcowego umożliwiająca utworzenie prywatnego punktu końcowego w obszarze roboczym usługi Azure ML.

private_endpoint_auto_approval
<xref:bool>
wartość domyślna: True

Flagę logiczną, która wskazuje, czy prywatne Tworzenie punktów końcowych powinno być zatwierdzane ręcznie, czy z poziomu prywatnego centrum linków platformy Azure. W przypadku zatwierdzania ręcznego użytkownicy mogą wyświetlić oczekujące żądanie w portalu łącza prywatnego, aby zatwierdzić/odrzucić żądanie.

exist_ok
<xref:bool>
wartość domyślna: False

Wskazuje, czy ta metoda jest pomyślna, jeśli obszar roboczy już istnieje. W przypadku wartości false ta metoda kończy się niepowodzeniem, jeśli istnieje obszar roboczy. W przypadku wartości true ta metoda zwraca istniejący obszar roboczy, jeśli istnieje.

show_output
<xref:bool>
wartość domyślna: True

Wskazuje, czy ta metoda będzie drukować postęp przyrostowy.

user_assigned_identity_for_cmk_encryption
<xref:str>
wartość domyślna: None

Identyfikator zasobu tożsamości przypisanej przez użytkownika, który musi być używany w celu uzyskania dostępu do klucza zarządzania klientami

system_datastores_auth_mode
<xref:str>
wartość domyślna: accessKey

Określa, czy należy używać poświadczeń dla magazynów danych systemu obszaru roboczego "workspaceblobstore" i "workspacefilestore". Wartość domyślna to "accessKey". w takim przypadku obszar roboczy utworzy magazyny danych systemu z poświadczeniami. W przypadku wybrania opcji "tożsamość" w obszarze roboczym zostaną utworzone systemowe magazyny danych bez poświadczeń.

Zwraca

Obiekt obszaru roboczego.

Typ zwracany

Wyjątki

Wywoływane w przypadku problemów z tworzeniem obszaru roboczego.

Uwagi

W pierwszym przykładzie jest wymagana tylko minimalna Specyfikacja i wszystkie zasoby zależne oraz Grupa zasobów zostanie utworzona 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')

Poniższy przykład pokazuje, jak ponownie wykorzystać istniejące zasoby platformy Azure przy użyciu formatu identyfikatora zasobu platformy Azure. Poszczególne identyfikatory zasobów platformy Azure można pobrać za pomocą witryny Azure Portal lub zestawu SDK. Przyjęto założenie, że grupa zasobów, konto magazynu, Magazyn kluczy, usługi App Insights i rejestr kontenerów już istnieje.


   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,
                         sku='enterprise')

delete

Usuń Obszar roboczy usługi Azure Machine Learning skojarzone zasoby.

delete(delete_dependent_resources=False, no_wait=False)

Parametry

delete_dependent_resources
<xref:bool>
wartość domyślna: False

Czy należy usunąć zasoby skojarzone z obszarem roboczym, tj. rejestrem kontenerów, kontem magazynu, magazynem kluczy i usługą Application Insights. Wartość domyślna to false. Ustaw wartość true, aby usunąć te zasoby.

no_wait
<xref:bool>
wartość domyślna: False

Określa, czy poczekać na zakończenie usuwania obszaru roboczego.

Zwraca

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

Typ zwracany

<xref:None>

delete_connection

Usuń połączenie z obszarem roboczym.

delete_connection(name)

Parametry

name
<xref: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

private_endpoint_connection_name
<xref:str>

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

from_config

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

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

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

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

Parametry

path
<xref:str>
wartość domyślna: None

Ścieżka do pliku konfiguracji lub katalog początkowy do przeszukania. 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 nie, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń.

_logger
<xref:logging.Logger>
wartość domyślna: None

Umożliwia zastępowanie domyślnego rejestratora.

_file_name
<xref:str>
wartość domyślna: None

Umożliwia zastąpienie nazwy pliku konfiguracji w celu wyszukania, gdy ścieżka jest ścieżką katalogu.

Zwraca

Obiekt obszaru roboczego dla istniejącej Obszar roboczy usługi ML platformy Azure.

Typ zwracany

get

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

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

get(name, auth=None, subscription_id=None, resource_group=None)

Parametry

name
<xref:str>

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 nie, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń.

subscription_id
<xref:str>
wartość domyślna: None

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

resource_group
<xref:str>
wartość domyślna: None

Grupa zasobów, która ma zostać użyta. Jeśli nie, Metoda przeszuka wszystkie grupy zasobów w subskrypcji.

Zwraca

Obiekt obszaru roboczego.

Typ zwracany

get_connection

Pobierz połączenie z obszarem roboczym.

get_connection(name)

Parametry

name
<xref:str>

Unikatowa nazwa połączenia w obszarze roboczym

get_default_compute_target

Pobierz domyślny element docelowy obliczeń dla obszaru roboczego.

get_default_compute_target(type)

Parametry

type
<xref:str>

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

Zwraca

Domyślny element docelowy obliczeń dla danego typu obliczenia.

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 magazynu kluczy 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

<xref:dict>[<xref:str>, <xref:str>]

Uwagi

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

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

  • Nazwa: Nazwa tego obszaru roboczego.

  • Lokalizacja: region obszaru roboczego.

  • Typ: identyfikator URI formatu "{ProviderName}/Workspaces".

  • Tagi: obecnie nie są używane.

  • Identyfikator obszaru roboczego: 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 WebService.

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

  • applicationInsights: Application Insights będzie używany przez obszar roboczy do rejestrowania zdarzeń usługi WebService.

  • identityPrincipalId:

  • identityTenantId

  • identityType

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

  • jednostka SKU: jednostka SKU obszaru roboczego (określana także jako wersja). Aby uzyskać więcej informacji, zobacz Azure Machine Learning jednostek SKU.

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

  • hbiWorkspace: określa, czy dane klienta mają duży wpływ na działalność biznesową.

  • imageBuildCompute: element docelowy obliczeń dla kompilacji obrazu.

  • systemDatastoresAuthMode: określa, czy używać poświadczeń dla magazynów danych systemu obszaru roboczego "workspaceblobstore" i "workspacefilestore". Wartość domyślna to "accessKey". w takim przypadku obszar roboczy utworzy magazyny danych systemu z poświadczeniami. W przypadku wybrania opcji "tożsamość" w obszarze roboczym zostaną utworzone systemowe magazyny danych bez poświadczeń.

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

get_mlflow_tracking_uri

Pobierz identyfikator URI śledzenia MLflow dla obszaru roboczego.

MLflow ( https://mlflow.org/ ) to platforma Open Source służąca do śledzenia eksperymentów uczenia maszynowego i zarządzania modelami. Interfejsów API rejestrowania MLflow można użyć z Azure Machine Learning, aby metryki, modele i artefakty były rejestrowane w obszarze roboczym Azure Machine Learning.

get_mlflow_tracking_uri(_with_auth=False)

Parametry

_with_auth
<xref:bool>
wartość domyślna: False

PRZESTARZAŁE Dodaj informacje uwierzytelniania do śledzenia identyfikatora URI.

Zwraca

Identyfikator URI śledzenia zgodny z MLflow.

Typ zwracany

<xref:str>

Uwagi

Użyj poniższego przykładu, aby skonfigurować śledzenie MLflow do wysyłania danych do Obszar roboczy usługi ML platformy Azure:


   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

Identyfikator uruchomienia.

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.

Lista obszarów roboczych może być filtrowana na podstawie grupy zasobów.

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

Parametry

subscription_id
<xref:str>

Identyfikator subskrypcji, dla którego będą wystawiane 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 nie, zostaną użyte domyślne poświadczenia interfejsu wiersza polecenia platformy Azure lub interfejs API wyświetli monit o podanie poświadczeń.

resource_group
<xref:str>
wartość domyślna: None

Grupa zasobów służąca do filtrowania zwracanych obszarów roboczych. Jeśli nie, Metoda wyświetli listę wszystkich obszarów roboczych w ramach określonej subskrypcji.

Zwraca

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

Typ zwracany

<xref:dict>

list_connections

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

list_connections(category=None, target=None)

Parametry

type
<xref:str>
wartość domyślna: None

Typ tego połączenia, które będzie filtrowane

target
<xref:str>
wartość domyślna: None

element docelowy tego połączenia, który będzie filtrowany

list_keys

Wyświetl klucze dla bieżącego obszaru roboczego.

list_keys()

Typ zwracany

<xref:object>

set_connection

Dodaj lub zaktualizuj połączenie w obszarze roboczym.

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

Parametry

name
<xref:str>

Unikatowa nazwa połączenia w obszarze roboczym

category
<xref:str>

Kategoria tego połączenia

target
<xref:str>

element docelowy, z którym jest nawiązywane połączenie

authType
<xref:str>

Typ autoryzacji tego połączenia

value
<xref:str>

ciąg serializacji formatu JSON dla szczegółów połączenia

set_default_datastore

Ustaw domyślny magazyn danych dla obszaru roboczego.

set_default_datastore(name)

Parametry

name
<xref:str>

Nazwa, Datastore która ma zostać ustawiona jako domyślna.

setup

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

setup()

Zwraca

Obiekt obszaru roboczego.

Typ zwracany

sync_keys

Wyzwala możliwość natychmiastowego synchronizowania kluczy w obszarze roboczym.

Jeśli klucze dla dowolnego zasobu w obszarze roboczym zostaną zmienione, może upłynąć około godziny, zanim zostaną zaktualizowane automatycznie. Ta funkcja umożliwia zaktualizowanie kluczy na żądanie. Przykładowy scenariusz wymaga natychmiastowego dostępu do magazynu po ponownym generowaniu kluczy magazynu.

sync_keys()

Zwraca

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

Typ zwracany

<xref:None>

update

Aktualizowanie przyjaznej nazwy, opisu, tagów, obliczeń dla kompilacji obrazów i innych ustawień skojarzonych 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)

Parametry

friendly_name
<xref:str>
wartość domyślna: None

Przyjazna nazwa obszaru roboczego, który może być wyświetlany w interfejsie użytkownika.

description
<xref:str>
wartość domyślna: None

Opis obszaru roboczego.

tags
<xref:dict>
wartość domyślna: None

Tagi do skojarzenia z obszarem roboczym.

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

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

allow_public_access_when_behind_vnet
<xref:bool>
wartość domyślna: None

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

Zwraca

Słownik zaktualizowanych informacji.

Typ zwracany

<xref:dict>[<xref:str>, <xref:str>]

update_dependencies

Zaktualizuj istniejące zasoby związane z obszarem roboczym w następujących przypadkach.

a), gdy użytkownik przypadkowo usunie istniejący skojarzony zasób i chce go zaktualizować 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 chcą korzystać z istniejącego już z nich (dotyczy tylko rejestru kontenerów).

update_dependencies(container_registry=None, force=False)

Parametry

container_registry
<xref:str>
wartość domyślna: None

Identyfikator ARM dla rejestru kontenerów.

force
<xref:bool>
wartość domyślna: False

Jeśli Wymuś aktualizowanie zasobów zależnych bez potwierdzenia monitu.

write_config

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

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

Metoda zapewnia prosty sposób używania tego samego obszaru roboczego w wielu notesach lub projektach środowiska Python. Użytkownicy mogą zapisywać właściwości ARM obszaru roboczego za pomocą tej funkcji i używać from_config do ładowania tego samego obszaru roboczego w różnych notesach lub projektach w języku Python bez ponownego wpisywania właściwości ARM obszaru roboczego.

write_config(path=None, file_name=None)

Parametry

path
<xref:str>
wartość domyślna: None

Lokalizacja podana przez użytkownika w celu zapisania config.jspliku. Parametr domyślnie przyjmuje wartość ". Azure/" w bieżącym katalogu roboczym.

file_name
<xref:str>
wartość domyślna: None

Nazwa do użycia w pliku konfiguracji. Wartość domyślna parametru config.jswłączona.

Atrybuty

compute_targets

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

Zwraca

Słownik z kluczem jako nazwa docelowego obliczenia i wartość jako ComputeTarget obiekt.

Typ zwracany

<xref:dict>[<xref:str>, ComputeTarget]

datasets

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

Zwraca

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

Typ zwracany

<xref:dict>[<xref:str>, Dataset]

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 nazwa i wartość magazynu danych jako Datastore obiekt.

Typ zwracany

<xref:dict>[<xref:str>, Datastore]

discovery_url

Zwraca adres URL odnajdowania tego obszaru roboczego.

Zwraca

Adres URL odnajdywania tego obszaru roboczego.

Typ zwracany

<xref:str>

environments

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

Zwraca

Słownik z kluczem jako nazwa środowiska i wartość jako Środowisko obiekt.

Typ zwracany

<xref:dict>[<xref:str>, Środowisko]

experiments

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

Zwraca

Słownik z kluczem jako nazwa eksperymentu i wartość jako Experiment obiekt.

Typ zwracany

<xref:dict>[<xref:str>, Experiment]

images

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

Podnosi, WebserviceException czy wystąpił problem podczas korzystania z usługi zarządzania modelami.

Zwraca

Słownik z kluczem jako nazwa obrazu i wartość jako Image obiekt.

Typ zwracany

<xref:dict>[<xref:str>, Image]

Wyjątki

Wystąpił problem podczas korzystania z usługi zarządzania modelami.

linked_services

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

Zwraca

Słownik, gdzie klucz jest nazwą połączonej usługi, a wartość jest LinkedService obiektem.

Typ zwracany

<xref:dict>[<xref:str>, LinkedService]

location

Zwróć lokalizację tego obszaru roboczego.

Zwraca

Lokalizacja tego obszaru roboczego.

Typ zwracany

<xref:str>

models

Zwraca listę modeli w obszarze roboczym.

Podnosi, WebserviceException czy wystąpił problem podczas korzystania z usługi zarządzania modelami.

Zwraca

Słownik modelu z kluczem jako nazwa modelu i wartość jako Model obiekt.

Typ zwracany

<xref:dict>[<xref:str>, Model]

Wyjątki

Wystąpił problem podczas korzystania z usługi zarządzania modelami.

name

Zwróć nazwę obszaru roboczego.

Zwraca

Nazwa obszaru roboczego.

Typ zwracany

<xref:str>

private_endpoints

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

Zwraca

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

Typ zwracany

<xref:dict>[<xref:str>, PrivateEndPoint]

resource_group

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

Zwraca

Nazwa grupy zasobów.

Typ zwracany

<xref: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

<xref:str>

subscription_id

Zwróć Identyfikator subskrypcji dla tego obszaru roboczego.

Zwraca

Identyfikator subskrypcji.

Typ zwracany

<xref:str>

tags

Zwróć Tagi tego obszaru roboczego.

Zwraca

Tagi tego obszaru roboczego.

Typ zwracany

<xref:dict>

webservices

Zwraca listę usług WebService w obszarze roboczym.

Podnosi wartość, jeśli wystąpił WebserviceException problem z zwróceniem listy.

Zwraca

Lista usług WebService w obszarze roboczym.

Typ zwracany

<xref:dict>[<xref:str>, Webservice]

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'