Sdílet prostřednictvím

Workspace Třída

  • Reference

Definuje prostředek služby Azure Machine Learning pro správu artefaktů trénování a nasazení.

Pracovní prostor je základním prostředkem pro strojové učení ve službě Azure Machine Learning. Pracovní prostor slouží k experimentování, trénování a nasazování modelů strojového učení. Každý pracovní prostor je svázán s předplatným a skupinou prostředků Azure a má přidruženou skladovou položku.

Další informace o pracovních prostorech najdete tady:

Konstruktor pracovního prostoru třídy pro načtení existujícího pracovního prostoru služby Azure Machine Learning.

Dědičnost
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

Name Description
subscription_id
Vyžadováno
str

ID předplatného Azure obsahující pracovní prostor.
resource_group
Vyžadováno
str

Skupina prostředků obsahující pracovní prostor.
workspace_name
Vyžadováno
str

Název existujícího pracovního prostoru.
auth
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication nebo MsiAuthentication

Objekt ověřování. Další podrobnosti najdete v tématu https://aka.ms/aml-notebook-auth. Pokud žádné, použijí se výchozí přihlašovací údaje Azure CLI nebo rozhraní API vyzve k zadání přihlašovacích údajů.

Default value: None
_location
str

Pouze interní použití.

Default value: None
_disable_service_check
bool

Pouze interní použití.

Default value: False
_workspace_id
str

Pouze interní použití.

Default value: None
sku
str

Parametr je k dispozici pro zpětnou kompatibilitu a je ignorován.

Default value: basic
_cloud
str

Pouze interní použití.

Default value: AzureCloud
subscription_id
Vyžadováno
str

ID předplatného Azure obsahující pracovní prostor.
resource_group
Vyžadováno
str

Skupina prostředků obsahující pracovní prostor.
workspace_name
Vyžadováno
str

Název pracovního prostoru. Název musí být dlouhý 2 až 32 znaků. První znak názvu musí být alfanumerický (písmeno nebo číslo), ale zbytek názvu může obsahovat alfanumerické znaky, spojovníky a podtržítka. Prázdné znaky nejsou povoleny.
auth
Vyžadováno
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication nebo MsiAuthentication

Objekt ověřování. Další podrobnosti najdete v tématu https://aka.ms/aml-notebook-auth. Pokud žádné, použijí se výchozí přihlašovací údaje Azure CLI nebo rozhraní API vyzve k zadání přihlašovacích údajů.
_location
Vyžadováno
str

Pouze interní použití.
_disable_service_check
Vyžadováno
bool

Pouze interní použití.
_workspace_id
Vyžadováno
str

Pouze interní použití.
sku
Vyžadováno
str

Parametr je k dispozici pro zpětnou kompatibilitu a je ignorován.
tags
dict

Značky, které chcete přidružit k pracovnímu prostoru.

Default value: None
_cloud
Vyžadováno
str

Pouze interní použití.

Poznámky

Následující ukázka ukazuje, jak vytvořit pracovní prostor.


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

Pokud máte existující skupinu prostředků Azure, kterou chcete použít pro pracovní prostor, nastavte create_resource_group na Hodnotu False.

Pokud chcete použít stejný pracovní prostor ve více prostředích, vytvořte konfigurační soubor JSON. Konfigurační soubor uloží název vašeho předplatného, prostředku a pracovního prostoru, aby je bylo možné snadno načíst. Chcete-li uložit konfiguraci, použijte metodu write_config .


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

Příklad konfiguračního souboru najdete v tématu Vytvoření konfiguračního souboru pracovního prostoru .

Pokud chcete načíst pracovní prostor z konfiguračního souboru, použijte metodu from_config .


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

Případně můžete použít metodu get k načtení existujícího pracovního prostoru bez použití konfiguračních souborů.


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

Výše uvedené ukázky vás můžou vyzvat k zadání přihlašovacích údajů Azure pomocí interaktivního dialogového okna pro přihlášení. Další případy použití, včetně použití Azure CLI k ověřování a ověřování v automatizovaných pracovních postupech, najdete v tématu Ověřování ve službě Azure Machine Learning.

Metody

add_private_endpoint

Přidejte do pracovního prostoru privátní koncový bod.
create

Vytvořte nový pracovní prostor služby Azure Machine Learning.

Vyvolá výjimku, pokud pracovní prostor již existuje nebo nejsou splněny některé z požadavků pracovního prostoru.
delete

Odstraňte prostředky přidružené k pracovnímu prostoru Služby Azure Machine Learning.
delete_connection

Odstraňte připojení pracovního prostoru.
delete_private_endpoint_connection

Odstraňte připojení privátního koncového bodu k pracovnímu prostoru.
diagnose_workspace

Diagnostika problémů s nastavením pracovního prostoru
from_config

Vrácení objektu pracovního prostoru z existujícího pracovního prostoru služby Azure Machine Learning

Načte konfiguraci pracovního prostoru ze souboru. Vyvolá výjimku, pokud konfigurační soubor nelze najít.

Metoda poskytuje jednoduchý způsob, jak znovu použít stejný pracovní prostor v několika poznámkových blocích nebo projektech Pythonu. Uživatelé můžou uložit vlastnosti pracovního prostoru Azure Resource Manager (ARM) pomocí write_config metody a tuto metodu použít k načtení stejného pracovního prostoru v různých poznámkových blocích nebo projektech Pythonu, aniž by museli přetypovat vlastnosti ARM pracovního prostoru.
get

Vrácení objektu pracovního prostoru pro existující pracovní prostor služby Azure Machine Learning

Vyvolá výjimku, pokud pracovní prostor neexistuje nebo požadovaná pole jednoznačně neidentifikují pracovní prostor.
get_connection

Získejte připojení pracovního prostoru.
get_default_compute_target

Získejte výchozí cílový výpočetní objekt pro pracovní prostor.
get_default_datastore

Získejte výchozí úložiště dat pro pracovní prostor.
get_default_keyvault

Získejte výchozí objekt trezoru klíčů pro pracovní prostor.
get_details

Vrátí podrobnosti pracovního prostoru.
get_mlflow_tracking_uri

Získejte identifikátor URI sledování MLflow pro pracovní prostor.

MLflow (https://mlflow.org/) je opensourcová platforma pro sledování experimentů strojového učení a správu modelů. Rozhraní API protokolování MLflow můžete použít se službou Azure Machine Learning, aby se metriky, modely a artefakty protokolovaly do pracovního prostoru služby Azure Machine Learning.
get_run

Vraťte spuštění se zadanými run_id v pracovním prostoru.
list

Zobrazí seznam všech pracovních prostorů, ke kterým má uživatel v rámci předplatného přístup.

Seznam pracovních prostorů je možné filtrovat na základě skupiny prostředků.
list_connections

Vypište připojení v rámci tohoto pracovního prostoru.
list_keys

Vypíše klíče pro aktuální pracovní prostor.
set_connection

Přidejte nebo aktualizujte připojení v pracovním prostoru.
set_default_datastore

Nastavte výchozí úložiště dat pro pracovní prostor.
setup

Vytvořte nový pracovní prostor nebo načtěte existující pracovní prostor.
sync_keys

Aktivuje pracovní prostor pro okamžitou synchronizaci klíčů.

Pokud se změní klíče pro jakýkoli prostředek v pracovním prostoru, může jejich automatická aktualizace trvat přibližně hodinu. Tato funkce umožňuje aktualizaci klíčů na vyžádání. Ukázkový scénář vyžaduje okamžitý přístup k úložišti po opětovném vygenerování klíčů úložiště.
update

Aktualizujte popisný název, popis, značky, výpočetní prostředky sestavení image a další nastavení přidružená k pracovnímu prostoru.
update_dependencies

V následujících případech aktualizujte existující přidružené prostředky pro pracovní prostor.

a) Když uživatel omylem odstraní existující přidružený prostředek a chce ho aktualizovat novým, aniž by musel znovu vytvořit celý pracovní prostor. b) Když má uživatel existující přidružený prostředek a chce nahradit ten aktuální, který je přidružený k pracovnímu prostoru. c) Pokud přidružený prostředek ještě není vytvořený a chce použít existující prostředek, který už má (platí jenom pro registr kontejneru).
write_config

Zapište vlastnosti pracovního prostoru Azure Resource Manager (ARM) do konfiguračního souboru.

Vlastnosti ARM pracovního prostoru je možné načíst později pomocí from_config metody . Výchozí path hodnota je .azureml/ v aktuálním pracovním adresáři a file_name výchozí hodnota je config.json.

Metoda poskytuje jednoduchý způsob opakovaného použití stejného pracovního prostoru v několika poznámkových blocích nebo projektech Pythonu. Uživatelé můžou pomocí této funkce uložit vlastnosti ARM pracovního prostoru a použít from_config k načtení stejného pracovního prostoru v různých poznámkových blocích nebo projektech Pythonu, aniž by museli znovu zadávat vlastnosti ARM pracovního prostoru.

add_private_endpoint

Přidejte do pracovního prostoru privátní koncový bod.

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

Parametry

Name Description
private_endpoint_config
Vyžadováno
PrivateEndPointConfig

Konfigurace privátního koncového bodu pro vytvoření privátního koncového bodu do pracovního prostoru
private_endpoint_auto_approval
bool

Logický příznak, který označuje, jestli se má vytvoření privátního koncového bodu automaticky schválit nebo ručně schválit z Azure Private Link Center. V případě ručního schválení můžou uživatelé zobrazit čekající žádost na portálu Private Link a žádost schválit nebo odmítnout.

Default value: True
location
string

Umístění privátního koncového bodu, výchozí je umístění pracovního prostoru.

Default value: None
show_output
bool

Příznak pro zobrazení průběhu vytváření pracovního prostoru

Default value: True
tags
dict

Značky, které chcete přidružit k pracovnímu prostoru.

Default value: None

Návraty

Typ Description
PrivateEndPoint

Objekt PrivateEndPoint byl vytvořen.

create

Vytvořte nový pracovní prostor služby Azure Machine Learning.

Vyvolá výjimku, pokud pracovní prostor již existuje nebo nejsou splněny některé z požadavků pracovního prostoru.

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 Description
name
Vyžadováno
str

Název nového pracovního prostoru. Název musí být dlouhý 2 až 32 znaků. První znak názvu musí být alfanumerický (písmeno nebo číslo), ale zbytek názvu může obsahovat alfanumerické znaky, spojovníky a podtržítka. Prázdné znaky nejsou povoleny.
auth
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication

Objekt ověřování. Další podrobnosti najdete v tématu https://aka.ms/aml-notebook-auth. Pokud žádné, použijí se výchozí přihlašovací údaje Azure CLI nebo rozhraní API vyzve k zadání přihlašovacích údajů.

Default value: None
subscription_id
str

ID předplatného obsahujícího předplatného pro nový pracovní prostor. Parametr se vyžaduje, pokud má uživatel přístup k více než jednomu předplatnému.

Default value: None
resource_group
str

Skupina prostředků Azure, která obsahuje pracovní prostor. Parametr ve výchozím nastavení představuje mutaci názvu pracovního prostoru.

Default value: None
location
str

Umístění pracovního prostoru. Výchozí parametr je umístění skupiny prostředků. Umístění musí být podporovanou oblastí pro Azure Machine Learning.

Default value: None
create_resource_group
bool

Určuje, jestli se má vytvořit skupina prostředků, pokud neexistuje.

Default value: True
sku
str

Parametr je k dispozici pro zpětnou kompatibilitu a je ignorován.

Default value: basic
tags
dict

Značky, které chcete přidružit k pracovnímu prostoru.

Default value: None
friendly_name
str

Volitelný popisný název pracovního prostoru, který se dá zobrazit v uživatelském rozhraní.

Default value: None
storage_account
str

Existující účet úložiště ve formátu ID prostředku Azure. Úložiště bude pracovní prostor používat k ukládání výstupů spuštění, kódu, protokolů atd. Pokud žádný, vytvoří se nový účet úložiště.

Default value: None
key_vault
str

Existující trezor klíčů ve formátu ID prostředku Azure Podrobnosti o formátu ID prostředku Azure najdete v následujícím příkladu kódu. Trezor klíčů použije pracovní prostor k ukládání přihlašovacích údajů, které do pracovního prostoru přidali uživatelé. Pokud žádný, vytvoří se nový trezor klíčů.

Default value: None
app_insights
str

Existující Application Insights ve formátu ID prostředku Azure. Podrobnosti o formátu ID prostředku Azure najdete v následujícím příkladu kódu. Application Insights bude pracovní prostor používat k protokolování událostí webových služeb. Pokud žádné, vytvoří se nový Application Insights.

Default value: None
container_registry
str

Existující registr kontejneru ve formátu ID prostředku Azure (podrobnosti o formátu ID prostředku Azure najdete v příkladu kódu níže). Registr kontejneru bude pracovním prostorem používat k načítání a vkládání imagí experimentování a webových služeb. Pokud žádný, vytvoří se nový registr kontejneru jenom v případě potřeby, a ne společně s vytvořením pracovního prostoru.

Default value: None
adb_workspace
str

Existující pracovní prostor Adb ve formátu ID prostředku Azure (podrobnosti o formátu ID prostředku Azure najdete v příkladu kódu níže). Pracovní prostor Adb se použije k propojení s pracovním prostorem. Pokud žádné, propojení s pracovním prostorem se nezobrazí.

Default value: None
primary_user_assigned_identity
str

ID prostředku identity přiřazené uživatelem, která se použila k reprezentaci pracovního prostoru

Default value: None
cmk_keyvault
str

Trezor klíčů obsahující klíč spravovaný zákazníkem ve formátu ID prostředku Azure: /subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Příklad: /subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault' Další podrobnosti o formátu ID prostředku Azure najdete v ukázkovém kódu v poznámkách níže.

Default value: None
resource_cmk_uri
str

Identifikátor URI klíče spravovaného zákazníkem pro šifrování neaktivních uložených dat Formát identifikátoru URI je: https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Například 'https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b'. https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal Postup vytvoření klíče a získání jeho identifikátoru URI najdete v tématu.

Default value: None
hbi_workspace
bool

Určuje, jestli pracovní prostor obsahuje data HBI (High Business Impact), tj. obsahuje citlivé obchodní informace. Tento příznak lze nastavit pouze při vytváření pracovního prostoru. Jeho hodnotu nelze po vytvoření pracovního prostoru změnit. Výchozí hodnota je False.

Pokud je nastavená hodnota True, provedou se další kroky šifrování a v závislosti na komponentě sady SDK se vydají redigované informace v interně shromažďované telemetrii. Další informace najdete v tématu Šifrování dat.

Pokud je tento příznak nastavený na Hodnotu True, může to mít větší potíže s řešením potíží. Může k tomu dojít proto, že microsoftu neodesílají určitou telemetrii a je v něm menší přehled o úspěšnosti nebo typech problémů, a proto nemusí být možné reagovat tak proaktivně, když má tento příznak hodnotu True. Doporučení je použít výchozí hodnotu False pro tento příznak, pokud není nezbytně nutné, aby byla pravda.

Default value: False
default_cpu_compute_target
AmlComputeProvisioningConfiguration

(ZASTARALÉ) Konfigurace, která se použije k vytvoření výpočetních prostředků procesoru. Výchozí parametr je {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Pokud žádný, nebudou vytvořeny žádné výpočetní prostředky.

Default value: None
default_gpu_compute_target
AmlComputeProvisioningConfiguration

(ZASTARALÉ) Konfigurace, která se použije k vytvoření výpočetních prostředků GPU. Výchozí parametr je {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Pokud žádný, nebudou vytvořeny žádné výpočetní prostředky.

Default value: None
private_endpoint_config
PrivateEndPointConfig

Konfigurace privátního koncového bodu pro vytvoření privátního koncového bodu do pracovního prostoru Azure ML

Default value: None
private_endpoint_auto_approval
bool

Logický příznak, který označuje, jestli se má vytvoření privátního koncového bodu automaticky schválit nebo ručně schválit z Azure Private Link Center. V případě ručního schválení můžou uživatelé zobrazit čekající žádost na portálu Private Link a žádost schválit nebo odmítnout.

Default value: True
exist_ok
bool

Označuje, zda je tato metoda úspěšná, pokud pracovní prostor již existuje. Pokud je false, tato metoda selže, pokud pracovní prostor existuje. Pokud je true, vrátí tato metoda existující pracovní prostor, pokud existuje.

Default value: False
show_output
bool

Určuje, zda tato metoda bude tisknout přírůstkový průběh.

Default value: True
user_assigned_identity_for_cmk_encryption
str

ID prostředku identity přiřazené uživatelem, které je potřeba použít pro přístup ke klíči správy zákazníka

Default value: None
system_datastores_auth_mode
str

Určuje, zda se mají použít přihlašovací údaje pro systémová úložiště dat pracovního prostoru "workspaceblobstore" a "workspacefilestore". Výchozí hodnota je accessKey. V takovém případě pracovní prostor vytvoří systémová úložiště dat s přihlašovacími údaji. Pokud je nastavená identita, pracovní prostor vytvoří systémová úložiště dat bez přihlašovacích údajů.

Default value: accessKey
v1_legacy_mode
bool

Zabránění použití služby ROZHRANÍ API v2 ve veřejné službě Azure Resource Manager

Default value: None

Návraty

Typ Description
Workspace

Objekt pracovního prostoru.

Výjimky

Typ Description
WorkspaceException

Vyvolána kvůli problémům s vytvořením pracovního prostoru.

Poznámky

Tento první příklad vyžaduje pouze minimální specifikaci a všechny závislé prostředky i skupina prostředků se vytvoří automaticky.


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

Následující příklad ukazuje, jak znovu použít existující prostředky Azure s využitím formátu ID prostředku Azure. Konkrétní ID prostředků Azure je možné načíst prostřednictvím webu Azure Portal nebo sady SDK. Předpokládá se, že skupina prostředků, účet úložiště, trezor klíčů, App Insights a registr kontejneru už existují.


   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

Odstraňte prostředky přidružené k pracovnímu prostoru Služby Azure Machine Learning.

delete(delete_dependent_resources=False, no_wait=False)

Parametry

Name Description
delete_dependent_resources
bool

Jestli chcete odstranit prostředky přidružené k pracovnímu prostoru, tj. registr kontejneru, účet úložiště, trezor klíčů a Application Insights. Výchozí hodnota je Nepravda. Pokud chcete tyto prostředky odstranit, nastavte na Hodnotu True.

Default value: False
no_wait
bool

Jestli se má počkat na dokončení odstranění pracovního prostoru.

Default value: False

Návraty

Typ Description
None

Žádný v případě úspěchu; v opačném případě vyvolá chybu.

delete_connection

Odstraňte připojení pracovního prostoru.

delete_connection(name)

Parametry

Name Description
name
Vyžadováno
str

Jedinečný název připojení v pracovním prostoru

delete_private_endpoint_connection

Odstraňte připojení privátního koncového bodu k pracovnímu prostoru.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parametry

Name Description
private_endpoint_connection_name
Vyžadováno
str

Jedinečný název připojení privátního koncového bodu v pracovním prostoru

diagnose_workspace

Diagnostika problémů s nastavením pracovního prostoru

diagnose_workspace(diagnose_parameters)

Parametry

Name Description
diagnose_parameters
Vyžadováno
<xref:_restclient.models.DiagnoseWorkspaceParameters>

Parametr diagnostiky stavu pracovního prostoru

Návraty

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

Instance AzureOperationPoller, která vrací DiagnoseResponseResult

from_config

Vrácení objektu pracovního prostoru z existujícího pracovního prostoru služby Azure Machine Learning

Načte konfiguraci pracovního prostoru ze souboru. Vyvolá výjimku, pokud konfigurační soubor nelze najít.

Metoda poskytuje jednoduchý způsob, jak znovu použít stejný pracovní prostor v několika poznámkových blocích nebo projektech Pythonu. Uživatelé můžou uložit vlastnosti pracovního prostoru Azure Resource Manager (ARM) pomocí write_config metody a tuto metodu použít k načtení stejného pracovního prostoru v různých poznámkových blocích nebo projektech Pythonu, aniž by museli přetypovat vlastnosti ARM pracovního prostoru.

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

Parametry

Name Description
path
str

Cesta ke konfiguračnímu souboru nebo počátečnímu adresáři, který chcete vyhledat. Parametr ve výchozím nastavení spustí vyhledávání v aktuálním adresáři.

Default value: None
auth
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication

Objekt ověřování. Další podrobnosti najdete v tématu https://aka.ms/aml-notebook-auth. Pokud žádné, použijí se výchozí přihlašovací údaje Azure CLI nebo rozhraní API vyzve k zadání přihlašovacích údajů.

Default value: None
_logger
Logger

Umožňuje přepsání výchozího protokolovacího nástroje.

Default value: None
_file_name
str

Umožňuje přepsání názvu konfiguračního souboru, aby se vyhledaly, když je cesta k adresáři.

Default value: None

Návraty

Typ Description
Workspace

Objekt pracovního prostoru pro existující pracovní prostor Azure ML.

get

Vrácení objektu pracovního prostoru pro existující pracovní prostor služby Azure Machine Learning

Vyvolá výjimku, pokud pracovní prostor neexistuje nebo požadovaná pole jednoznačně neidentifikují pracovní prostor.

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

Parametry

Name Description
name
Vyžadováno
str

Název pracovního prostoru, který chcete získat.
auth
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication

Objekt ověřování. Další podrobnosti najdete v tématu https://aka.ms/aml-notebook-auth. Pokud žádné, použijí se výchozí přihlašovací údaje Azure CLI nebo rozhraní API vyzve k zadání přihlašovacích údajů.

Default value: None
subscription_id
str

ID předplatného, které se má použít. Parametr se vyžaduje, pokud má uživatel přístup k více než jednomu předplatnému.

Default value: None
resource_group
str

Skupina prostředků, která se má použít. Pokud žádná, metoda prohledá všechny skupiny prostředků v předplatném.

Default value: None
location
str

Umístění pracovního prostoru.

Default value: None
cloud
str

Název cílového cloudu. Může to být AzureCloud, AzureChinaCloud nebo AzureUSGovernment. Pokud není zadaný žádný cloud, použije se AzureCloud.

Default value: AzureCloud
id
str

ID pracovního prostoru.

Default value: None

Návraty

Typ Description
Workspace

Objekt pracovního prostoru.

get_connection

Získejte připojení pracovního prostoru.

get_connection(name)

Parametry

Name Description
name
Vyžadováno
str

Jedinečný název připojení v rámci pracovního prostoru

get_default_compute_target

Získejte výchozí cílový výpočetní objekt pro pracovní prostor.

get_default_compute_target(type)

Parametry

Name Description
type
Vyžadováno
str

Typ výpočetních prostředků. Možné hodnoty jsou CPU nebo GPU.

Návraty

Typ Description
ComputeTarget

Výchozí cílový výpočetní objekt pro daný typ výpočetních prostředků.

get_default_datastore

Získejte výchozí úložiště dat pro pracovní prostor.

get_default_datastore()

Návraty

Typ Description
Datastore

Výchozí úložiště dat.

get_default_keyvault

Získejte výchozí objekt trezoru klíčů pro pracovní prostor.

get_default_keyvault()

Návraty

Typ Description
Keyvault

Objekt KeyVault přidružený k pracovnímu prostoru.

get_details

Vrátí podrobnosti pracovního prostoru.

get_details()

Návraty

Typ Description
dict[str, str]

Podrobnosti o pracovním prostoru ve formátu slovníku

Poznámky

Vrácený slovník obsahuje následující páry klíč-hodnota.

  • id: Identifikátor URI odkazující na tento prostředek pracovního prostoru obsahující ID předplatného, skupinu prostředků a název pracovního prostoru.

  • name: Název tohoto pracovního prostoru.

  • umístění: Oblast pracovního prostoru.

  • type: Identifikátor URI ve formátu {providerName}/workspaces.

  • tags: Aktuálně se nepoužívá.

  • workspaceid: ID tohoto pracovního prostoru.

  • description: Aktuálně se nepoužívá.

  • friendlyName: Popisný název pracovního prostoru zobrazený v uživatelském rozhraní.

  • creationTime: Čas vytvoření tohoto pracovního prostoru ve formátu ISO8601.

  • containerRegistry: Registr kontejneru pracovního prostoru, který se používá k načítání a odesílání imagí experimentů i imagí webových služeb.

  • keyVault: Trezor klíčů pracovního prostoru, který slouží k ukládání přihlašovacích údajů přidaných do pracovního prostoru uživateli.

  • applicationInsights: Application Insights bude pracovní prostor používat k protokolování událostí webových služeb.

  • identityPrincipalId:

  • id tenanta identity

  • identityType

  • storageAccount: Úložiště bude pracovní prostor používat k ukládání výstupů spuštění, kódu, protokolů atd.

  • SKU: Skladová položka pracovního prostoru (označovaná také jako edice). Parametr je k dispozici kvůli zpětné kompatibilitě a je ignorován.

  • resourceCmkUri: Identifikátor URI klíče spravovaného zákazníkem pro šifrování neaktivních uložených dat. https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 Postup vytvoření klíče a získání jeho identifikátoru URI najdete v tématu .

  • hbiWorkspace: Určuje, jestli mají zákaznická data velký dopad na firmu.

  • imageBuildCompute: Cílový výpočetní objekt pro sestavení image.

  • systemDatastoresAuthMode: Určuje, jestli se mají použít přihlašovací údaje pro systémová úložiště dat pracovního prostoru workspaceblobstore a workspacefilestore. Výchozí hodnota je accessKey. V takovém případě pracovní prostor vytvoří systémová úložiště dat s přihlašovacími údaji. Pokud je nastavená hodnota identity, pracovní prostor vytvoří systémová úložiště dat bez přihlašovacích údajů.

Další informace o těchto párech klíč-hodnota najdete v tématu create.

get_mlflow_tracking_uri

Získejte identifikátor URI sledování MLflow pro pracovní prostor.

MLflow (https://mlflow.org/) je opensourcová platforma pro sledování experimentů strojového učení a správu modelů. Rozhraní API protokolování MLflow můžete použít se službou Azure Machine Learning, aby se metriky, modely a artefakty protokolovaly do pracovního prostoru služby Azure Machine Learning.

get_mlflow_tracking_uri(_with_auth=False)

Parametry

Name Description
_with_auth
bool

(ZASTARALÉ) Přidání ověřovacích informací do sledovacího identifikátoru URI

Default value: False

Návraty

Typ Description
str

Identifikátor URI sledování kompatibilní s MLflow.

Poznámky

Pomocí následující ukázky nakonfigurujte sledování MLflow tak, aby odesílala data do pracovního prostoru Azure ML:


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

get_run

Vraťte spuštění se zadanými run_id v pracovním prostoru.

get_run(run_id)

Parametry

Name Description
run_id
Vyžadováno
string

ID spuštění.

Návraty

Typ Description
Run

Odeslané spuštění.

list

Zobrazí seznam všech pracovních prostorů, ke kterým má uživatel v rámci předplatného přístup.

Seznam pracovních prostorů je možné filtrovat na základě skupiny prostředků.

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

Parametry

Name Description
subscription_id
Vyžadováno
str

ID předplatného, pro které chcete vypsat pracovní prostory.
auth
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication

Objekt ověřování. Další podrobnosti najdete v tématu https://aka.ms/aml-notebook-auth. Pokud žádné, použijí se výchozí přihlašovací údaje Azure CLI nebo rozhraní API vyzve k zadání přihlašovacích údajů.

Default value: None
resource_group
str

Skupina prostředků pro filtrování vrácených pracovních prostorů. Pokud žádná, metoda zobrazí seznam všech pracovních prostorů v rámci zadaného předplatného.

Default value: None

Návraty

Typ Description
dict

Slovník, kde klíč je název pracovního prostoru a hodnota je seznam objektů pracovního prostoru.

list_connections

Vypište připojení v rámci tohoto pracovního prostoru.

list_connections(category=None, target=None)

Parametry

Name Description
type
Vyžadováno
str

Typ tohoto připojení, podle kterého se bude filtrovat
target
str

cíl tohoto připojení, na který se bude filtrovat

Default value: None
category
Default value: None

list_keys

Vypíše klíče pro aktuální pracovní prostor.

list_keys()

Návraty

Typ Description
object

set_connection

Přidejte nebo aktualizujte připojení v pracovním prostoru.

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

Parametry

Name Description
name
Vyžadováno
str

Jedinečný název připojení v rámci pracovního prostoru
category
Vyžadováno
str

Kategorie tohoto připojení
target
Vyžadováno
str

cíl, ke které se toto připojení připojuje
authType
Vyžadováno
str

typ autorizace tohoto připojení
value
Vyžadováno
str

řetězec serializace formátu JSON podrobností o připojení

set_default_datastore

Nastavte výchozí úložiště dat pro pracovní prostor.

set_default_datastore(name)

Parametry

Name Description
name
Vyžadováno
str

Název, který Datastore se má nastavit jako výchozí.

setup

Vytvořte nový pracovní prostor nebo načtěte existující pracovní prostor.

static setup()

Návraty

Typ Description
Workspace

Objekt pracovního prostoru.

sync_keys

Aktivuje pracovní prostor pro okamžitou synchronizaci klíčů.

Pokud se změní klíče pro jakýkoli prostředek v pracovním prostoru, může jejich automatická aktualizace trvat přibližně hodinu. Tato funkce umožňuje aktualizaci klíčů na vyžádání. Ukázkový scénář vyžaduje okamžitý přístup k úložišti po opětovném vygenerování klíčů úložiště.

sync_keys(no_wait=False)

Parametry

Name Description
no_wait
bool

Jestli se má čekat na dokončení klíčů synchronizace pracovního prostoru.

Default value: False

Návraty

Typ Description
None

Žádný v případě úspěchu; v opačném případě vyvolá chybu.

update

Aktualizujte popisný název, popis, značky, výpočetní prostředky sestavení image a další nastavení přidružená k pracovnímu prostoru.

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

Name Description
friendly_name
str

Popisný název pracovního prostoru, který se dá zobrazit v uživatelském rozhraní.

Default value: None
description
str

Popis pracovního prostoru.

Default value: None
tags
dict

Značky, které chcete přidružit k pracovnímu prostoru.

Default value: None
image_build_compute
str

Název výpočetních prostředků pro sestavení image.

Default value: None
service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>

Nastavení prostředků spravovaných službou.

Default value: None
primary_user_assigned_identity
str

ID prostředku identity přiřazené uživatelem, které představuje identitu pracovního prostoru.

Default value: None
allow_public_access_when_behind_vnet
bool

Povolit veřejný přístup k pracovnímu prostoru privátního propojení

Default value: None
v1_legacy_mode
bool

Zabránění používání služby ROZHRANÍ API v2 ve veřejné službě Azure Resource Manager

Default value: None

Návraty

Typ Description
dict[str, str]

Slovník aktualizovaných informací.

update_dependencies

V následujících případech aktualizujte existující přidružené prostředky pro pracovní prostor.

a) Když uživatel omylem odstraní existující přidružený prostředek a chce ho aktualizovat novým, aniž by musel znovu vytvořit celý pracovní prostor. b) Když má uživatel existující přidružený prostředek a chce nahradit ten aktuální, který je přidružený k pracovnímu prostoru. c) Pokud přidružený prostředek ještě není vytvořený a chce použít existující prostředek, který už má (platí jenom pro registr kontejneru).

update_dependencies(container_registry=None, force=False)

Parametry

Name Description
container_registry
str

ID ARM pro registr kontejneru.

Default value: None
force
bool

Pokud vynutíte aktualizaci závislých prostředků bez výzvy k potvrzení.

Default value: False

Návraty

Typ Description
Workspace

write_config

Zapište vlastnosti pracovního prostoru Azure Resource Manager (ARM) do konfiguračního souboru.

Vlastnosti ARM pracovního prostoru je možné načíst později pomocí from_config metody . Výchozí path hodnota je .azureml/ v aktuálním pracovním adresáři a file_name výchozí hodnota je config.json.

Metoda poskytuje jednoduchý způsob opakovaného použití stejného pracovního prostoru v několika poznámkových blocích nebo projektech Pythonu. Uživatelé můžou pomocí této funkce uložit vlastnosti ARM pracovního prostoru a použít from_config k načtení stejného pracovního prostoru v různých poznámkových blocích nebo projektech Pythonu, aniž by museli znovu zadávat vlastnosti ARM pracovního prostoru.

write_config(path=None, file_name=None)

Parametry

Name Description
path
str

Uživatel zadal umístění pro zápis souboru config.json. Parametr má v aktuálním pracovním adresáři výchozí hodnotu .azureml/.

Default value: None
file_name
str

Název, který se má použít pro konfigurační soubor. Výchozí parametr je config.json.

Default value: None

Atributy

compute_targets

Zobrazí seznam všech cílových výpočetních prostředků v pracovním prostoru.

Návraty

Typ Description
dict[str, ComputeTarget]

Slovník s klíčem jako názvem cílového výpočetního objektu a hodnotou jako ComputeTarget objektem.

datasets

Výpis všech datových sad v pracovním prostoru

Návraty

Typ Description
dict[str, Dataset]

Slovník s klíčem jako názvem datové sady a hodnotou jako Dataset objektu.

datastores

Zobrazí seznam všech úložišť dat v pracovním prostoru. Tato operace nevrací přihlašovací údaje úložišť dat.

Návraty

Typ Description
dict[str, Datastore]

Slovník s klíčem jako názvem úložiště dat a hodnotou jako Datastore objektu.

discovery_url

Vraťte adresu URL zjišťování tohoto pracovního prostoru.

Návraty

Typ Description
str

Adresa URL zjišťování tohoto pracovního prostoru.

environments

Vypíše všechna prostředí v pracovním prostoru.

Návraty

Typ Description
dict[str, Environment]

Slovník s klíčem jako názvem prostředí a hodnotou jako Environment objektu.

experiments

Zobrazí seznam všech experimentů v pracovním prostoru.

Návraty

Typ Description
dict[str, Experiment]

Slovník s klíčem jako názvem experimentu a hodnotou jako Experiment objektu.

images

Vrátí seznam obrázků v pracovním prostoru.

Vyvolá problém WebserviceException v případě, že došlo k problému při interakci se službou správy modelů.

Návraty

Typ Description
dict[str, Image]

Slovník s klíčem jako názvem obrázku a hodnotou jako Image objektu.

Výjimky

Typ Description
WebserviceException

Při interakci se službou pro správu modelů došlo k problému.

linked_services

Zobrazí seznam všech propojených služeb v pracovním prostoru.

Návraty

Typ Description
dict[str, LinkedService]

Slovník, kde klíč je propojený název služby a hodnota je LinkedService objekt.

location

Vrátí umístění tohoto pracovního prostoru.

Návraty

Typ Description
str

Umístění tohoto pracovního prostoru.

models

Vrátí seznam modelů v pracovním prostoru.

Vyvolá problém WebserviceException v případě, že došlo k problému při interakci se službou správy modelů.

Návraty

Typ Description
dict[str, Model]

Slovník modelu s klíčem jako názvem modelu a hodnotou jako Model objektem.

Výjimky

Typ Description
WebserviceException

Při interakci se službou pro správu modelů došlo k problému.

name

Vraťte název pracovního prostoru.

Návraty

Typ Description
str

Název pracovního prostoru.

private_endpoints

Zobrazí seznam všech privátních koncových bodů pracovního prostoru.

Návraty

Typ Description
dict[str, PrivateEndPoint]

Dikt objektů PrivateEndPoint přidružených k pracovnímu prostoru. Klíč je název privátního koncového bodu.

resource_group

Vraťte název skupiny prostředků pro tento pracovní prostor.

Návraty

Typ Description
str

Název skupiny prostředků.

service_context

Vraťte kontext služby pro tento pracovní prostor.

Návraty

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

Vrátí ServiceContext objekt.

sku

Vraťte skladovou položku tohoto pracovního prostoru.

Návraty

Typ Description
str

Skladová položka tohoto pracovního prostoru.

subscription_id

Vraťte ID předplatného pro tento pracovní prostor.

Návraty

Typ Description
str

ID předplatného.

tags

Vrátí značky tohoto pracovního prostoru.

Návraty

Typ Description
dict

Značky tohoto pracovního prostoru.

webservices

Vrátí seznam webových služeb v pracovním prostoru.

Vyvolá, WebserviceException pokud došlo k problému s vrácením seznamu.

Návraty

Typ Description
dict[str, Webservice]

Seznam webových služeb v pracovním prostoru.

Výjimky

Typ Description
WebserviceException

Při vracení seznamu došlo k potížím.

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'