Workspace Klass

Definierar en Azure Machine Learning-resurs för hantering av 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:

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

Parametrar

subscription_id
str
Obligatorisk

Azure-prenumerations-ID:t som innehåller arbetsytan.

resource_group
str
Obligatorisk

Resursgruppen som innehåller arbetsytan.

workspace_name
str
Obligatorisk

Det befintliga arbetsytans namn.

auth
ServicePrincipalAuthentication eller InteractiveLoginAuthentication eller MsiAuthentication
standardvärde: None

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
str
standardvärde: None

Endast internt bruk.

_disable_service_check
bool
standardvärde: False

Endast internt bruk.

_workspace_id
str
standardvärde: None

Endast internt bruk.

sku
str
standardvärde: basic

Parametern finns för bakåtkompatibilitet och ignoreras.

_cloud
str
standardvärde: None

Endast internt bruk.

_cloud
standardvärde: AzureCloud

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

Ställ in create_resource_group på 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 namnet på din prenumeration, resurs och arbetsyta så att den enkelt kan läsas in. Om du vill spara konfigurationen använder du write_config metoden .


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

Ett exempel på konfigurationsfilen finns i Skapa en konfigurationsfil för arbetsytan .

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 autentisering och autentisering i automatiserade arbetsflöden, finns i Autentisering i Azure Machine Learning.

Metoder

add_private_endpoint

Lägg till en privat slutpunkt på 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 avbildningsversion 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 resursen 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 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-anteckningsböcker eller projekt utan att skriva om ARM-egenskaperna för arbetsytan.

add_private_endpoint

Lägg till en privat slutpunkt på arbetsytan.

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

Parametrar

private_endpoint_config
PrivateEndPointConfig
Obligatorisk

Konfigurationen av den privata slutpunkten för att skapa en privat slutpunkt till arbetsytan.

private_endpoint_auto_approval
bool
standardvärde: True

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.

location
string
standardvärde: None

Plats för den privata slutpunkten, standard är arbetsytans plats

show_output
bool
standardvärde: True

Flagga för att visa förloppet för att skapa arbetsytan

tags
dict
standardvärde: None

Taggar som ska associeras med arbetsytan.

Returer

PrivateEndPoint-objektet skapades.

Returtyp

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
str
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 tal), men resten av namnet kan innehålla alfanumeriska tecken, bindestreck och understreck. Tomt utrymme tillåts inte.

auth
ServicePrincipalAuthentication eller InteractiveLoginAuthentication
standardvärde: None

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.

subscription_id
str
standardvärde: None

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.

resource_group
str
standardvärde: None

Den Azure-resursgrupp som innehåller arbetsytan. Parametern är som standard en mutation av arbetsytans namn.

location
str
standardvärde: None

Arbetsytans plats. Parametern är som standard resursgruppens plats. Platsen måste vara en region som stöds för Azure Machine Learning.

create_resource_group
bool
standardvärde: True

Anger om resursgruppen ska skapas om den inte finns.

sku
str
standardvärde: basic

Parametern finns för bakåtkompatibilitet och ignoreras.

tags
dict
standardvärde: None

Taggar som ska associeras med arbetsytan.

friendly_name
str
standardvärde: None

Ett valfritt eget namn för arbetsytan som kan visas i användargränssnittet.

storage_account
str
standardvärde: None

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.

key_vault
str
standardvärde: None

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.

app_insights
str
standardvärde: None

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.

container_registry
str
standardvärde: None

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.

adb_workspace
str
standardvärde: None

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.

primary_user_assigned_identity
str
standardvärde: None

Resurs-ID för den användartilldelade identitet som användes för att representera arbetsytan

cmk_keyvault
str
standardvärde: None

Nyckelvalvet som innehåller den kundhanterade nyckeln i Azure-resurs-ID-formatet:/subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Exempel: "/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault" Se exempelkoden i kommentarerna nedan för mer information om Azure-resurs-ID-formatet.

resource_cmk_uri
str
standardvärde: None

Nyckel-URI för den kundhanterade nyckeln för att kryptera vilande data. URI-formatet är: https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Till exempel "https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b". https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal Se för anvisningar om hur du skapar en nyckel och hämtar dess URI.

hbi_workspace
bool
standardvärde: False

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.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
standardvärde: None

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

default_gpu_compute_target
AmlComputeProvisioningConfiguration
standardvärde: None

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

private_endpoint_config
PrivateEndPointConfig
standardvärde: None

Konfigurationen av den privata slutpunkten för att skapa en privat slutpunkt till Azure ML-arbetsytan.

private_endpoint_auto_approval
bool
standardvärde: True

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.

exist_ok
bool
standardvärde: False

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.

show_output
bool
standardvärde: True

Anger om den här metoden ska skriva ut inkrementella förlopp.

user_assigned_identity_for_cmk_encryption
str
standardvärde: None

Resurs-ID:t för den användartilldelade identiteten som måste användas för att få åtkomst till kundhanterarnyckeln

system_datastores_auth_mode
str
standardvärde: accessKey

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.

v1_legacy_mode
bool
standardvärde: None

Förhindra användning av v2 API-tjänsten på offentliga Azure Resource Manager

Returer

Arbetsyteobjektet.

Returtyp

Undantag

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

delete_dependent_resources
bool
standardvärde: False

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.

no_wait
bool
standardvärde: False

Om du vill vänta tills borttagningen av arbetsytan har slutförts.

Returer

Ingen om det lyckas; annars utlöser ett fel.

Returtyp

delete_connection

Ta bort en anslutning till arbetsytan.

delete_connection(name)

Parametrar

name
str
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

private_endpoint_connection_name
str
Obligatorisk

Det unika namnet på den privata slutpunktsanslutningen under arbetsytan

diagnose_workspace

Diagnostisera konfigurationsproblem för arbetsytan.

diagnose_workspace(diagnose_parameters)

Parametrar

diagnose_parameters
<xref:_restclient.models.DiagnoseWorkspaceParameters>
Obligatorisk

Parametern för att diagnostisera arbetsytans hälsa

Returer

En instans av AzureOperationPoller som returnerar DiagnoseResponseResult

Returtyp

AzureOperationPoller[<xref:_restclient.models.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

path
str
standardvärde: None

Sökvägen till konfigurationsfilen eller startkatalogen för sökning. Parametern startar som standard sökningen i den aktuella katalogen.

auth
ServicePrincipalAuthentication eller InteractiveLoginAuthentication
standardvärde: None

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.

_logger
Logger
standardvärde: None

Tillåter åsidosättande av standardloggaren.

_file_name
str
standardvärde: None

Gör att du kan åsidosätta konfigurationsfilnamnet för att söka efter när sökvägen är en katalogsökväg.

Returer

Arbetsyteobjektet för en befintlig Azure ML-arbetsyta.

Returtyp

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
str
Obligatorisk

Namnet på arbetsytan som ska hämtas.

auth
ServicePrincipalAuthentication eller InteractiveLoginAuthentication
standardvärde: None

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.

subscription_id
str
standardvärde: None

Det prenumerations-ID som ska användas. Parametern krävs om användaren har åtkomst till fler än en prenumeration.

resource_group
str
standardvärde: None

Den resursgrupp som ska användas. Om den är Ingen söker metoden igenom alla resursgrupper i prenumerationen.

location
str
standardvärde: None

Arbetsytans plats.

cloud
str
standardvärde: AzureCloud

Namnet på målmolnet. Kan vara något av "AzureCloud", "AzureChinaCloud" eller "AzureUSGovernment". Om inget moln anges används "AzureCloud".

id
str
standardvärde: None

ID för arbetsytan.

Returer

Arbetsyteobjektet.

Returtyp

get_connection

Hämta en anslutning till arbetsytan.

get_connection(name)

Parametrar

name
str
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

type
str
Obligatorisk

Typ av beräkning. Möjliga värden är "CPU" eller "GPU".

Returer

Standardberäkningsmålet för den angivna beräkningstypen.

Returtyp

get_default_datastore

Hämta standarddatalagringen för arbetsytan.

get_default_datastore()

Returer

Standarddatalager.

Returtyp

get_default_keyvault

Hämta standardnyckelvalvsobjektet för arbetsytan.

get_default_keyvault()

Returer

Det KeyVault-objekt som är associerat med arbetsytan.

Returtyp

get_details

Returnera information om arbetsytan.

get_details()

Returer

Arbetsyteinformation i ordlisteformat.

Returtyp

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

_with_auth
bool
standardvärde: False

(INAKTUELL) Lägg till autentiseringsinformation i spårnings-URI.

Returer

MLflow-kompatibel spårnings-URI.

Returtyp

str

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

run_id
string
Obligatorisk

Körnings-ID:t.

Returer

Den skickade körningen.

Returtyp

Run

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

subscription_id
str
Obligatorisk

Det prenumerations-ID som arbetsytor ska listas för.

auth
ServicePrincipalAuthentication eller InteractiveLoginAuthentication
standardvärde: None

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.

resource_group
str
standardvärde: None

En resursgrupp för att filtrera de returnerade arbetsytorna. Om ingen visas en lista över alla arbetsytor i den angivna prenumerationen.

Returer

En ordlista där nyckeln är arbetsytans namn och värdet är en lista över arbetsyteobjekt.

Returtyp

list_connections

Lista anslutningar under den här arbetsytan.

list_connections(category=None, target=None)

Parametrar

type
str
standardvärde: None

Den typ av anslutning som ska filtreras på

target
str
standardvärde: None

målet för den här anslutningen som ska filtreras på

list_keys

Visa en lista över nycklar för den aktuella arbetsytan.

list_keys()

Returtyp

set_connection

Lägg till eller uppdatera en anslutning under arbetsytan.

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

Parametrar

name
str
Obligatorisk

Det unika namnet på anslutningen under arbetsytan

category
str
Obligatorisk

Kategorin för den här anslutningen

target
str
Obligatorisk

målet som anslutningen ansluter till

authType
str
Obligatorisk

auktoriseringstypen för den här anslutningen

value
str
Obligatorisk

json-formatserialiseringssträngen för anslutningsinformationen

set_default_datastore

Ange standarddatalager för arbetsytan.

set_default_datastore(name)

Parametrar

name
str
Obligatorisk

Namnet på som Datastore ska anges som standard.

setup

Skapa en ny arbetsyta eller hämta en befintlig arbetsyta.

static setup()

Returer

Ett arbetsyteobjekt.

Returtyp

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

no_wait
bool
standardvärde: False

Om du vill vänta tills synkroniseringsnycklarna för arbetsytan har slutförts.

Returer

Ingen om det lyckas; annars utlöser ett fel.

Returtyp

update

Uppdatera eget namn, beskrivning, taggar, beräkning av avbildningsversion 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

friendly_name
str
standardvärde: None

Ett eget namn för arbetsytan som kan visas i användargränssnittet.

description
str
standardvärde: None

En beskrivning av arbetsytan.

tags
dict
standardvärde: None

Taggar som ska associeras med arbetsytan.

image_build_compute
str
standardvärde: None

Beräkningsnamnet för avbildningsversionen.

service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
standardvärde: None

Inställningarna för tjänsthanterade resurser.

primary_user_assigned_identity
str
standardvärde: None

Resurs-ID:t för den användartilldelade identiteten som representerar arbetsytans identitet.

allow_public_access_when_behind_vnet
bool
standardvärde: None

Tillåt offentlig åtkomst till arbetsytan Private Link.

v1_legacy_mode
bool
standardvärde: None

Förhindra användning av v2 API-tjänsten på offentliga Azure Resource Manager

Returer

En ordlista med uppdaterad information.

Returtyp

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 resursen 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

container_registry
str
standardvärde: None

ARM-ID för containerregistret.

force
bool
standardvärde: False

Om framtvinga uppdatering av beroende resurser utan att du tillfrågas om bekräftelse.

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-anteckningsböcker eller projekt utan att skriva om ARM-egenskaperna för arbetsytan.

write_config(path=None, file_name=None)

Parametrar

path
str
standardvärde: None

Användaren angav en plats där filen config.json skulle skrivas. Parametern är som standard ".azureml/" i den aktuella arbetskatalogen.

file_name
str
standardvärde: None

Namn som ska användas för konfigurationsfilen. Parametern är som standard config.json.

Attribut

compute_targets

Visa en lista över alla beräkningsmål på arbetsytan.

Returer

En ordlista med nyckel som beräkningsmålnamn och värde som ComputeTarget objekt.

Returtyp

datasets

Visa en lista över alla datauppsättningar på arbetsytan.

Returer

En ordlista med nyckel som datauppsättningsnamn och värde som Dataset objekt.

Returtyp

datastores

Visa en lista över alla datalager på arbetsytan. Den här åtgärden returnerar inte autentiseringsuppgifter för datalager.

Returer

En ordlista med nyckel som datalagernamn och värde som Datastore objekt.

Returtyp

discovery_url

Returnera identifierings-URL:en för den här arbetsytan.

Returer

Identifierings-URL:en för den här arbetsytan.

Returtyp

str

environments

Visa en lista över alla miljöer på arbetsytan.

Returer

En ordlista med nyckel som miljönamn och värde som Environment objekt.

Returtyp

experiments

Visa en lista över alla experiment på arbetsytan.

Returer

En ordlista med nyckel som experimentnamn och värde som Experiment objekt.

Returtyp

images

Returnera listan med bilder på arbetsytan.

Genererar ett WebserviceException om det uppstod ett problem med att interagera med modellhanteringstjänsten.

Returer

En ordlista med nyckel som bildnamn och värde som Image objekt.

Returtyp

Undantag

Det uppstod ett problem med att interagera med modellhanteringstjänsten.

linked_services

Visa en lista över alla länkade tjänster på arbetsytan.

Returer

En ordlista där nyckeln är ett länkat tjänstnamn och värde är ett LinkedService objekt.

Returtyp

location

Returnera platsen för den här arbetsytan.

Returer

Platsen för den här arbetsytan.

Returtyp

str

models

Returnera en lista över modellen på arbetsytan.

Genererar ett WebserviceException om det uppstod ett problem med att interagera med modellhanteringstjänsten.

Returer

En ordlista med modell med nyckeln som modellnamn och värde som Model objekt.

Returtyp

Undantag

Det uppstod ett problem med att interagera med modellhanteringstjänsten.

name

Returnera namnet på arbetsytan.

Returer

Namnet på arbetsytan.

Returtyp

str

private_endpoints

Visa en lista över alla privata slutpunkter för arbetsytan.

Returer

En dikta av PrivateEndPoint-objekt som är associerade med arbetsytan. Nyckeln är namnet på den privata slutpunkten.

Returtyp

resource_group

Returnera resursgruppens namn för den här arbetsytan.

Returer

Resursgruppens namn.

Returtyp

str

service_context

Returnera tjänstkontexten för den här arbetsytan.

Returer

Returnerar ServiceContext-objektet.

Returtyp

<xref:azureml._restclient.service_context.ServiceContext>

sku

Returnera SKU:n för den här arbetsytan.

Returer

SKU:n för den här arbetsytan.

Returtyp

str

subscription_id

Returnera prenumerations-ID:t för den här arbetsytan.

Returer

Prenumerations-ID:t.

Returtyp

str

tags

Returnera taggarna för den här arbetsytan.

Returer

Taggarna för den här arbetsytan.

Returtyp

webservices

Returnera en lista över webbtjänster på arbetsytan.

Genererar ett WebserviceException om det uppstod ett problem med att returnera listan.

Returer

En lista över webbtjänster på arbetsytan.

Returtyp

Undantag

Det gick inte att returnera listan.

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'