Workspace Třída

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

subscription_id
str
Vyžadováno

ID předplatného Azure obsahující pracovní prostor.

resource_group
str
Vyžadováno

Skupina prostředků obsahující pracovní prostor.

workspace_name
str
Vyžadováno

Název existujícího pracovního prostoru.

auth
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication nebo MsiAuthentication
výchozí hodnota: None

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
str
výchozí hodnota: None

Pouze interní použití.

_disable_service_check
bool
výchozí hodnota: False

Pouze interní použití.

_workspace_id
str
výchozí hodnota: None

Pouze interní použití.

sku
str
výchozí hodnota: basic

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

_cloud
str
výchozí hodnota: AzureCloud

Pouze interní použití.

subscription_id
str
Vyžadováno

ID předplatného Azure obsahující pracovní prostor.

resource_group
str
Vyžadováno

Skupina prostředků obsahující pracovní prostor.

workspace_name
str
Vyžadováno

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
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication nebo MsiAuthentication
Vyžadováno

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

Pouze interní použití.

_disable_service_check
bool
Vyžadováno

Pouze interní použití.

_workspace_id
str
Vyžadováno

Pouze interní použití.

sku
str
Vyžadováno

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

tags
dict
výchozí hodnota: None

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

_cloud
str
Vyžadováno

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 Azure Machine Learning.

Vyvolá výjimku, pokud pracovní prostor již existuje nebo pokud nejsou splněny některé požadavky 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. Pokud se konfigurační soubor nenajde, vyvolá výjimku.

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 uložit vlastnosti pracovního prostoru Azure Resource Manager (ARM) pomocí write_config metody a použít ji k načtení stejného pracovního prostoru v různých poznámkových blocích nebo projektech Pythonu bez nutnosti přepisovat 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

private_endpoint_config
PrivateEndPointConfig
Vyžadováno

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
výchozí hodnota: True

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.

location
string
výchozí hodnota: None

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

show_output
bool
výchozí hodnota: True

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

tags
dict
výchozí hodnota: None

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

Návraty

Objekt PrivateEndPoint byl vytvořen.

Návratový typ

create

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

Vyvolá výjimku, pokud pracovní prostor již existuje nebo pokud nejsou splněny některé požadavky 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
str
Vyžadováno

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
výchozí hodnota: None

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

subscription_id
str
výchozí hodnota: None

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

resource_group
str
výchozí hodnota: None

Skupina prostředků Azure, která obsahuje pracovní prostor. Výchozí parametr je mutace názvu pracovního prostoru.

location
str
výchozí hodnota: None

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

create_resource_group
bool
výchozí hodnota: True

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

sku
str
výchozí hodnota: basic

Parametr je k dispozici kvůli zpětné kompatibilitě a je ignorován.

tags
dict
výchozí hodnota: None

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

friendly_name
str
výchozí hodnota: None

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

storage_account
str
výchozí hodnota: None

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

key_vault
str
výchozí hodnota: None

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íčů bude pracovní prostor používat k ukládání přihlašovacích údajů, které do pracovního prostoru přidají uživatelé. Pokud žádný, vytvoří se nový trezor klíčů.

app_insights
str
výchozí hodnota: None

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á Služba Application Insights.

container_registry
str
výchozí hodnota: None

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

adb_workspace
str
výchozí hodnota: None

Existující pracovní prostor Adb 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). Pracovní prostor Adb se použije k propojení s pracovním prostorem. Pokud žádné, propojení s pracovním prostorem se nezobrazí.

primary_user_assigned_identity
str
výchozí hodnota: None

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

cmk_keyvault
str
výchozí hodnota: None

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.

resource_cmk_uri
str
výchozí hodnota: None

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>. Pří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 .

hbi_workspace
bool
výchozí hodnota: False

Určuje, jestli pracovní prostor obsahuje data HBI (High Business Impact), tj. 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 Nepravda.

Pokud je nastavená hodnota True, provedou se další kroky šifrování a v závislosti na komponentě sady SDK budou výsledkem 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, jedním z možných dopadů je větší složitost při řešení potíží. K tomu může dojít proto, že se některá telemetrie neodesílají do Microsoftu a je menší přehled o úspěšnosti nebo typech problémů, a proto nemusí být schopná proaktivně reagovat, když má tento příznak hodnotu True. Pro tento příznak se používá výchozí hodnota False, pokud není nezbytně nutné, aby byla pravda.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
výchozí hodnota: None

(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_gpu_compute_target
AmlComputeProvisioningConfiguration
výchozí hodnota: None

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

private_endpoint_config
PrivateEndPointConfig
výchozí hodnota: None

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

private_endpoint_auto_approval
bool
výchozí hodnota: True

Příznak logické hodnoty, který označuje, jestli má být vytvoření privátního koncového bodu automaticky schváleno nebo ručně schváleno 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.

exist_ok
bool
výchozí hodnota: False

Označuje, jestli 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.

show_output
bool
výchozí hodnota: True

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

user_assigned_identity_for_cmk_encryption
str
výchozí hodnota: None

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

system_datastores_auth_mode
str
výchozí hodnota: accessKey

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

v1_legacy_mode
bool
výchozí hodnota: None

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

Návraty

Objekt pracovního prostoru.

Návratový typ

Výjimky

Vyvolána pro problémy při vytváření pracovního prostoru.

Poznámky

Tento první příklad vyžaduje jenom 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 opakovaně používat 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

delete_dependent_resources
bool
výchozí hodnota: False

Jestli se mají 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.

no_wait
bool
výchozí hodnota: False

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

Návraty

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

Návratový typ

delete_connection

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

delete_connection(name)

Parametry

name
str
Vyžadováno

Jedinečný název připojení v rámci pracovního 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

private_endpoint_connection_name
str
Vyžadováno

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

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

Parametr diagnostiky stavu pracovního prostoru

Návraty

Instance AzureOperationPoller, která vrací DiagnoseResponseResult

Návratový typ

<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.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. Pokud se konfigurační soubor nenajde, vyvolá výjimku.

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 uložit vlastnosti pracovního prostoru Azure Resource Manager (ARM) pomocí write_config metody a použít ji k načtení stejného pracovního prostoru v různých poznámkových blocích nebo projektech Pythonu bez nutnosti přepisovat vlastnosti ARM pracovního prostoru.

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

Parametry

path
str
výchozí hodnota: None

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

auth
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication
výchozí hodnota: None

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

_logger
Logger
výchozí hodnota: None

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

_file_name
str
výchozí hodnota: None

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

Návraty

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

Návratový typ

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

Název pracovního prostoru, který chcete získat.

auth
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication
výchozí hodnota: None

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

subscription_id
str
výchozí hodnota: None

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.

resource_group
str
výchozí hodnota: None

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

location
str
výchozí hodnota: None

Umístění pracovního prostoru.

cloud
str
výchozí hodnota: AzureCloud

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

id
str
výchozí hodnota: None

ID pracovního prostoru.

Návraty

Objekt pracovního prostoru.

Návratový typ

get_connection

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

get_connection(name)

Parametry

name
str
Vyžadováno

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

type
str
Vyžadováno

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

Návraty

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

Návratový typ

get_default_datastore

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

get_default_datastore()

Návraty

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

Návratový typ

get_default_keyvault

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

get_default_keyvault()

Návraty

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

Návratový typ

get_details

Vrátí podrobnosti pracovního prostoru.

get_details()

Návraty

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

Návratový typ

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

_with_auth
bool
výchozí hodnota: False

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

Návraty

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

Návratový typ

str

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

run_id
string
Vyžadováno

ID spuštění.

Návraty

Odeslané spuštění.

Návratový typ

Run

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

subscription_id
str
Vyžadováno

ID předplatného, pro které chcete vypsat pracovní prostory.

auth
ServicePrincipalAuthentication nebo InteractiveLoginAuthentication
výchozí hodnota: None

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

resource_group
str
výchozí hodnota: None

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.

Návraty

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

Návratový typ

list_connections

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

list_connections(category=None, target=None)

Parametry

type
str
Vyžadováno

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

target
str
výchozí hodnota: None

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

category
výchozí hodnota: None

list_keys

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

list_keys()

Návratový typ

set_connection

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

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

Parametry

name
str
Vyžadováno

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

category
str
Vyžadováno

Kategorie tohoto připojení

target
str
Vyžadováno

cíl, ke které se toto připojení připojuje

authType
str
Vyžadováno

typ autorizace tohoto připojení

value
str
Vyžadováno

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

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

Objekt pracovního prostoru.

Návratový typ

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

no_wait
bool
výchozí hodnota: False

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

Návraty

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

Návratový typ

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

friendly_name
str
výchozí hodnota: None

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

description
str
výchozí hodnota: None

Popis pracovního prostoru.

tags
dict
výchozí hodnota: None

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

image_build_compute
str
výchozí hodnota: None

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

service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
výchozí hodnota: None

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

primary_user_assigned_identity
str
výchozí hodnota: None

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

allow_public_access_when_behind_vnet
bool
výchozí hodnota: None

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

v1_legacy_mode
bool
výchozí hodnota: None

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

Návraty

Slovník aktualizovaných informací.

Návratový typ

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

container_registry
str
výchozí hodnota: None

ID ARM pro registr kontejneru.

force
bool
výchozí hodnota: False

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

Návratový typ

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

path
str
výchozí hodnota: None

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

file_name
str
výchozí hodnota: None

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

Atributy

compute_targets

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

Návraty

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

Návratový typ

datasets

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

Návraty

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

Návratový typ

datastores

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

Návraty

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

Návratový typ

discovery_url

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

Návraty

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

Návratový typ

str

environments

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

Návraty

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

Návratový typ

experiments

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

Návraty

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

Návratový typ

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

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

Návratový typ

Výjimky

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

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

Návratový typ

location

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

Návraty

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

Návratový typ

str

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

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

Návratový typ

Výjimky

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

Název pracovního prostoru.

Návratový typ

str

private_endpoints

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

Návraty

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

Návratový typ

resource_group

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

Návraty

Název skupiny prostředků.

Návratový typ

str

service_context

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

Návraty

Vrátí ServiceContext objekt.

Návratový typ

<xref:azureml._restclient.service_context.ServiceContext>

sku

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

Návraty

Skladová položka tohoto pracovního prostoru.

Návratový typ

str

subscription_id

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

Návraty

ID předplatného.

Návratový typ

str

tags

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

Návraty

Značky tohoto pracovního prostoru.

Návratový typ

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

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

Návratový typ

Výjimky

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'