Workspace Klass
Definierar en Azure Machine Learning-resurs för att hantera tränings- och distributionsartefakter.
En arbetsyta är en grundläggande resurs för maskininlärning i Azure Machine Learning. Du använder en arbetsyta för att experimentera, träna och distribuera maskininlärningsmodeller. Varje arbetsyta är kopplad till en Azure-prenumeration och resursgrupp och har en associerad SKU.
Mer information om arbetsytor finns i:
Konstruktor för klassarbetsyta för att läsa in en befintlig Azure Machine Learning-arbetsyta.
- Arv
-
builtins.objectWorkspace
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')
Parametrar
Name | Description |
---|---|
subscription_id
Obligatorisk
|
Azure-prenumerations-ID:t som innehåller arbetsytan. |
resource_group
Obligatorisk
|
Resursgruppen som innehåller arbetsytan. |
workspace_name
Obligatorisk
|
Det befintliga arbetsytans namn. |
auth
|
Autentiseringsobjektet. Mer information finns i https://aka.ms/aml-notebook-auth. Om inget används standardautentiseringsuppgifterna för Azure CLI eller så frågar API:et efter autentiseringsuppgifter. Standardvärde: None
|
_location
|
Endast internt bruk. Standardvärde: None
|
_disable_service_check
|
Endast internt bruk. Standardvärde: False
|
_workspace_id
|
Endast internt bruk. Standardvärde: None
|
sku
|
Parametern finns för bakåtkompatibilitet och ignoreras. Standardvärde: basic
|
_cloud
|
Endast internt bruk. Standardvärde: AzureCloud
|
subscription_id
Obligatorisk
|
Azure-prenumerations-ID:t som innehåller arbetsytan. |
resource_group
Obligatorisk
|
Resursgruppen som innehåller arbetsytan. |
workspace_name
Obligatorisk
|
Namnet på arbetsytan. Namnet måste innehålla mellan 2 och 32 tecken. Det första tecknet i namnet måste vara alfanumeriskt (bokstav eller nummer), men resten av namnet kan innehålla alfanumeriska tecken, bindestreck och understreck. Tomt utrymme tillåts inte. |
auth
Obligatorisk
|
Autentiseringsobjektet. Mer information finns i https://aka.ms/aml-notebook-auth. Om inget används standardautentiseringsuppgifterna för Azure CLI eller så frågar API:et efter autentiseringsuppgifter. |
_location
Obligatorisk
|
Endast internt bruk. |
_disable_service_check
Obligatorisk
|
Endast internt bruk. |
_workspace_id
Obligatorisk
|
Endast internt bruk. |
sku
Obligatorisk
|
Parametern finns för bakåtkompatibilitet och ignoreras. |
tags
|
Taggar som ska associeras med arbetsytan. Standardvärde: None
|
_cloud
Obligatorisk
|
Endast internt bruk. |
Kommentarer
Följande exempel visar hur du skapar en arbetsyta.
from azureml.core import Workspace
ws = Workspace.create(name='myworkspace',
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup',
create_resource_group=True,
location='eastus2'
)
Ange create_resource_group
till Falskt om du har en befintlig Azure-resursgrupp som du vill använda för arbetsytan.
Om du vill använda samma arbetsyta i flera miljöer skapar du en JSON-konfigurationsfil. Konfigurationsfilen sparar prenumerationen, resursen och arbetsytans namn så att den enkelt kan läsas in. Använd metoden för att spara konfigurationen write_config .
ws.write_config(path="./file-path", file_name="ws_config.json")
Se Skapa en konfigurationsfil för arbetsytan för ett exempel på konfigurationsfilen.
Om du vill läsa in arbetsytan från konfigurationsfilen from_config använder du metoden .
ws = Workspace.from_config()
ws.get_details()
Du kan också använda get metoden för att läsa in en befintlig arbetsyta utan att använda konfigurationsfiler.
ws = Workspace.get(name="myworkspace",
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup')
Exemplen ovan kan fråga dig om autentiseringsuppgifter för Azure med hjälp av en interaktiv inloggningsdialogruta. Andra användningsfall, inklusive användning av Azure CLI för att autentisera och autentisering i automatiserade arbetsflöden, finns i Autentisering i Azure Machine Learning.
Metoder
add_private_endpoint |
Lägg till en privat slutpunkt i arbetsytan. |
create |
Skapa en ny Azure Machine Learning-arbetsyta. Genererar ett undantag om arbetsytan redan finns eller om något av arbetsytekraven inte uppfylls. |
delete |
Ta bort de associerade resurserna för Azure Machine Learning-arbetsytan. |
delete_connection |
Ta bort en anslutning till arbetsytan. |
delete_private_endpoint_connection |
Ta bort den privata slutpunktsanslutningen till arbetsytan. |
diagnose_workspace |
Diagnostisera konfigurationsproblem för arbetsytan. |
from_config |
Returnera ett arbetsyteobjekt från en befintlig Azure Machine Learning-arbetsyta. Läser konfigurationen av arbetsytan från en fil. Utlöser ett undantag om det inte går att hitta konfigurationsfilen. Metoden ger ett enkelt sätt att återanvända samma arbetsyta i flera Python-notebook-filer eller -projekt. Användare kan spara egenskaperna för arbetsytan i Azure Resource Manager (ARM) med hjälp av metoden och använda den write_config här metoden för att läsa in samma arbetsyta i olika Python-notebook-filer eller -projekt utan att skriva om ARM-egenskaperna för arbetsytan. |
get |
Returnera ett arbetsyteobjekt för en befintlig Azure Machine Learning-arbetsyta. Genererar ett undantag om arbetsytan inte finns eller om de obligatoriska fälten inte identifierar en arbetsyta unikt. |
get_connection |
Hämta en anslutning till arbetsytan. |
get_default_compute_target |
Hämta standardberäkningsmålet för arbetsytan. |
get_default_datastore |
Hämta standarddatalagringen för arbetsytan. |
get_default_keyvault |
Hämta standardnyckelvalvsobjektet för arbetsytan. |
get_details |
Returnera information om arbetsytan. |
get_mlflow_tracking_uri |
Hämta MLflow-spårnings-URI:n för arbetsytan. MLflow (https://mlflow.org/) är en plattform med öppen källkod för att spåra maskininlärningsexperiment och hantera modeller. Du kan använda MLflow-loggnings-API:er med Azure Machine Learning så att mått, modeller och artefakter loggas på din Azure Machine Learning-arbetsyta. |
get_run |
Returnera körningen med den angivna run_id på arbetsytan. |
list |
Visa en lista över alla arbetsytor som användaren har åtkomst till i prenumerationen. Listan över arbetsytor kan filtreras baserat på resursgruppen. |
list_connections |
Lista anslutningar under den här arbetsytan. |
list_keys |
Visa en lista över nycklar för den aktuella arbetsytan. |
set_connection |
Lägg till eller uppdatera en anslutning under arbetsytan. |
set_default_datastore |
Ange standarddatalager för arbetsytan. |
setup |
Skapa en ny arbetsyta eller hämta en befintlig arbetsyta. |
sync_keys |
Utlöser arbetsytan för att omedelbart synkronisera nycklar. Om nycklar för en resurs på arbetsytan ändras kan det ta ungefär en timme innan de uppdateras automatiskt. Den här funktionen gör att nycklar kan uppdateras på begäran. Ett exempelscenario är att du behöver omedelbar åtkomst till lagring efter att lagringsnycklarna har återskapats. |
update |
Uppdatera eget namn, beskrivning, taggar, beräkning av avbildningsversioner och andra inställningar som är associerade med en arbetsyta. |
update_dependencies |
Uppdatera befintliga associerade resurser för arbetsytan i följande fall. a) När en användare av misstag tar bort en befintlig associerad resurs och vill uppdatera den med en ny utan att behöva återskapa hela arbetsytan. b) När en användare har en befintlig associerad resurs och vill ersätta den aktuella som är associerad med arbetsytan. c) När en associerad resurs inte har skapats ännu och de vill använda en befintlig resurs som de redan har (gäller endast containerregistret). |
write_config |
Skriv egenskaperna för arbetsytan Azure Resource Manager (ARM) till en konfigurationsfil. ARM-egenskaper för arbetsytan kan läsas in senare med hjälp av from_config metoden . Standardvärdet Metoden ger ett enkelt sätt att återanvända samma arbetsyta i flera Python-notebook-filer eller -projekt. Användare kan spara arm-egenskaperna för arbetsytan med hjälp av den här funktionen och använda from_config för att läsa in samma arbetsyta i olika Python-notebook-filer eller projekt utan att skriva om ARM-egenskaperna för arbetsytan. |
add_private_endpoint
Lägg till en privat slutpunkt i arbetsytan.
add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)
Parametrar
Name | Description |
---|---|
private_endpoint_config
Obligatorisk
|
Konfigurationen av den privata slutpunkten för att skapa en privat slutpunkt till arbetsytan. |
private_endpoint_auto_approval
|
En boolesk flagga som anger om skapandet av den privata slutpunkten ska godkännas automatiskt eller manuellt från Azure Private Link Center. Vid manuellt godkännande kan användarna visa den väntande begäran i Private Link portalen för att godkänna/avvisa begäran. Standardvärde: True
|
location
|
Plats för den privata slutpunkten, standard är arbetsytans plats Standardvärde: None
|
show_output
|
Flagga för att visa förloppet för skapande av arbetsyta Standardvärde: True
|
tags
|
Taggar som ska associeras med arbetsytan. Standardvärde: None
|
Returer
Typ | Description |
---|---|
PrivateEndPoint-objektet skapades. |
create
Skapa en ny Azure Machine Learning-arbetsyta.
Genererar ett undantag om arbetsytan redan finns eller om något av arbetsytekraven inte uppfylls.
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)
Parametrar
Name | Description |
---|---|
name
Obligatorisk
|
Namnet på den nya arbetsytan. Namnet måste innehålla mellan 2 och 32 tecken. Det första tecknet i namnet måste vara alfanumeriskt (bokstav eller nummer), men resten av namnet kan innehålla alfanumeriska tecken, bindestreck och understreck. Tomt utrymme tillåts inte. |
auth
|
Autentiseringsobjektet. Mer information finns i https://aka.ms/aml-notebook-auth. Om inget används standardautentiseringsuppgifterna för Azure CLI eller så frågar API:et efter autentiseringsuppgifter. Standardvärde: None
|
subscription_id
|
Prenumerations-ID för den innehållande prenumerationen för den nya arbetsytan. Parametern krävs om användaren har åtkomst till fler än en prenumeration. Standardvärde: None
|
resource_group
|
Den Azure-resursgrupp som innehåller arbetsytan. Parametern är som standard en mutation av arbetsytans namn. Standardvärde: None
|
location
|
Arbetsytans plats. Parametern är som standard resursgruppens plats. Platsen måste vara en region som stöds för Azure Machine Learning. Standardvärde: None
|
create_resource_group
|
Anger om resursgruppen ska skapas om den inte finns. Standardvärde: True
|
sku
|
Parametern finns för bakåtkompatibilitet och ignoreras. Standardvärde: basic
|
tags
|
Taggar som ska associeras med arbetsytan. Standardvärde: None
|
friendly_name
|
Ett valfritt eget namn för arbetsytan som kan visas i användargränssnittet. Standardvärde: None
|
storage_account
|
Ett befintligt lagringskonto i Azure-resurs-ID-format. Lagringen används av arbetsytan för att spara körningsutdata, kod, loggar osv. Om inget, skapas ett nytt lagringskonto. Standardvärde: None
|
key_vault
|
Ett befintligt nyckelvalv i Azure-resurs-ID-format. Se exempelkoden nedan för mer information om azure-resurs-ID-formatet. Nyckelvalvet används av arbetsytan för att lagra autentiseringsuppgifter som läggs till på arbetsytan av användarna. Om inget, skapas ett nytt nyckelvalv. Standardvärde: None
|
app_insights
|
En befintlig Application Insights i Azure-resurs-ID-format. Se exempelkoden nedan för mer information om azure-resurs-ID-formatet. Application Insights används av arbetsytan för att logga webbtjänsthändelser. Om inget, skapas en ny Application Insights. Standardvärde: None
|
container_registry
|
Ett befintligt containerregister i Azure-resurs-ID-format (se exempelkod nedan för information om Azure-resurs-ID-formatet). Containerregistret används av arbetsytan för att hämta och push-överföra både experimenterings- och webbtjänstavbildningar. Om inget, skapas ett nytt containerregister endast när det behövs och inte tillsammans med att arbetsytan skapas. Standardvärde: None
|
adb_workspace
|
En befintlig Adb-arbetsyta i Azure-resurs-ID-format (se exempelkod nedan för information om Azure-resurs-ID-formatet). Adb-arbetsytan används för att länka till arbetsytan. Om den är Ingen sker inte länken till arbetsytan. Standardvärde: None
|
primary_user_assigned_identity
|
Resurs-ID för den användartilldelade identitet som användes för att representera arbetsytan Standardvärde: None
|
cmk_keyvault
|
Nyckelvalvet som innehåller den kundhanterade nyckeln i Azure-resurs-ID-formatet:
Standardvärde: None
|
resource_cmk_uri
|
Nyckel-URI för den kundhanterade nyckeln för att kryptera vilande data.
URI-formatet är: Standardvärde: None
|
hbi_workspace
|
Anger om arbetsytan innehåller data från HBI (High Business Impact), d.v.s. innehåller känslig företagsinformation. Den här flaggan kan bara anges när arbetsytan skapas. Det går inte att ändra dess värde när arbetsytan har skapats. Standardvärdet är False. När värdet är True utförs ytterligare krypteringssteg, och beroende på SDK-komponenten resulterar det i redigerad information i internt insamlad telemetri. Mer information finns i Datakryptering. När den här flaggan är inställd på True är en möjlig inverkan ökad svårighet att felsöka problem. Detta kan inträffa eftersom viss telemetri inte skickas till Microsoft och det finns mindre insyn i framgångsfrekvenser eller problemtyper, och därför kanske inte kan reagera lika proaktivt när den här flaggan är True. Rekommendationen använder standardvärdet False för den här flaggan om det inte är absolut nödvändigt att vara True. Standardvärde: False
|
default_cpu_compute_target
|
(INAKTUELL) En konfiguration som ska användas för att skapa en CPU-beräkning. Parametern använder som standard {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Om ingen, skapas ingen beräkning. Standardvärde: None
|
default_gpu_compute_target
|
(INAKTUELL) En konfiguration som ska användas för att skapa en GPU-beräkning. Parametern använder som standard {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Om ingen, skapas ingen beräkning. Standardvärde: None
|
private_endpoint_config
|
Konfigurationen av den privata slutpunkten för att skapa en privat slutpunkt till Azure ML-arbetsytan. Standardvärde: None
|
private_endpoint_auto_approval
|
En boolesk flagga som anger om skapandet av den privata slutpunkten ska godkännas automatiskt eller manuellt från Azure Private Link Center. Vid manuellt godkännande kan användarna visa den väntande begäran i Private Link portalen för att godkänna/avvisa begäran. Standardvärde: True
|
exist_ok
|
Anger om den här metoden lyckas om arbetsytan redan finns. Om det är falskt misslyckas den här metoden om arbetsytan finns. Om värdet är Sant returnerar den här metoden den befintliga arbetsytan om den finns. Standardvärde: False
|
show_output
|
Anger om den här metoden ska skriva ut inkrementella förlopp. Standardvärde: True
|
user_assigned_identity_for_cmk_encryption
|
Resurs-ID:t för den användartilldelade identiteten som måste användas för att få åtkomst till kundhanterarnyckeln Standardvärde: None
|
system_datastores_auth_mode
|
Avgör om du vill använda autentiseringsuppgifter för systemdatalager för arbetsytan "workspaceblobstore" och "workspacefilestore". Standardvärdet är "accessKey", i så fall skapar arbetsytan systemdatalager med autentiseringsuppgifter. Om värdet är "identitet" skapar arbetsytan systemdatalager utan autentiseringsuppgifter. Standardvärde: accessKey
|
v1_legacy_mode
|
Förhindra användning av v2 API-tjänsten på offentliga Azure Resource Manager Standardvärde: None
|
Returer
Typ | Description |
---|---|
Arbetsyteobjektet. |
Undantag
Typ | Description |
---|---|
Skapades för problem med att skapa arbetsytan. |
Kommentarer
Det första exemplet kräver bara minimal specifikation, och alla beroende resurser samt resursgruppen skapas automatiskt.
from azureml.core import Workspace
ws = Workspace.create(name='myworkspace',
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup',
create_resource_group=True,
location='eastus2')
I följande exempel visas hur du återanvänder befintliga Azure-resurser med hjälp av Azure-resurs-ID-formatet. De specifika Azure-resurs-ID:na kan hämtas via Azure-portalen eller SDK. Detta förutsätter att resursgruppen, lagringskontot, nyckelvalvet, App Insights och containerregistret redan finns.
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
Ta bort de associerade resurserna för Azure Machine Learning-arbetsytan.
delete(delete_dependent_resources=False, no_wait=False)
Parametrar
Name | Description |
---|---|
delete_dependent_resources
|
Om du vill ta bort resurser som är associerade med arbetsytan, t.ex. containerregister, lagringskonto, nyckelvalv och application insights. Standardvärdet är False. Ställ in på True för att ta bort dessa resurser. Standardvärde: False
|
no_wait
|
Om du vill vänta tills borttagningen av arbetsytan har slutförts. Standardvärde: False
|
Returer
Typ | Description |
---|---|
Ingen om det lyckas; annars utlöser ett fel. |
delete_connection
Ta bort en anslutning till arbetsytan.
delete_connection(name)
Parametrar
Name | Description |
---|---|
name
Obligatorisk
|
Det unika namnet på anslutningen under arbetsytan |
delete_private_endpoint_connection
Ta bort den privata slutpunktsanslutningen till arbetsytan.
delete_private_endpoint_connection(private_endpoint_connection_name)
Parametrar
Name | Description |
---|---|
private_endpoint_connection_name
Obligatorisk
|
Det unika namnet på den privata slutpunktsanslutningen under arbetsytan |
diagnose_workspace
Diagnostisera konfigurationsproblem för arbetsytan.
diagnose_workspace(diagnose_parameters)
Parametrar
Name | Description |
---|---|
diagnose_parameters
Obligatorisk
|
<xref:_restclient.models.DiagnoseWorkspaceParameters>
Parametern för att diagnostisera arbetsytans hälsa |
Returer
Typ | Description |
---|---|
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]
|
En instans av AzureOperationPoller som returnerar DiagnoseResponseResult |
from_config
Returnera ett arbetsyteobjekt från en befintlig Azure Machine Learning-arbetsyta.
Läser konfigurationen av arbetsytan från en fil. Utlöser ett undantag om det inte går att hitta konfigurationsfilen.
Metoden ger ett enkelt sätt att återanvända samma arbetsyta i flera Python-notebook-filer eller -projekt. Användare kan spara egenskaperna för arbetsytan i Azure Resource Manager (ARM) med hjälp av metoden och använda den write_config här metoden för att läsa in samma arbetsyta i olika Python-notebook-filer eller -projekt utan att skriva om ARM-egenskaperna för arbetsytan.
static from_config(path=None, auth=None, _logger=None, _file_name=None)
Parametrar
Name | Description |
---|---|
path
|
Sökvägen till konfigurationsfilen eller startkatalogen för sökning. Parametern startar som standard sökningen i den aktuella katalogen. Standardvärde: None
|
auth
|
Autentiseringsobjektet. Mer information finns i https://aka.ms/aml-notebook-auth. Om inget används standardautentiseringsuppgifterna för Azure CLI eller så frågar API:et efter autentiseringsuppgifter. Standardvärde: None
|
_logger
|
Tillåter åsidosättande av standardloggaren. Standardvärde: None
|
_file_name
|
Gör att du kan åsidosätta konfigurationsfilnamnet för att söka efter när sökvägen är en katalogsökväg. Standardvärde: None
|
Returer
Typ | Description |
---|---|
Arbetsyteobjektet för en befintlig Azure ML-arbetsyta. |
get
Returnera ett arbetsyteobjekt för en befintlig Azure Machine Learning-arbetsyta.
Genererar ett undantag om arbetsytan inte finns eller om de obligatoriska fälten inte identifierar en arbetsyta unikt.
static get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)
Parametrar
Name | Description |
---|---|
name
Obligatorisk
|
Namnet på arbetsytan som ska hämtas. |
auth
|
Autentiseringsobjektet. Mer information finns i https://aka.ms/aml-notebook-auth. Om inget används standardautentiseringsuppgifterna för Azure CLI eller så frågar API:et efter autentiseringsuppgifter. Standardvärde: None
|
subscription_id
|
Det prenumerations-ID som ska användas. Parametern krävs om användaren har åtkomst till fler än en prenumeration. Standardvärde: None
|
resource_group
|
Den resursgrupp som ska användas. Om den är Ingen söker metoden igenom alla resursgrupper i prenumerationen. Standardvärde: None
|
location
|
Arbetsytans plats. Standardvärde: None
|
cloud
|
Namnet på målmolnet. Kan vara något av "AzureCloud", "AzureChinaCloud" eller "AzureUSGovernment". Om inget moln anges används "AzureCloud". Standardvärde: AzureCloud
|
id
|
ID för arbetsytan. Standardvärde: None
|
Returer
Typ | Description |
---|---|
Arbetsyteobjektet. |
get_connection
Hämta en anslutning till arbetsytan.
get_connection(name)
Parametrar
Name | Description |
---|---|
name
Obligatorisk
|
Det unika namnet på anslutningen under arbetsytan |
get_default_compute_target
Hämta standardberäkningsmålet för arbetsytan.
get_default_compute_target(type)
Parametrar
Name | Description |
---|---|
type
Obligatorisk
|
Typ av beräkning. Möjliga värden är "CPU" eller "GPU". |
Returer
Typ | Description |
---|---|
Standardberäkningsmålet för den angivna beräkningstypen. |
get_default_datastore
Hämta standarddatalagringen för arbetsytan.
get_default_datastore()
Returer
Typ | Description |
---|---|
Standarddatalager. |
get_default_keyvault
Hämta standardnyckelvalvsobjektet för arbetsytan.
get_default_keyvault()
Returer
Typ | Description |
---|---|
Det KeyVault-objekt som är associerat med arbetsytan. |
get_details
Returnera information om arbetsytan.
get_details()
Returer
Typ | Description |
---|---|
Arbetsyteinformation i ordlisteformat. |
Kommentarer
Den returnerade ordlistan innehåller följande nyckel/värde-par.
id: URI som pekar på den här arbetsyteresursen och som innehåller prenumerations-ID, resursgrupp och arbetsytenamn.
name: Namnet på den här arbetsytan.
plats: Arbetsytans region.
type: En URI för formatet "{providerName}/workspaces".
tags: Används inte för närvarande.
workspaceid: ID för den här arbetsytan.
description: Används inte för närvarande.
friendlyName: Ett eget namn för arbetsytan som visas i användargränssnittet.
creationTime: Tiden då den här arbetsytan skapades i ISO8601-format.
containerRegistry: Arbetsytans containerregister som används för att hämta och push-överföra både experimenterings- och webbtjänstavbildningar.
keyVault: Nyckelvalvet för arbetsytan som används för att lagra autentiseringsuppgifter som lagts till på arbetsytan av användarna.
applicationInsights: Application Insights används av arbetsytan för att logga webbtjänsthändelser.
identityPrincipalId:
identityTenantId
identityType
storageAccount: Lagringen används av arbetsytan för att spara körningsutdata, kod, loggar osv.
sku: Arbetsytans SKU (kallas även utgåva). Parametern finns för bakåtkompatibilitet och ignoreras.
resourceCmkUri: Nyckel-URI för den kundhanterade nyckeln för att kryptera vilande data. https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 Se för anvisningar om hur du skapar en nyckel och hämtar dess URI.
hbiWorkspace: Anger om kunddata har stor inverkan på verksamheten.
imageBuildCompute: Beräkningsmålet för avbildningsbygge.
systemDatastoresAuthMode: Avgör om autentiseringsuppgifter ska användas för systemdatalager för arbetsytan "workspaceblobstore" och "workspacefilestore". Standardvärdet är "accessKey", i så fall skapar arbetsytan systemdatalager med autentiseringsuppgifter. Om värdet är "identitet" skapar arbetsytan systemdatalager utan autentiseringsuppgifter.
Mer information om dessa nyckel/värde-par finns i create.
get_mlflow_tracking_uri
Hämta MLflow-spårnings-URI:n för arbetsytan.
MLflow (https://mlflow.org/) är en plattform med öppen källkod för att spåra maskininlärningsexperiment och hantera modeller. Du kan använda MLflow-loggnings-API:er med Azure Machine Learning så att mått, modeller och artefakter loggas på din Azure Machine Learning-arbetsyta.
get_mlflow_tracking_uri(_with_auth=False)
Parametrar
Name | Description |
---|---|
_with_auth
|
(INAKTUELL) Lägg till autentiseringsinformation i spårnings-URI. Standardvärde: False
|
Returer
Typ | Description |
---|---|
MLflow-kompatibel spårnings-URI. |
Kommentarer
Använd följande exempel för att konfigurera MLflow-spårning för att skicka data till Azure ML-arbetsytan:
import mlflow
from azureml.core import Workspace
workspace = Workspace.from_config()
mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())
get_run
Returnera körningen med den angivna run_id på arbetsytan.
get_run(run_id)
Parametrar
Name | Description |
---|---|
run_id
Obligatorisk
|
Körnings-ID:t. |
Returer
Typ | Description |
---|---|
Den skickade körningen. |
list
Visa en lista över alla arbetsytor som användaren har åtkomst till i prenumerationen.
Listan över arbetsytor kan filtreras baserat på resursgruppen.
static list(subscription_id, auth=None, resource_group=None)
Parametrar
Name | Description |
---|---|
subscription_id
Obligatorisk
|
Det prenumerations-ID som arbetsytor ska listas för. |
auth
|
Autentiseringsobjektet. Mer information finns i https://aka.ms/aml-notebook-auth. Om inget används standardautentiseringsuppgifterna för Azure CLI eller så frågar API:et efter autentiseringsuppgifter. Standardvärde: None
|
resource_group
|
En resursgrupp för att filtrera de returnerade arbetsytorna. Om ingen visas en lista över alla arbetsytor i den angivna prenumerationen. Standardvärde: None
|
Returer
Typ | Description |
---|---|
En ordlista där nyckeln är arbetsytans namn och värdet är en lista över arbetsyteobjekt. |
list_connections
Lista anslutningar under den här arbetsytan.
list_connections(category=None, target=None)
Parametrar
Name | Description |
---|---|
type
Obligatorisk
|
Den typ av anslutning som ska filtreras på |
target
|
målet för den här anslutningen som ska filtreras på Standardvärde: None
|
category
|
Standardvärde: None
|
list_keys
set_connection
Lägg till eller uppdatera en anslutning under arbetsytan.
set_connection(name, category, target, authType, value)
Parametrar
Name | Description |
---|---|
name
Obligatorisk
|
Det unika namnet på anslutningen under arbetsytan |
category
Obligatorisk
|
Kategorin för den här anslutningen |
target
Obligatorisk
|
målet som anslutningen ansluter till |
authType
Obligatorisk
|
auktoriseringstypen för den här anslutningen |
value
Obligatorisk
|
json-formatserialiseringssträngen för anslutningsinformationen |
set_default_datastore
Ange standarddatalager för arbetsytan.
set_default_datastore(name)
Parametrar
Name | Description |
---|---|
name
Obligatorisk
|
Namnet på som Datastore ska anges som standard. |
setup
Skapa en ny arbetsyta eller hämta en befintlig arbetsyta.
static setup()
Returer
Typ | Description |
---|---|
Ett arbetsyteobjekt. |
sync_keys
Utlöser arbetsytan för att omedelbart synkronisera nycklar.
Om nycklar för en resurs på arbetsytan ändras kan det ta ungefär en timme innan de uppdateras automatiskt. Den här funktionen gör att nycklar kan uppdateras på begäran. Ett exempelscenario är att du behöver omedelbar åtkomst till lagring efter att lagringsnycklarna har återskapats.
sync_keys(no_wait=False)
Parametrar
Name | Description |
---|---|
no_wait
|
Om du vill vänta tills synkroniseringsnycklarna för arbetsytan har slutförts. Standardvärde: False
|
Returer
Typ | Description |
---|---|
Ingen om det lyckas; annars utlöser ett fel. |
update
Uppdatera eget namn, beskrivning, taggar, beräkning av avbildningsversioner och andra inställningar som är associerade med en arbetsyta.
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)
Parametrar
Name | Description |
---|---|
friendly_name
|
Ett eget namn för arbetsytan som kan visas i användargränssnittet. Standardvärde: None
|
description
|
En beskrivning av arbetsytan. Standardvärde: None
|
tags
|
Taggar som ska associeras med arbetsytan. Standardvärde: None
|
image_build_compute
|
Beräkningsnamnet för avbildningsversionen. Standardvärde: None
|
service_managed_resources_settings
|
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
Inställningarna för tjänsthanterade resurser. Standardvärde: None
|
primary_user_assigned_identity
|
Resurs-ID:t för den användartilldelade identiteten som representerar arbetsytans identitet. Standardvärde: None
|
allow_public_access_when_behind_vnet
|
Tillåt offentlig åtkomst till arbetsytan Private Link. Standardvärde: None
|
v1_legacy_mode
|
Förhindra användning av v2 API-tjänsten på offentliga Azure Resource Manager Standardvärde: None
|
Returer
Typ | Description |
---|---|
En ordlista med uppdaterad information. |
update_dependencies
Uppdatera befintliga associerade resurser för arbetsytan i följande fall.
a) När en användare av misstag tar bort en befintlig associerad resurs och vill uppdatera den med en ny utan att behöva återskapa hela arbetsytan. b) När en användare har en befintlig associerad resurs och vill ersätta den aktuella som är associerad med arbetsytan. c) När en associerad resurs inte har skapats ännu och de vill använda en befintlig resurs som de redan har (gäller endast containerregistret).
update_dependencies(container_registry=None, force=False)
Parametrar
Name | Description |
---|---|
container_registry
|
ARM-ID för containerregistret. Standardvärde: None
|
force
|
Om framtvinga uppdatering av beroende resurser utan att någon bekräftelse tillfrågas. Standardvärde: False
|
Returer
Typ | Description |
---|---|
write_config
Skriv egenskaperna för arbetsytan Azure Resource Manager (ARM) till en konfigurationsfil.
ARM-egenskaper för arbetsytan kan läsas in senare med hjälp av from_config metoden . Standardvärdet path
är '.azureml/' i den aktuella arbetskatalogen och file_name
standardvärdet är 'config.json'.
Metoden ger ett enkelt sätt att återanvända samma arbetsyta i flera Python-notebook-filer eller -projekt. Användare kan spara arm-egenskaperna för arbetsytan med hjälp av den här funktionen och använda from_config för att läsa in samma arbetsyta i olika Python-notebook-filer eller projekt utan att skriva om ARM-egenskaperna för arbetsytan.
write_config(path=None, file_name=None)
Parametrar
Name | Description |
---|---|
path
|
Användaren angav plats för att skriva filen config.json. Parametern är som standard ".azureml/" i den aktuella arbetskatalogen. Standardvärde: None
|
file_name
|
Namn som ska användas för konfigurationsfilen. Parametern är standardinställningen config.json. Standardvärde: None
|
Attribut
compute_targets
Visa en lista över alla beräkningsmål på arbetsytan.
Returer
Typ | Description |
---|---|
En ordlista med nyckel som beräkningsmålnamn och värde som ComputeTarget objekt. |
datasets
Visa en lista över alla datauppsättningar på arbetsytan.
Returer
Typ | Description |
---|---|
En ordlista med nyckel som datauppsättningens namn och värde som Dataset objekt. |
datastores
Visa en lista över alla datalager på arbetsytan. Den här åtgärden returnerar inte autentiseringsuppgifter för datalager.
Returer
Typ | Description |
---|---|
En ordlista med nyckel som datalagernamn och värde som Datastore objekt. |
discovery_url
Returnera identifierings-URL:en för den här arbetsytan.
Returer
Typ | Description |
---|---|
Identifierings-URL:en för den här arbetsytan. |
environments
Visa en lista över alla miljöer på arbetsytan.
Returer
Typ | Description |
---|---|
En ordlista med nyckel som miljönamn och värde som Environment objekt. |
experiments
Visa en lista över alla experiment på arbetsytan.
Returer
Typ | Description |
---|---|
En ordlista med nyckel som experimentnamn och värde som Experiment objekt. |
images
Returnera listan över bilder i arbetsytan.
Genererar en WebserviceException om det uppstod ett problem med att interagera med modellhanteringstjänsten.
Returer
Typ | Description |
---|---|
En ordlista med nyckel som bildnamn och värde som Image objekt. |
Undantag
Typ | Description |
---|---|
Ett problem uppstod när modellhanteringstjänsten skulle interagera. |
linked_services
Visa en lista över alla länkade tjänster på arbetsytan.
Returer
Typ | Description |
---|---|
En ordlista där nyckeln är ett länkat tjänstnamn och värde är ett LinkedService objekt. |
location
Returnera platsen för den här arbetsytan.
Returer
Typ | Description |
---|---|
Platsen för den här arbetsytan. |
models
Returnera en lista över modellen på arbetsytan.
Genererar en WebserviceException om det uppstod ett problem med att interagera med modellhanteringstjänsten.
Returer
Typ | Description |
---|---|
En ordlista med modell med nyckel som modellnamn och värde som Model objekt. |
Undantag
Typ | Description |
---|---|
Ett problem uppstod när modellhanteringstjänsten skulle interagera. |
name
private_endpoints
Visa en lista över alla privata slutpunkter för arbetsytan.
Returer
Typ | Description |
---|---|
En diktering av PrivateEndPoint-objekt som är associerade med arbetsytan. Nyckeln är namnet på den privata slutpunkten. |
resource_group
Returnera resursgruppens namn för den här arbetsytan.
Returer
Typ | Description |
---|---|
Resursgruppens namn. |
service_context
Returnera tjänstkontexten för den här arbetsytan.
Returer
Typ | Description |
---|---|
<xref:azureml._restclient.service_context.ServiceContext>
|
Returnerar ServiceContext-objektet. |
sku
subscription_id
Returnera prenumerations-ID:t för den här arbetsytan.
Returer
Typ | Description |
---|---|
Prenumerations-ID: t. |
tags
Returnera taggarna för den här arbetsytan.
Returer
Typ | Description |
---|---|
Taggar för den här arbetsytan. |
webservices
Returnera en lista över webbtjänster på arbetsytan.
Genererar en WebserviceException om det uppstod ett problem med att returnera listan.
Returer
Typ | Description |
---|---|
En lista över webbtjänster på arbetsytan. |
Undantag
Typ | Description |
---|---|
Ett problem uppstod när listan skulle returneras. |
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'