Condividi tramite


Workspace Classe

Definisce una risorsa di Azure Machine Learning per la gestione di artefatti di training e distribuzione.

Un'area di lavoro è una risorsa fondamentale per l'apprendimento automatico in Azure Machine Learning. Si usa un'area di lavoro per sperimentare, eseguire il training e distribuire modelli di Machine Learning. Ogni area di lavoro è associata a una sottoscrizione di Azure e a un gruppo di risorse e ha uno SKU associato.

Per altre informazioni sulle aree di lavoro, vedere:

Costruttore dell'area di lavoro per la classe per caricare un'area di lavoro di Azure Machine Learning esistente.

Ereditarietà
builtins.object
Workspace

Costruttore

Workspace(subscription_id, resource_group, workspace_name, auth=None, _location=None, _disable_service_check=False, _workspace_id=None, sku='basic', tags=None, _cloud='AzureCloud')

Parametri

Nome Descrizione
subscription_id
Necessario
str

ID sottoscrizione di Azure contenente l'area di lavoro.

resource_group
Necessario
str

Gruppo di risorse contenente l'area di lavoro.

workspace_name
Necessario
str

Nome dell'area di lavoro esistente.

auth

Oggetto di autenticazione. Per altri dettagli, vedere https://aka.ms/aml-notebook-auth. Se Nessuno, verranno usate le credenziali predefinite dell'interfaccia della riga di comando di Azure o l'API richiederà le credenziali.

Valore predefinito: None
_location
str

Solo per uso interno.

Valore predefinito: None
_disable_service_check

Solo per uso interno.

Valore predefinito: False
_workspace_id
str

Solo per uso interno.

Valore predefinito: None
sku
str

Il parametro è presente per la compatibilità con le versioni precedenti e viene ignorato.

Valore predefinito: basic
_cloud
str

Solo per uso interno.

Valore predefinito: AzureCloud
subscription_id
Necessario
str

ID sottoscrizione di Azure contenente l'area di lavoro.

resource_group
Necessario
str

Gruppo di risorse contenente l'area di lavoro.

workspace_name
Necessario
str

Nome dell'area di lavoro. Il nome deve avere una lunghezza compresa tra 2 e 32 caratteri. Il primo carattere del nome deve essere alfanumerico (lettera o numero), ma il resto del nome può contenere caratteri alfanumerici, trattini e caratteri di sottolineatura. Gli spazi vuoti non sono consentiti.

auth
Necessario

Oggetto di autenticazione. Per altri dettagli, vedere https://aka.ms/aml-notebook-auth. Se Nessuno, verranno usate le credenziali predefinite dell'interfaccia della riga di comando di Azure o l'API richiederà le credenziali.

_location
Necessario
str

Solo per uso interno.

_disable_service_check
Necessario

Solo per uso interno.

_workspace_id
Necessario
str

Solo per uso interno.

sku
Necessario
str

Il parametro è presente per la compatibilità con le versioni precedenti e viene ignorato.

tags

Tag da associare all'area di lavoro.

Valore predefinito: None
_cloud
Necessario
str

Solo per uso interno.

Commenti

L'esempio seguente illustra come creare un'area di lavoro.


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

Impostare su create_resource_group False se si ha un gruppo di risorse di Azure esistente che si vuole usare per l'area di lavoro.

Per usare la stessa area di lavoro in più ambienti, creare un file di configurazione JSON. Il file di configurazione salva la sottoscrizione, la risorsa e il nome dell'area di lavoro in modo che possa essere caricato facilmente. Per salvare la configurazione, utilizzare il write_config metodo .


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

Per un esempio del file di configurazione, vedere Creare un file di configurazione dell'area di lavoro .

Per caricare l'area di lavoro dal file di configurazione, usare il from_config metodo .


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

In alternativa, usare il get metodo per caricare un'area di lavoro esistente senza usare i file di configurazione.


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

Gli esempi precedenti possono richiedere le credenziali di autenticazione di Azure usando una finestra di dialogo di accesso interattivo. Per altri casi d'uso, tra cui l'uso dell'interfaccia della riga di comando di Azure per l'autenticazione e l'autenticazione nei flussi di lavoro automatizzati, vedere Autenticazione in Azure Machine Learning.

Metodi

add_private_endpoint

Aggiungere un endpoint privato all'area di lavoro.

create

Creare una nuova area di lavoro di Azure Machine Learning.

Genera un'eccezione se l'area di lavoro esiste già o uno dei requisiti dell'area di lavoro non è soddisfatta.

delete

Eliminare le risorse associate all'area di lavoro di Azure Machine Learning.

delete_connection

Eliminare una connessione dell'area di lavoro.

delete_private_endpoint_connection

Eliminare la connessione dell'endpoint privato all'area di lavoro.

diagnose_workspace

Diagnosticare i problemi di configurazione dell'area di lavoro.

from_config

Restituire un oggetto area di lavoro da un'area di lavoro di Azure Machine Learning esistente.

Legge la configurazione dell'area di lavoro da un file. Genera un'eccezione se non è possibile trovare il file di configurazione.

Il metodo offre un modo semplice per riutilizzare la stessa area di lavoro in più notebook o progetti Python. Gli utenti possono salvare le proprietà di Azure Resource Manager (ARM) dell'area di lavoro usando il write_config metodo e usare questo metodo per caricare la stessa area di lavoro in notebook o progetti Python diversi senza digitare le proprietà di Resource Manager dell'area di lavoro.

get

Restituire un oggetto area di lavoro per un'area di lavoro di Azure Machine Learning esistente.

Genera un'eccezione se l'area di lavoro non esiste o i campi obbligatori non identificano in modo univoco un'area di lavoro.

get_connection

Ottenere una connessione dell'area di lavoro.

get_default_compute_target

Ottenere la destinazione di calcolo predefinita per l'area di lavoro.

get_default_datastore

Ottenere l'archivio dati predefinito per l'area di lavoro.

get_default_keyvault

Ottiene l'oggetto insieme di credenziali delle chiavi predefinito per l'area di lavoro.

get_details

Restituisce i dettagli dell'area di lavoro.

get_mlflow_tracking_uri

Ottenere l'URI di rilevamento MLflow per l'area di lavoro.

MLflow (https://mlflow.org/) è una piattaforma open source per tenere traccia degli esperimenti di Machine Learning e della gestione dei modelli. È possibile usare le API di registrazione di MLflow con Azure Machine Learning in modo che le metriche, i modelli e gli artefatti vengano registrati nell'area di lavoro di Azure Machine Learning.

get_run

Restituisce l'esecuzione con il run_id specificato nell'area di lavoro.

list

Elencare tutte le aree di lavoro a cui l'utente può accedere all'interno della sottoscrizione.

L'elenco delle aree di lavoro può essere filtrato in base al gruppo di risorse.

list_connections

Elencare le connessioni in questa area di lavoro.

list_keys

Elencare le chiavi per l'area di lavoro corrente.

set_connection

Aggiungere o aggiornare una connessione nell'area di lavoro.

set_default_datastore

Impostare l'archivio dati predefinito per l'area di lavoro.

setup

Creare una nuova area di lavoro o recuperare un'area di lavoro esistente.

sync_keys

Attiva l'area di lavoro per sincronizzare immediatamente le chiavi.

Se le chiavi per qualsiasi risorsa nell'area di lavoro vengono modificate, l'aggiornamento automatico può richiedere circa un'ora. Questa funzione consente l'aggiornamento delle chiavi su richiesta. Uno scenario di esempio richiede l'accesso immediato all'archiviazione dopo la rigenerazione delle chiavi di archiviazione.

update

Aggiornare il nome descrittivo, la descrizione, i tag, il calcolo della compilazione di immagini e altre impostazioni associate a un'area di lavoro.

update_dependencies

Aggiornare le risorse associate per l'area di lavoro nei casi seguenti.

a) Quando un utente elimina accidentalmente una risorsa associata esistente e vuole aggiornarla con una nuova senza dover ricreare l'intera area di lavoro. b) Quando un utente ha una risorsa associata esistente e vuole sostituire quella corrente associata all'area di lavoro. c) Quando non è ancora stata creata una risorsa associata e si vuole usare una risorsa esistente già presente (si applica solo al registro contenitori).

write_config

Scrivere le proprietà di Azure Resource Manager (ARM) dell'area di lavoro in un file di configurazione.

Le proprietà arm dell'area di lavoro possono essere caricate in un secondo momento usando il from_config metodo . Il path valore predefinito è '.azureml/' nella directory di lavoro corrente e file_name il valore predefinito è 'config.json'.

Il metodo offre un modo semplice per riutilizzare la stessa area di lavoro in più notebook o progetti Python. Gli utenti possono salvare le proprietà arm dell'area di lavoro usando questa funzione e usare from_config per caricare la stessa area di lavoro in diversi notebook o progetti Python senza digitare di nuovo le proprietà arm dell'area di lavoro.

add_private_endpoint

Aggiungere un endpoint privato all'area di lavoro.

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

Parametri

Nome Descrizione
private_endpoint_config
Necessario

Configurazione dell'endpoint privato per creare un endpoint privato nell'area di lavoro.

private_endpoint_auto_approval

Flag booleano che indica se la creazione dell'endpoint privato deve essere approvata automaticamente o approvata manualmente da collegamento privato di Azure Center. In caso di approvazione manuale, gli utenti possono visualizzare la richiesta in sospeso in collegamento privato portale per approvare/rifiutare la richiesta.

Valore predefinito: True
location

Posizione dell'endpoint privato, il valore predefinito è il percorso dell'area di lavoro

Valore predefinito: None
show_output

Flag per visualizzare lo stato di avanzamento della creazione dell'area di lavoro

Valore predefinito: True
tags

Tag da associare all'area di lavoro.

Valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto PrivateEndPoint creato.

create

Creare una nuova area di lavoro di Azure Machine Learning.

Genera un'eccezione se l'area di lavoro esiste già o uno dei requisiti dell'area di lavoro non è soddisfatta.

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)

Parametri

Nome Descrizione
name
Necessario
str

Nuovo nome dell'area di lavoro. Il nome deve avere una lunghezza compresa tra 2 e 32 caratteri. Il primo carattere del nome deve essere alfanumerico (lettera o numero), ma il resto del nome può contenere caratteri alfanumerici, trattini e caratteri di sottolineatura. Lo spazio vuoto non è consentito.

auth

Oggetto di autenticazione. Per altre informazioni, vedere https://aka.ms/aml-notebook-auth. Se None, le credenziali predefinite dell'interfaccia della riga di comando di Azure verranno usate o l'API richiederà le credenziali.

Valore predefinito: None
subscription_id
str

ID sottoscrizione della sottoscrizione contenente per la nuova area di lavoro. Il parametro è necessario se l'utente ha accesso a più sottoscrizioni.

Valore predefinito: None
resource_group
str

Gruppo di risorse di Azure contenente l'area di lavoro. Il parametro è predefinito in una mutazione del nome dell'area di lavoro.

Valore predefinito: None
location
str

Posizione dell'area di lavoro. Il parametro viene predefinito nel percorso del gruppo di risorse. La posizione deve essere un'area supportata per Azure Machine Learning.

Valore predefinito: None
create_resource_group

Indica se creare il gruppo di risorse se non esiste.

Valore predefinito: True
sku
str

Il parametro è presente per la compatibilità con le versioni precedenti e viene ignorato.

Valore predefinito: basic
tags

Tag da associare all'area di lavoro.

Valore predefinito: None
friendly_name
str

Nome descrittivo facoltativo per l'area di lavoro che può essere visualizzata nell'interfaccia utente.

Valore predefinito: None
storage_account
str

Un account di archiviazione esistente nel formato ID risorsa di Azure. L'archiviazione verrà usata dall'area di lavoro per salvare output, codice, log e così via. Se None, verrà creato un nuovo account di archiviazione.

Valore predefinito: None
key_vault
str

Insieme di credenziali delle chiavi esistente nel formato ID risorsa di Azure. Per informazioni dettagliate sul formato ID risorsa di Azure, vedere il codice di esempio seguente. L'insieme di credenziali delle chiavi verrà usato dall'area di lavoro per archiviare le credenziali aggiunte all'area di lavoro dagli utenti. Se None, verrà creato un nuovo insieme di credenziali delle chiavi.

Valore predefinito: None
app_insights
str

Application Insights esistente nel formato ID risorsa di Azure. Per informazioni dettagliate sul formato ID risorsa di Azure, vedere il codice di esempio seguente. Application Insights verrà usato dall'area di lavoro per registrare gli eventi dei servizi Web. Se None, verrà creato un nuovo Application Insights.

Valore predefinito: None
container_registry
str

Un registro contenitori esistente nel formato ID risorsa di Azure (vedere il codice di esempio seguente per informazioni dettagliate sul formato ID risorsa di Azure). Il registro contenitori verrà usato dall'area di lavoro per eseguire il pull e il push di immagini sia di sperimentazione che di servizi Web. Se None, verrà creato un nuovo registro contenitori solo quando necessario e non insieme alla creazione dell'area di lavoro.

Valore predefinito: None
adb_workspace
str

Un'area di lavoro Adb esistente nel formato ID risorsa di Azure (vedere il codice di esempio seguente per informazioni dettagliate sul formato ID risorsa di Azure). L'area di lavoro di Adb verrà usata per collegare l'area di lavoro. Se None, il collegamento all'area di lavoro non verrà eseguito.

Valore predefinito: None
primary_user_assigned_identity
str

ID risorsa dell'identità assegnata dall'utente usata per rappresentare l'area di lavoro

Valore predefinito: None
cmk_keyvault
str

Insieme di credenziali delle chiavi contenente la chiave gestita dal cliente nel formato ID risorsa di Azure: /subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Ad esempio: '/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault' Vedere il codice di esempio riportato di seguito per altri dettagli sul formato ID risorsa di Azure.

Valore predefinito: None
resource_cmk_uri
str

URI chiave della chiave gestita dal cliente per crittografare i dati inattivi. Il formato URI è: https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Ad esempio, "https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b". https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal Per informazioni su come creare una chiave e ottenere l'URI, vedere la procedura seguente.

Valore predefinito: None
hbi_workspace

Specifica se l'area di lavoro contiene dati di High Business Impact (HBI), ovvero contiene informazioni aziendali sensibili. Questo flag può essere impostato solo durante la creazione dell'area di lavoro. Il valore non può essere modificato dopo la creazione dell'area di lavoro. Il valore predefinito è False.

Se impostato su True, vengono eseguiti altri passaggi di crittografia e, a seconda del componente SDK, vengono restituite informazioni ridistribuite nei dati di telemetria raccolti internamente. Per altre informazioni, vedere Crittografia dei dati.

Quando questo flag è impostato su True, un possibile impatto è maggiore difficoltà a risolvere i problemi. Ciò potrebbe verificarsi perché alcuni dati di telemetria non vengono inviati a Microsoft e non è disponibile visibilità nei tassi di esito positivo o nei tipi di problemi, pertanto potrebbe non essere in grado di reagire in modo proattivo quando questo flag è True. La raccomandazione usa il valore predefinito di False per questo flag, a meno che non sia strettamente necessario essere True.

Valore predefinito: False
default_cpu_compute_target

(DEPRECATO) Configurazione che verrà usata per creare un calcolo della CPU. Il parametro viene predefinito su {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicato"} Se None, non verrà creato alcun calcolo.

Valore predefinito: None
default_gpu_compute_target

(DEPRECATO) Configurazione che verrà usata per creare un calcolo GPU. Il parametro viene predefinito su {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicato"} Se None, non verrà creato alcun calcolo.

Valore predefinito: None
private_endpoint_config

Configurazione dell'endpoint privato per creare un endpoint privato nell'area di lavoro di Azure ML.

Valore predefinito: None
private_endpoint_auto_approval

Flag booleano che indica se la creazione dell'endpoint privato deve essere approvata automaticamente o approvata manualmente da collegamento privato di Azure Center. In caso di approvazione manuale, gli utenti possono visualizzare la richiesta in sospeso in collegamento privato portale per approvare/rifiutare la richiesta.

Valore predefinito: True
exist_ok

Indica se questo metodo ha esito positivo se l'area di lavoro esiste già. Se False, questo metodo ha esito negativo se l'area di lavoro esiste. Se True, questo metodo restituisce l'area di lavoro esistente se esistente.

Valore predefinito: False
show_output

Indica se questo metodo stampa lo stato incrementale.

Valore predefinito: True
user_assigned_identity_for_cmk_encryption
str

ID risorsa dell'identità assegnata dall'utente che deve essere usata per accedere alla chiave di gestione del cliente

Valore predefinito: None
system_datastores_auth_mode
str

Determina se usare o meno le credenziali per gli archivi dati di sistema dell'area di lavoro 'workspaceblobstore' e 'workspacefilestore'. Il valore predefinito è "accessKey", in questo caso, l'area di lavoro creerà gli archivi dati di sistema con le credenziali. Se impostato su 'identity', l'area di lavoro creerà gli archivi dati di sistema senza credenziali.

Valore predefinito: accessKey
v1_legacy_mode

Impedire l'uso del servizio API v2 in Azure pubblico Resource Manager

Valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto area di lavoro.

Eccezioni

Tipo Descrizione

Generato per problemi durante la creazione dell'area di lavoro.

Commenti

Questo primo esempio richiede solo specifiche minime e tutte le risorse dipendenti e il gruppo di risorse verrà creato automaticamente.


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

Nell'esempio seguente viene illustrato come riutilizzare le risorse di Azure esistenti usando il formato ID risorsa di Azure. Gli ID risorsa di Azure specifici possono essere recuperati tramite il portale di Azure o l'SDK. Ciò presuppone che il gruppo di risorse, l'account di archiviazione, l'insieme di credenziali delle chiavi, il Registro App Insights e il registro contenitori esistano già.


   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

Eliminare le risorse associate all'area di lavoro di Azure Machine Learning.

delete(delete_dependent_resources=False, no_wait=False)

Parametri

Nome Descrizione
delete_dependent_resources

Se eliminare le risorse associate all'area di lavoro, ad esempio il Registro contenitori, l'account di archiviazione, l'insieme di credenziali delle chiavi e le informazioni dettagliate sulle applicazioni. Il valore predefinito è False. Impostare su True per eliminare queste risorse.

Valore predefinito: False
no_wait

Se attendere il completamento dell'eliminazione dell'area di lavoro.

Valore predefinito: False

Restituisce

Tipo Descrizione

Nessuno se ha esito positivo; in caso contrario, genera un errore.

delete_connection

Eliminare una connessione dell'area di lavoro.

delete_connection(name)

Parametri

Nome Descrizione
name
Necessario
str

Nome univoco della connessione nell'area di lavoro

delete_private_endpoint_connection

Eliminare la connessione dell'endpoint privato all'area di lavoro.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parametri

Nome Descrizione
private_endpoint_connection_name
Necessario
str

Nome univoco della connessione dell'endpoint privato nell'area di lavoro

diagnose_workspace

Diagnosticare i problemi di configurazione dell'area di lavoro.

diagnose_workspace(diagnose_parameters)

Parametri

Nome Descrizione
diagnose_parameters
Necessario
<xref:_restclient.models.DiagnoseWorkspaceParameters>

Parametro dell'integrità dell'area di lavoro di diagnosi

Restituisce

Tipo Descrizione
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]

Istanza di AzureOperationPoller che restituisce DiagnosiResponseResult

from_config

Restituire un oggetto area di lavoro da un'area di lavoro di Azure Machine Learning esistente.

Legge la configurazione dell'area di lavoro da un file. Genera un'eccezione se non è possibile trovare il file di configurazione.

Il metodo offre un modo semplice per riutilizzare la stessa area di lavoro in più notebook o progetti Python. Gli utenti possono salvare le proprietà di Azure Resource Manager (ARM) dell'area di lavoro usando il write_config metodo e usare questo metodo per caricare la stessa area di lavoro in notebook o progetti Python diversi senza digitare le proprietà di Resource Manager dell'area di lavoro.

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

Parametri

Nome Descrizione
path
str

Percorso del file di configurazione o avvio della directory da cercare. Il parametro è predefinito per avviare la ricerca nella directory corrente.

Valore predefinito: None
auth

Oggetto di autenticazione. Per altre informazioni, vedere https://aka.ms/aml-notebook-auth. Se None, le credenziali predefinite dell'interfaccia della riga di comando di Azure verranno usate o l'API richiederà le credenziali.

Valore predefinito: None
_logger

Consente di eseguire l'override del logger predefinito.

Valore predefinito: None
_file_name
str

Consente di eseguire l'override del nome del file di configurazione per cercare quando il percorso è un percorso della directory.

Valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto area di lavoro per un'area di lavoro di Azure ML esistente.

get

Restituire un oggetto area di lavoro per un'area di lavoro di Azure Machine Learning esistente.

Genera un'eccezione se l'area di lavoro non esiste o i campi obbligatori non identificano in modo univoco un'area di lavoro.

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

Parametri

Nome Descrizione
name
Necessario
str

Nome dell'area di lavoro da ottenere.

auth

Oggetto di autenticazione. Per altri dettagli, vedere https://aka.ms/aml-notebook-auth. Se Nessuno, verranno usate le credenziali predefinite dell'interfaccia della riga di comando di Azure o l'API richiederà le credenziali.

Valore predefinito: None
subscription_id
str

ID sottoscrizione da usare. Il parametro è obbligatorio se l'utente ha accesso a più sottoscrizioni.

Valore predefinito: None
resource_group
str

Gruppo di risorse da usare. Se Nessuno, il metodo eseguirà la ricerca in tutti i gruppi di risorse nella sottoscrizione.

Valore predefinito: None
location
str

Posizione dell'area di lavoro.

Valore predefinito: None
cloud
str

Nome del cloud di destinazione. Può essere uno di "AzureCloud", "AzureChinaCloud" o "AzureUSGovernment". Se non viene specificato alcun cloud , viene usato "AzureCloud".

Valore predefinito: AzureCloud
id
str

ID dell'area di lavoro.

Valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto area di lavoro.

get_connection

Ottenere una connessione dell'area di lavoro.

get_connection(name)

Parametri

Nome Descrizione
name
Necessario
str

Nome univoco della connessione nell'area di lavoro

get_default_compute_target

Ottenere la destinazione di calcolo predefinita per l'area di lavoro.

get_default_compute_target(type)

Parametri

Nome Descrizione
type
Necessario
str

Tipo di calcolo. I valori possibili sono "CPU" o "GPU".

Restituisce

Tipo Descrizione

Destinazione di calcolo predefinita per il tipo di calcolo specificato.

get_default_datastore

Ottenere l'archivio dati predefinito per l'area di lavoro.

get_default_datastore()

Restituisce

Tipo Descrizione

Archivio dati predefinito.

get_default_keyvault

Ottiene l'oggetto insieme di credenziali delle chiavi predefinito per l'area di lavoro.

get_default_keyvault()

Restituisce

Tipo Descrizione

Oggetto KeyVault associato all'area di lavoro.

get_details

Restituisce i dettagli dell'area di lavoro.

get_details()

Restituisce

Tipo Descrizione

Dettagli dell'area di lavoro in formato dizionario.

Commenti

Il dizionario restituito contiene le coppie chiave-valore seguenti.

  • id: URI che punta a questa risorsa dell'area di lavoro, contenente l'ID sottoscrizione, il gruppo di risorse e il nome dell'area di lavoro.

  • name: nome dell'area di lavoro.

  • location: area dell'area di lavoro.

  • type: URI del formato "{providerName}/workspaces".

  • tags: non attualmente usato.

  • workspaceid: ID dell'area di lavoro.

  • description: non attualmente utilizzato.

  • friendlyName: nome descrittivo per l'area di lavoro visualizzata nell'interfaccia utente.

  • creationTime: ora di creazione dell'area di lavoro, in formato ISO8601.

  • containerRegistry: registro contenitori dell'area di lavoro usato per eseguire il pull e il push di immagini di sperimentazione e servizi Web.

  • keyVault: insieme di credenziali delle chiavi dell'area di lavoro usato per archiviare le credenziali aggiunte all'area di lavoro dagli utenti.

  • applicationInsights: Application Insights verrà usato dall'area di lavoro per registrare gli eventi dei servizi Web.

  • identityPrincipalId:

  • identityTenantId

  • identityType

  • storageAccount: l'archiviazione verrà usata dall'area di lavoro per salvare output di esecuzione, codice, log e così via.

  • sku: SKU dell'area di lavoro (noto anche come edizione). Il parametro è presente per la compatibilità con le versioni precedenti e viene ignorato.

  • resourceCmkUri: URI della chiave gestita dal cliente per crittografare i dati inattivi. Per informazioni su come creare una chiave e ottenere l'URI, fare riferimento a https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 per informazioni su come creare una chiave.

  • hbiWorkspace: specifica se i dati dei clienti hanno un impatto aziendale elevato.

  • imageBuildCompute: destinazione di calcolo per la compilazione di immagini.

  • systemDatastoresAuthMode: determina se usare o meno le credenziali per gli archivi dati di sistema dell'area di lavoro 'workspaceblobstore' e 'workspacefilestore'. Il valore predefinito è "accessKey", in questo caso l'area di lavoro creerà gli archivi dati di sistema con le credenziali. Se impostato su "identity", l'area di lavoro creerà gli archivi dati di sistema senza credenziali.

Per altre informazioni su queste coppie chiave-valore, vedere create.

get_mlflow_tracking_uri

Ottenere l'URI di rilevamento MLflow per l'area di lavoro.

MLflow (https://mlflow.org/) è una piattaforma open source per tenere traccia degli esperimenti di Machine Learning e della gestione dei modelli. È possibile usare le API di registrazione di MLflow con Azure Machine Learning in modo che le metriche, i modelli e gli artefatti vengano registrati nell'area di lavoro di Azure Machine Learning.

get_mlflow_tracking_uri(_with_auth=False)

Parametri

Nome Descrizione
_with_auth

(DEPRECATO) Aggiungere informazioni di autenticazione all'URI di rilevamento.

Valore predefinito: False

Restituisce

Tipo Descrizione
str

URI di rilevamento compatibile con MLflow.

Commenti

Usare l'esempio seguente per configurare il rilevamento MLflow per inviare dati all'area di lavoro di Azure ML:


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

get_run

Restituisce l'esecuzione con il run_id specificato nell'area di lavoro.

get_run(run_id)

Parametri

Nome Descrizione
run_id
Necessario

ID esecuzione.

Restituisce

Tipo Descrizione
Run

Esecuzione inviata.

list

Elencare tutte le aree di lavoro a cui l'utente può accedere all'interno della sottoscrizione.

L'elenco delle aree di lavoro può essere filtrato in base al gruppo di risorse.

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

Parametri

Nome Descrizione
subscription_id
Necessario
str

ID sottoscrizione per cui elencare le aree di lavoro.

auth

Oggetto di autenticazione. Per altri dettagli, vedere https://aka.ms/aml-notebook-auth. Se Nessuno, verranno usate le credenziali predefinite dell'interfaccia della riga di comando di Azure o l'API richiederà le credenziali.

Valore predefinito: None
resource_group
str

Gruppo di risorse per filtrare le aree di lavoro restituite. Se Nessuno, il metodo elenca tutte le aree di lavoro all'interno della sottoscrizione specificata.

Valore predefinito: None

Restituisce

Tipo Descrizione

Dizionario in cui la chiave è il nome dell'area di lavoro e il valore è un elenco di oggetti Workspace.

list_connections

Elencare le connessioni in questa area di lavoro.

list_connections(category=None, target=None)

Parametri

Nome Descrizione
type
Necessario
str

Tipo di connessione in base al quale verrà applicato un filtro

target
str

destinazione di questa connessione che verrà filtrata in base

Valore predefinito: None
category
Valore predefinito: None

list_keys

Elencare le chiavi per l'area di lavoro corrente.

list_keys()

Restituisce

Tipo Descrizione

set_connection

Aggiungere o aggiornare una connessione nell'area di lavoro.

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

Parametri

Nome Descrizione
name
Necessario
str

Nome univoco della connessione nell'area di lavoro

category
Necessario
str

Categoria di questa connessione

target
Necessario
str

la destinazione a cui si connette questa connessione

authType
Necessario
str

il tipo di autorizzazione di questa connessione

value
Necessario
str

stringa di serializzazione in formato JSON dei dettagli della connessione

set_default_datastore

Impostare l'archivio dati predefinito per l'area di lavoro.

set_default_datastore(name)

Parametri

Nome Descrizione
name
Necessario
str

Nome dell'oggetto Datastore da impostare come predefinito.

setup

Creare una nuova area di lavoro o recuperare un'area di lavoro esistente.

static setup()

Restituisce

Tipo Descrizione

Oggetto Workspace.

sync_keys

Attiva l'area di lavoro per sincronizzare immediatamente le chiavi.

Se le chiavi per qualsiasi risorsa nell'area di lavoro vengono modificate, l'aggiornamento automatico può richiedere circa un'ora. Questa funzione consente l'aggiornamento delle chiavi su richiesta. Uno scenario di esempio richiede l'accesso immediato all'archiviazione dopo la rigenerazione delle chiavi di archiviazione.

sync_keys(no_wait=False)

Parametri

Nome Descrizione
no_wait

Indica se attendere il completamento delle chiavi di sincronizzazione dell'area di lavoro.

Valore predefinito: False

Restituisce

Tipo Descrizione

Nessuno se ha esito positivo; in caso contrario, genera un errore.

update

Aggiornare il nome descrittivo, la descrizione, i tag, il calcolo della compilazione di immagini e altre impostazioni associate a un'area di lavoro.

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)

Parametri

Nome Descrizione
friendly_name
str

Nome descrittivo per l'area di lavoro che può essere visualizzata nell'interfaccia utente.

Valore predefinito: None
description
str

Descrizione dell'area di lavoro.

Valore predefinito: None
tags

Tag da associare all'area di lavoro.

Valore predefinito: None
image_build_compute
str

Nome di calcolo per la compilazione dell'immagine.

Valore predefinito: None
service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>

Impostazioni delle risorse gestite dal servizio.

Valore predefinito: None
primary_user_assigned_identity
str

ID risorsa identità assegnata dall'utente che rappresenta l'identità dell'area di lavoro.

Valore predefinito: None
allow_public_access_when_behind_vnet

Consentire l'accesso pubblico all'area di lavoro collegamento privato.

Valore predefinito: None
v1_legacy_mode

Impedire l'uso del servizio API v2 in Azure pubblico Resource Manager

Valore predefinito: None

Restituisce

Tipo Descrizione

Dizionario di informazioni aggiornate.

update_dependencies

Aggiornare le risorse associate per l'area di lavoro nei casi seguenti.

a) Quando un utente elimina accidentalmente una risorsa associata esistente e vuole aggiornarla con una nuova senza dover ricreare l'intera area di lavoro. b) Quando un utente ha una risorsa associata esistente e vuole sostituire quella corrente associata all'area di lavoro. c) Quando non è ancora stata creata una risorsa associata e si vuole usare una risorsa esistente già presente (si applica solo al registro contenitori).

update_dependencies(container_registry=None, force=False)

Parametri

Nome Descrizione
container_registry
str

ID ARM per il registro contenitori.

Valore predefinito: None
force

Se forzare l'aggiornamento delle risorse dipendenti senza confermare.

Valore predefinito: False

Restituisce

Tipo Descrizione

write_config

Scrivere le proprietà di Azure Resource Manager (ARM) dell'area di lavoro in un file di configurazione.

Le proprietà arm dell'area di lavoro possono essere caricate in un secondo momento usando il from_config metodo . Il path valore predefinito è '.azureml/' nella directory di lavoro corrente e file_name il valore predefinito è 'config.json'.

Il metodo offre un modo semplice per riutilizzare la stessa area di lavoro in più notebook o progetti Python. Gli utenti possono salvare le proprietà arm dell'area di lavoro usando questa funzione e usare from_config per caricare la stessa area di lavoro in diversi notebook o progetti Python senza digitare di nuovo le proprietà arm dell'area di lavoro.

write_config(path=None, file_name=None)

Parametri

Nome Descrizione
path
str

Percorso specificato dall'utente per scrivere il file config.json. Per impostazione predefinita, il parametro è '.azureml/' nella directory di lavoro corrente.

Valore predefinito: None
file_name
str

Nome da usare per il file di configurazione. Per impostazione predefinita, il parametro è config.json.

Valore predefinito: None

Attributi

compute_targets

Elencare tutte le destinazioni di calcolo nell'area di lavoro.

Restituisce

Tipo Descrizione

Dizionario con chiave come nome di destinazione di calcolo e valore come ComputeTarget oggetto.

datasets

Elencare tutti i set di dati nell'area di lavoro.

Restituisce

Tipo Descrizione

Dizionario con chiave come nome e valore del set di dati come Dataset oggetto.

datastores

Elencare tutti gli archivi dati nell'area di lavoro. Questa operazione non restituisce le credenziali degli archivi dati.

Restituisce

Tipo Descrizione

Dizionario con chiave come nome e valore dell'archivio dati come Datastore oggetto.

discovery_url

Restituisce l'URL di individuazione dell'area di lavoro.

Restituisce

Tipo Descrizione
str

URL di individuazione dell'area di lavoro.

environments

Elencare tutti gli ambienti nell'area di lavoro.

Restituisce

Tipo Descrizione

Dizionario con chiave come nome e valore dell'ambiente come Environment oggetto.

experiments

Elencare tutti gli esperimenti nell'area di lavoro.

Restituisce

Tipo Descrizione

Dizionario con chiave come nome e valore dell'esperimento come Experiment oggetto.

images

Restituisce l'elenco di immagini nell'area di lavoro.

Genera un'eccezione WebserviceException se si è verificato un problema durante l'interazione con il servizio di gestione dei modelli.

Restituisce

Tipo Descrizione

Dizionario con chiave come nome immagine e valore come Image oggetto.

Eccezioni

Tipo Descrizione

Si è verificato un problema durante l'interazione con il servizio di gestione dei modelli.

linked_services

Elencare tutti i servizi collegati nell'area di lavoro.

Restituisce

Tipo Descrizione

Dizionario in cui la chiave è un nome di servizio collegato e un valore è un LinkedService oggetto .

location

Restituisce la posizione dell'area di lavoro.

Restituisce

Tipo Descrizione
str

Posizione dell'area di lavoro.

models

Restituisce un elenco di modelli nell'area di lavoro.

Genera un'eccezione WebserviceException se si è verificato un problema durante l'interazione con il servizio di gestione dei modelli.

Restituisce

Tipo Descrizione

Dizionario del modello con chiave come nome del modello e valore come Model oggetto.

Eccezioni

Tipo Descrizione

Si è verificato un problema durante l'interazione con il servizio di gestione dei modelli.

name

Restituisce il nome dell'area di lavoro.

Restituisce

Tipo Descrizione
str

Nome dell'area di lavoro.

private_endpoints

Elencare tutti gli endpoint privati dell'area di lavoro.

Restituisce

Tipo Descrizione

Dict di oggetti PrivateEndPoint associati all'area di lavoro. La chiave è il nome dell'endpoint privato.

resource_group

Restituisce il nome del gruppo di risorse per questa area di lavoro.

Restituisce

Tipo Descrizione
str

Il nome del gruppo di risorse.

service_context

Restituisce il contesto del servizio per questa area di lavoro.

Restituisce

Tipo Descrizione
<xref:azureml._restclient.service_context.ServiceContext>

Restituisce l'oggetto ServiceContext.

sku

Restituisce lo SKU di questa area di lavoro.

Restituisce

Tipo Descrizione
str

SKU di questa area di lavoro.

subscription_id

Restituisce l'ID sottoscrizione per questa area di lavoro.

Restituisce

Tipo Descrizione
str

ID della sottoscrizione.

tags

Restituisce i tag dell'area di lavoro.

Restituisce

Tipo Descrizione

Tag di questa area di lavoro.

webservices

Restituisce un elenco di servizi Web nell'area di lavoro.

Genera un'eccezione WebserviceException se si è verificato un problema durante la restituzione dell'elenco.

Restituisce

Tipo Descrizione

Elenco di servizi Web nell'area di lavoro.

Eccezioni

Tipo Descrizione

Si è verificato un problema durante la restituzione dell'elenco.

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'