Workspace Classe
Define um recurso do Azure Machine Learning para gerir artefactos de preparação e implementação.
Uma Área de Trabalho é um recurso fundamental para machine learning no Azure Machine Learning. Utiliza uma área de trabalho para experimentar, preparar e implementar modelos de machine learning. Cada área de trabalho está associada a uma subscrição e grupo de recursos do Azure e tem um SKU associado.
Para obter mais informações sobre áreas de trabalho, consulte:
Construtor da Área de Trabalho Escolar para carregar uma Área de Trabalho do Azure Machine Learning existente.
- Herança
-
builtins.objectWorkspace
Construtor
Workspace(subscription_id, resource_group, workspace_name, auth=None, _location=None, _disable_service_check=False, _workspace_id=None, sku='basic', tags=None, _cloud='AzureCloud')Parâmetros
| Name | Description |
|---|---|
|
subscription_id
Necessário
|
O ID da subscrição do Azure que contém a área de trabalho. |
|
resource_group
Necessário
|
O grupo de recursos que contém a área de trabalho. |
|
workspace_name
Necessário
|
O nome da área de trabalho existente. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se Nenhuma, as credenciais predefinidas da CLI do Azure serão utilizadas ou a API pedirá credenciais. valor predefinido: None
|
|
_location
|
Apenas utilização interna. valor predefinido: None
|
|
_disable_service_check
|
Apenas utilização interna. valor predefinido: False
|
|
_workspace_id
|
Apenas utilização interna. valor predefinido: None
|
|
sku
|
O parâmetro está presente para retrocompatibilidade e é ignorado. valor predefinido: basic
|
|
_cloud
|
Apenas utilização interna. valor predefinido: AzureCloud
|
|
subscription_id
Necessário
|
O ID da subscrição do Azure que contém a área de trabalho. |
|
resource_group
Necessário
|
O grupo de recursos que contém a área de trabalho. |
|
workspace_name
Necessário
|
O nome da área de trabalho. O nome tem de ter entre 2 e 32 carateres. O primeiro caráter do nome tem de ser alfanumérico (letra ou número), mas o resto do nome pode conter alfanuméricos, hífenes e sublinhados. O espaço em branco não é permitido. |
|
auth
Necessário
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se Nenhuma, as credenciais predefinidas da CLI do Azure serão utilizadas ou a API pedirá credenciais. |
|
_location
Necessário
|
Apenas utilização interna. |
|
_disable_service_check
Necessário
|
Apenas utilização interna. |
|
_workspace_id
Necessário
|
Apenas utilização interna. |
|
sku
Necessário
|
O parâmetro está presente para retrocompatibilidade e é ignorado. |
|
tags
|
Etiquetas para associar à área de trabalho. valor predefinido: None
|
|
_cloud
Necessário
|
Apenas utilização interna. |
Observações
O exemplo seguinte mostra como criar uma área de trabalho.
from azureml.core import Workspace
ws = Workspace.create(name='myworkspace',
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup',
create_resource_group=True,
location='eastus2'
)
Defina create_resource_group como Falso se tiver um grupo de recursos do Azure existente que pretende utilizar para a área de trabalho.
Para utilizar a mesma área de trabalho em vários ambientes, crie um ficheiro de configuração JSON. O ficheiro de configuração guarda o nome da sua subscrição, recurso e área de trabalho para que possa ser facilmente carregado. Para guardar a configuração, utilize o write_config método .
ws.write_config(path="./file-path", file_name="ws_config.json")
Veja Criar um ficheiro de configuração de área de trabalho para obter um exemplo do ficheiro de configuração.
Para carregar a área de trabalho a partir do ficheiro de configuração, utilize o from_config método .
ws = Workspace.from_config()
ws.get_details()
Em alternativa, utilize o get método para carregar uma área de trabalho existente sem utilizar ficheiros de configuração.
ws = Workspace.get(name="myworkspace",
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup')
Os exemplos acima podem pedir-lhe credenciais de autenticação do Azure com uma caixa de diálogo de início de sessão interativo. Para outros casos de utilização, incluindo a utilização da CLI do Azure para autenticação e autenticação em fluxos de trabalho automatizados, veja Autenticação no Azure Machine Learning.
Métodos
| add_private_endpoint |
Adicione um ponto final privado à área de trabalho. |
| create |
Crie uma nova Área de Trabalho do Azure Machine Learning. Gera uma exceção se a área de trabalho já existir ou se algum dos requisitos da área de trabalho não estiver satisfeito. |
| delete |
Elimine os recursos associados da Área de Trabalho do Azure Machine Learning. |
| delete_connection |
Elimine uma ligação da área de trabalho. |
| delete_private_endpoint_connection |
Elimine a ligação de ponto final privado à área de trabalho. |
| diagnose_workspace |
Diagnosticar problemas de configuração da área de trabalho. |
| from_config |
Devolver um objeto de área de trabalho a partir de uma Área de Trabalho do Azure Machine Learning existente. Lê a configuração da área de trabalho a partir de um ficheiro. Lança uma exceção se não for possível encontrar o ficheiro de configuração. O método fornece uma forma simples de reutilizar a mesma área de trabalho em vários blocos de notas ou projetos python. Os utilizadores podem guardar as propriedades do Azure Resource Manager (ARM) com o write_config método e utilizar este método para carregar a mesma área de trabalho em blocos de notas ou projetos Python diferentes sem voltar a escrever as propriedades do ARM da área de trabalho. |
| get |
Devolver um objeto de área de trabalho para uma Área de Trabalho do Azure Machine Learning existente. Gera uma exceção se a área de trabalho não existir ou se os campos necessários não identificarem exclusivamente uma área de trabalho. |
| get_connection |
Obter uma ligação da área de trabalho. |
| get_default_compute_target |
Obtenha o destino de computação predefinido para a área de trabalho. |
| get_default_datastore |
Obtenha o arquivo de dados predefinido para a área de trabalho. |
| get_default_keyvault |
Obtenha o objeto do cofre de chaves predefinido para a área de trabalho. |
| get_details |
Devolver os detalhes da área de trabalho. |
| get_mlflow_tracking_uri |
Obtenha o URI de controlo do MLflow para a área de trabalho. O MLflow (https://mlflow.org/) é uma plataforma open source para controlar experimentações de machine learning e gerir modelos. Pode utilizar as APIs de registo do MLflow com o Azure Machine Learning para que as métricas, modelos e artefactos sejam registados na área de trabalho do Azure Machine Learning. |
| get_run |
Devolver a execução com o run_id especificado na área de trabalho. |
| list |
Liste todas as áreas de trabalho às quais o utilizador tem acesso na subscrição. A lista de áreas de trabalho pode ser filtrada com base no grupo de recursos. |
| list_connections |
Listar ligações nesta área de trabalho. |
| list_keys |
Listar chaves para a área de trabalho atual. |
| set_connection |
Adicionar ou atualizar uma ligação na área de trabalho. |
| set_default_datastore |
Defina o arquivo de dados predefinido para a área de trabalho. |
| setup |
Crie uma nova área de trabalho ou obtenha uma área de trabalho existente. |
| sync_keys |
Aciona a área de trabalho para sincronizar imediatamente as chaves. Se as chaves de qualquer recurso na área de trabalho forem alteradas, pode demorar cerca de uma hora para que sejam atualizadas automaticamente. Esta função permite que as chaves sejam atualizadas mediante pedido. Um cenário de exemplo é a necessidade de acesso imediato ao armazenamento depois de regenerar as chaves de armazenamento. |
| update |
Atualize o nome amigável, a descrição, as etiquetas, a computação de compilação de imagens e outras definições associadas a uma área de trabalho. |
| update_dependencies |
Atualize os recursos associados existentes para a área de trabalho nos seguintes casos. a) Quando um utilizador elimina acidentalmente um recurso associado existente e quer atualizá-lo com um novo sem ter de recriar toda a área de trabalho. b) Quando um utilizador tem um recurso associado existente e quer substituir o atual associado à área de trabalho. c) Quando um recurso associado ainda não tiver sido criado e quiser utilizar um já existente que já tenha (aplica-se apenas ao registo de contentor). |
| write_config |
Escreva as propriedades do Azure Resource Manager (ARM) numa configuração de ficheiro. As propriedades arm da área de trabalho podem ser carregadas mais tarde com o from_config método . A O método fornece uma forma simples de reutilizar a mesma área de trabalho em vários blocos de notas ou projetos Python. Os utilizadores podem guardar as propriedades do ARM da área de trabalho com esta função e utilizar from_config para carregar a mesma área de trabalho em blocos de notas ou projetos Python diferentes sem voltar a escrever as propriedades do ARM da área de trabalho. |
add_private_endpoint
Adicione um ponto final privado à área de trabalho.
add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)Parâmetros
| Name | Description |
|---|---|
|
private_endpoint_config
Necessário
|
A configuração do ponto final privado para criar um ponto final privado para a área de trabalho. |
|
private_endpoint_auto_approval
|
Um sinalizador booleano que indica se a criação do ponto final privado deve ser aprovada automaticamente ou aprovada manualmente a partir do Azure Private Link Center. Em caso de aprovação manual, os utilizadores podem ver o pedido pendente no portal Private Link para aprovar/rejeitar o pedido. valor predefinido: True
|
|
location
|
Localização do ponto final privado, a predefinição é a localização da área de trabalho valor predefinido: None
|
|
show_output
|
Sinalizador para mostrar o progresso da criação da área de trabalho valor predefinido: True
|
|
tags
|
Etiquetas para associar à área de trabalho. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto PrivateEndPoint criado. |
create
Crie uma nova Área de Trabalho do Azure Machine Learning.
Gera uma exceção se a área de trabalho já existir ou se algum dos requisitos da área de trabalho não estiver satisfeito.
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)Parâmetros
| Name | Description |
|---|---|
|
name
Necessário
|
O novo nome da área de trabalho. O nome tem de ter entre 2 e 32 carateres. O primeiro caráter do nome tem de ser alfanumérico (letra ou número), mas o resto do nome pode conter alfanuméricos, hífenes e sublinhados. O espaço em branco não é permitido. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se Nenhuma, as credenciais predefinidas da CLI do Azure serão utilizadas ou a API pedirá credenciais. valor predefinido: None
|
|
subscription_id
|
O ID da subscrição que contém a nova área de trabalho. O parâmetro é necessário se o utilizador tiver acesso a mais do que uma subscrição. valor predefinido: None
|
|
resource_group
|
O grupo de recursos do Azure que contém a área de trabalho. O parâmetro é predefinido para uma mutação do nome da área de trabalho. valor predefinido: None
|
|
location
|
A localização da área de trabalho. O parâmetro é predefinido para a localização do grupo de recursos. A localização tem de ser uma região suportada para o Azure Machine Learning. valor predefinido: None
|
|
create_resource_group
|
Indica se pretende criar o grupo de recursos se não existir. valor predefinido: True
|
|
sku
|
O parâmetro está presente para retrocompatibilidade e é ignorado. valor predefinido: basic
|
|
tags
|
Etiquetas para associar à área de trabalho. valor predefinido: None
|
|
friendly_name
|
Um nome amigável opcional para a área de trabalho que pode ser apresentada na IU. valor predefinido: None
|
|
storage_account
|
Uma conta de armazenamento existente no formato de ID de recurso do Azure. O armazenamento será utilizado pela área de trabalho para guardar saídas de execução, código, registos, etc. Se Nenhuma, será criada uma nova conta de armazenamento. valor predefinido: None
|
|
key_vault
|
Um cofre de chaves existente no formato de ID de recurso do Azure. Veja o código de exemplo abaixo para obter detalhes sobre o formato do ID de recurso do Azure. O cofre de chaves será utilizado pela área de trabalho para armazenar as credenciais adicionadas à área de trabalho pelos utilizadores. Se Nenhum, será criado um novo cofre de chaves. valor predefinido: None
|
|
app_insights
|
Um Application Insights existente no formato de ID de recurso do Azure. Veja o código de exemplo abaixo para obter detalhes sobre o formato do ID de recurso do Azure. O Application Insights será utilizado pela área de trabalho para registar eventos de webservices. Se Nenhum, será criado um novo Application Insights. valor predefinido: None
|
|
container_registry
|
Um registo de contentor existente no formato de ID de recurso do Azure (veja o código de exemplo abaixo para obter detalhes sobre o formato do ID de recurso do Azure). O registo de contentor será utilizado pela área de trabalho para solicitar e emitir imagens de experimentação e webservices. Se Nenhum, um novo registo de contentor só será criado quando necessário e não juntamente com a criação da área de trabalho. valor predefinido: None
|
|
adb_workspace
|
Uma Área de Trabalho do Adb existente no formato de ID de recurso do Azure (veja o código de exemplo abaixo para obter detalhes sobre o formato do ID de recurso do Azure). A Área de Trabalho do Adb será utilizada para ligar à área de trabalho. Se Nenhuma, a ligação da área de trabalho não acontecerá. valor predefinido: None
|
|
primary_user_assigned_identity
|
O ID de recurso da identidade atribuída pelo utilizador que utilizou para representar a área de trabalho valor predefinido: None
|
|
cmk_keyvault
|
O cofre de chaves que contém a chave gerida pelo cliente no formato de ID de recurso do Azure: valor predefinido: None
|
|
resource_cmk_uri
|
O URI chave da chave gerida pelo cliente para encriptar os dados inativos.
O formato URI é: valor predefinido: None
|
|
hbi_workspace
|
Especifica se a área de trabalho contém dados de Elevado Impacto Comercial (HBI), ou seja, contém informações comerciais confidenciais. Este sinalizador só pode ser definido durante a criação da área de trabalho. O respetivo valor não pode ser alterado após a criação da área de trabalho. O valor predefinido é Falso. Quando definido como Verdadeiro, são executados mais passos de encriptação e, dependendo do componente do SDK, resulta em informações redigidas na telemetria recolhida internamente. Para obter mais informações, veja Encriptação de dados. Quando este sinalizador está definido como Verdadeiro, um impacto possível é o aumento da dificuldade na resolução de problemas. Isto pode acontecer porque alguma telemetria não é enviada para a Microsoft e há menos visibilidade sobre as taxas de sucesso ou tipos de problemas e, portanto, pode não ser capaz de reagir de forma proativa quando este sinalizador é Verdadeiro. A recomendação é utilizar a predefinição de Falso para este sinalizador, a menos que seja estritamente necessário ser Verdadeiro. valor predefinido: False
|
|
default_cpu_compute_target
|
(PRETERIDO) Uma configuração que será utilizada para criar uma computação da CPU. O parâmetro é predefinido para {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicado"} Se Nenhum, não será criada nenhuma computação. valor predefinido: None
|
|
default_gpu_compute_target
|
(PRETERIDO) Uma configuração que será utilizada para criar uma computação de GPU. O parâmetro é predefinido para {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicado"} Se Nenhum, não será criada nenhuma computação. valor predefinido: None
|
|
private_endpoint_config
|
A configuração do ponto final privado para criar um ponto final privado para a área de trabalho do Azure ML. valor predefinido: None
|
|
private_endpoint_auto_approval
|
Um sinalizador booleano que indica se a criação do ponto final privado deve ser aprovada automaticamente ou aprovada manualmente a partir do Azure Private Link Center. Em caso de aprovação manual, os utilizadores podem ver o pedido pendente no portal Private Link para aprovar/rejeitar o pedido. valor predefinido: True
|
|
exist_ok
|
Indica se este método é bem-sucedido se a área de trabalho já existir. Se For Falso, este método falhará se a área de trabalho existir. Se For Verdadeiro, este método devolve a área de trabalho existente se existir. valor predefinido: False
|
|
show_output
|
Indica se este método irá imprimir o progresso incremental. valor predefinido: True
|
|
user_assigned_identity_for_cmk_encryption
|
O ID de recurso da identidade atribuída pelo utilizador que tem de ser utilizado para aceder à chave de gestão do cliente valor predefinido: None
|
|
system_datastores_auth_mode
|
Determina se deve ou não utilizar credenciais para os arquivos de dados do sistema da área de trabalho "workspaceblobstore" e "workspacefilestore". O valor predefinido é "accessKey", caso em que a área de trabalho irá criar os arquivos de dados do sistema com credenciais. Se estiver definida como "identidade", a área de trabalho criará os arquivos de dados do sistema sem credenciais. valor predefinido: accessKey
|
|
v1_legacy_mode
|
Impedir a utilização do serviço de API v2 no Azure público Resource Manager valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto da área de trabalho. |
Exceções
| Tipo | Description |
|---|---|
|
Gerado para problemas ao criar a área de trabalho. |
Observações
Este primeiro exemplo requer apenas uma especificação mínima e todos os recursos dependentes, bem como o grupo de recursos, serão criados 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')
O exemplo seguinte mostra como reutilizar recursos existentes do Azure com o formato de ID de recurso do Azure. Os IDs de recursos específicos do Azure podem ser obtidos através do Portal do Azure ou do SDK. Isto pressupõe que o grupo de recursos, a conta de armazenamento, o cofre de chaves, o App Insights e o registo de contentor já existem.
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
Elimine os recursos associados da Área de Trabalho do Azure Machine Learning.
delete(delete_dependent_resources=False, no_wait=False)Parâmetros
| Name | Description |
|---|---|
|
delete_dependent_resources
|
Se pretende eliminar recursos associados à área de trabalho, ou seja, registo de contentor, conta de armazenamento, cofre de chaves e informações da aplicação. A predefinição é Falso. Defina como Verdadeiro para eliminar estes recursos. valor predefinido: False
|
|
no_wait
|
Se pretende aguardar a conclusão da eliminação da área de trabalho. valor predefinido: False
|
Devoluções
| Tipo | Description |
|---|---|
|
Nenhum se for bem-sucedido; caso contrário, gera um erro. |
delete_connection
Elimine uma ligação da área de trabalho.
delete_connection(name)Parâmetros
| Name | Description |
|---|---|
|
name
Necessário
|
O nome exclusivo da ligação na área de trabalho |
delete_private_endpoint_connection
Elimine a ligação de ponto final privado à área de trabalho.
delete_private_endpoint_connection(private_endpoint_connection_name)Parâmetros
| Name | Description |
|---|---|
|
private_endpoint_connection_name
Necessário
|
O nome exclusivo da ligação de ponto final privado na área de trabalho |
diagnose_workspace
Diagnosticar problemas de configuração da área de trabalho.
diagnose_workspace(diagnose_parameters)Parâmetros
| Name | Description |
|---|---|
|
diagnose_parameters
Necessário
|
<xref:_restclient.models.DiagnoseWorkspaceParameters>
O parâmetro de diagnóstico do estado de funcionamento da área de trabalho |
Devoluções
| Tipo | Description |
|---|---|
|
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]
|
Uma instância do AzureOperationPoller que devolve DiagnosticResponseResult |
from_config
Devolver um objeto de área de trabalho a partir de uma Área de Trabalho do Azure Machine Learning existente.
Lê a configuração da área de trabalho a partir de um ficheiro. Lança uma exceção se não for possível encontrar o ficheiro de configuração.
O método fornece uma forma simples de reutilizar a mesma área de trabalho em vários blocos de notas ou projetos python. Os utilizadores podem guardar as propriedades do Azure Resource Manager (ARM) com o write_config método e utilizar este método para carregar a mesma área de trabalho em blocos de notas ou projetos Python diferentes sem voltar a escrever as propriedades do ARM da área de trabalho.
static from_config(path=None, auth=None, _logger=None, _file_name=None)Parâmetros
| Name | Description |
|---|---|
|
path
|
O caminho para o ficheiro de configuração ou o diretório inicial para pesquisa. O parâmetro é predefinido para iniciar a pesquisa no diretório atual. valor predefinido: None
|
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se Nenhuma, as credenciais predefinidas da CLI do Azure serão utilizadas ou a API pedirá credenciais. valor predefinido: None
|
|
_logger
|
Permite substituir o logger predefinido. valor predefinido: None
|
|
_file_name
|
Permite substituir o nome do ficheiro de configuração para procurar quando o caminho é um caminho de diretório. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto de área de trabalho de uma Área de Trabalho do Azure ML existente. |
get
Devolver um objeto de área de trabalho para uma Área de Trabalho do Azure Machine Learning existente.
Gera uma exceção se a área de trabalho não existir ou se os campos necessários não identificarem exclusivamente uma área de trabalho.
static get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)Parâmetros
| Name | Description |
|---|---|
|
name
Necessário
|
O nome da área de trabalho a obter. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se Não, as credenciais predefinidas da CLI do Azure serão utilizadas ou a API pedirá credenciais. valor predefinido: None
|
|
subscription_id
|
O ID da subscrição a utilizar. O parâmetro é necessário se o utilizador tiver acesso a mais do que uma subscrição. valor predefinido: None
|
|
resource_group
|
O grupo de recursos a utilizar. Se Não, o método irá procurar todos os grupos de recursos na subscrição. valor predefinido: None
|
|
location
|
A localização da área de trabalho. valor predefinido: None
|
|
cloud
|
O nome da cloud de destino. Pode ser um dos "AzureCloud", "AzureChinaCloud" ou "AzureUSGovernment". Se não for especificada nenhuma cloud, será utilizado o "AzureCloud". valor predefinido: AzureCloud
|
|
id
|
O ID da área de trabalho. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto da área de trabalho. |
get_connection
Obter uma ligação da área de trabalho.
get_connection(name)Parâmetros
| Name | Description |
|---|---|
|
name
Necessário
|
O nome exclusivo da ligação na área de trabalho |
get_default_compute_target
Obtenha o destino de computação predefinido para a área de trabalho.
get_default_compute_target(type)Parâmetros
| Name | Description |
|---|---|
|
type
Necessário
|
O tipo de computação. Os valores possíveis são "CPU" ou "GPU". |
Devoluções
| Tipo | Description |
|---|---|
|
O destino de computação predefinido para um determinado tipo de computação. |
get_default_datastore
Obtenha o arquivo de dados predefinido para a área de trabalho.
get_default_datastore()Devoluções
| Tipo | Description |
|---|---|
|
O arquivo de dados predefinido. |
get_default_keyvault
Obtenha o objeto do cofre de chaves predefinido para a área de trabalho.
get_default_keyvault()Devoluções
| Tipo | Description |
|---|---|
|
O objeto KeyVault associado à área de trabalho. |
get_details
Devolver os detalhes da área de trabalho.
get_details()Devoluções
| Tipo | Description |
|---|---|
|
Detalhes da área de trabalho no formato de dicionário. |
Observações
O dicionário devolvido contém os seguintes pares chave-valor.
id: URI a apontar para este recurso da área de trabalho, que contém o ID da subscrição, o grupo de recursos e o nome da área de trabalho.
name: o nome desta área de trabalho.
localização: a região da área de trabalho.
type: um URI do formato "{providerName}/workspaces".
etiquetas: atualmente não são utilizadas.
workspaceid: o ID desta área de trabalho.
descrição: não utilizado atualmente.
friendlyName: um nome amigável para a área de trabalho apresentada na IU.
creationTime: hora em que esta área de trabalho foi criada, no formato ISO8601.
containerRegistry: o registo de contentor da área de trabalho utilizado para extrair e emitir imagens de experimentação e webservices.
keyVault: o cofre de chaves da área de trabalho utilizado para armazenar credenciais adicionadas à área de trabalho pelos utilizadores.
applicationInsights: o Application Insights será utilizado pela área de trabalho para registar eventos de webservices.
identityPrincipalId:
identityTenantId
identityType
storageAccount: o armazenamento será utilizado pela área de trabalho para guardar saídas de execução, código, registos, etc.
sku: o SKU da área de trabalho (também conhecido como edição). O parâmetro está presente para retrocompatibilidade e é ignorado.
resourceCmkUri: o URI da chave gerida pelo cliente para encriptar os dados inativos. Veja para obter https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 os passos sobre como criar uma chave e obter o URI.
hbiWorkspace: especifica se os dados do cliente têm um elevado impacto comercial.
imageBuildCompute: o destino de computação para a compilação da imagem.
systemDatastoresAuthMode: determina se deve ou não utilizar credenciais para os arquivos de dados do sistema da área de trabalho "workspaceblobstore" e "workspacefilestore". O valor predefinido é "accessKey", caso em que a área de trabalho irá criar os arquivos de dados do sistema com credenciais. Se estiver definida como "identidade", a área de trabalho criará os arquivos de dados do sistema sem credenciais.
Para obter mais informações sobre estes pares chave-valor, consulte create.
get_mlflow_tracking_uri
Obtenha o URI de controlo do MLflow para a área de trabalho.
O MLflow (https://mlflow.org/) é uma plataforma open source para controlar experimentações de machine learning e gerir modelos. Pode utilizar as APIs de registo do MLflow com o Azure Machine Learning para que as métricas, modelos e artefactos sejam registados na área de trabalho do Azure Machine Learning.
get_mlflow_tracking_uri(_with_auth=False)Parâmetros
| Name | Description |
|---|---|
|
_with_auth
|
(PRETERIDO) Adicione informações de autenticação para controlar o URI. valor predefinido: False
|
Devoluções
| Tipo | Description |
|---|---|
|
O URI de controlo compatível com MLflow. |
Observações
Utilize o exemplo seguinte para configurar o controlo do MLflow para enviar dados para a Área de Trabalho do Azure ML:
import mlflow
from azureml.core import Workspace
workspace = Workspace.from_config()
mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())
get_run
Devolver a execução com o run_id especificado na área de trabalho.
get_run(run_id)Parâmetros
| Name | Description |
|---|---|
|
run_id
Necessário
|
O ID de execução. |
Devoluções
| Tipo | Description |
|---|---|
|
A execução submetida. |
list
Liste todas as áreas de trabalho às quais o utilizador tem acesso na subscrição.
A lista de áreas de trabalho pode ser filtrada com base no grupo de recursos.
static list(subscription_id, auth=None, resource_group=None)Parâmetros
| Name | Description |
|---|---|
|
subscription_id
Necessário
|
O ID da subscrição para o qual listar áreas de trabalho. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se Não, as credenciais predefinidas da CLI do Azure serão utilizadas ou a API pedirá credenciais. valor predefinido: None
|
|
resource_group
|
Um grupo de recursos para filtrar as áreas de trabalho devolvidas. Se Não, o método listará todas as áreas de trabalho na subscrição especificada. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário onde a chave é o nome da área de trabalho e o valor é uma lista de objetos da Área de Trabalho. |
list_connections
Listar ligações nesta área de trabalho.
list_connections(category=None, target=None)Parâmetros
| Name | Description |
|---|---|
|
type
Necessário
|
O tipo desta ligação que será filtrada em |
|
target
|
o destino desta ligação que será filtrada em valor predefinido: None
|
|
category
|
valor predefinido: None
|
list_keys
set_connection
Adicionar ou atualizar uma ligação na área de trabalho.
set_connection(name, category, target, authType, value)Parâmetros
| Name | Description |
|---|---|
|
name
Necessário
|
O nome exclusivo da ligação na área de trabalho |
|
category
Necessário
|
A categoria desta ligação |
|
target
Necessário
|
o destino a que esta ligação se liga |
|
authType
Necessário
|
o tipo de autorização desta ligação |
|
value
Necessário
|
a cadeia de serialização do formato json dos detalhes da ligação |
set_default_datastore
Defina o arquivo de dados predefinido para a área de trabalho.
set_default_datastore(name)Parâmetros
| Name | Description |
|---|---|
|
name
Necessário
|
O nome do Datastore para predefinido. |
setup
Crie uma nova área de trabalho ou obtenha uma área de trabalho existente.
static setup()Devoluções
| Tipo | Description |
|---|---|
|
Um objeto de Área de Trabalho. |
sync_keys
Aciona a área de trabalho para sincronizar imediatamente as chaves.
Se as chaves de qualquer recurso na área de trabalho forem alteradas, pode demorar cerca de uma hora para que sejam atualizadas automaticamente. Esta função permite que as chaves sejam atualizadas mediante pedido. Um cenário de exemplo é a necessidade de acesso imediato ao armazenamento depois de regenerar as chaves de armazenamento.
sync_keys(no_wait=False)Parâmetros
| Name | Description |
|---|---|
|
no_wait
|
Se pretende aguardar a conclusão das chaves de sincronização da área de trabalho. valor predefinido: False
|
Devoluções
| Tipo | Description |
|---|---|
|
Nenhum se for bem-sucedido; caso contrário, gera um erro. |
update
Atualize o nome amigável, a descrição, as etiquetas, a computação de compilação de imagens e outras definições associadas a uma área de trabalho.
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)Parâmetros
| Name | Description |
|---|---|
|
friendly_name
|
Um nome amigável para a área de trabalho que pode ser apresentado na IU. valor predefinido: None
|
|
description
|
Uma descrição da área de trabalho. valor predefinido: None
|
|
tags
|
Etiquetas a associar à área de trabalho. valor predefinido: None
|
|
image_build_compute
|
O nome de computação da compilação da imagem. valor predefinido: None
|
|
service_managed_resources_settings
|
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
As definições de recursos geridos pelo serviço. valor predefinido: None
|
|
primary_user_assigned_identity
|
O ID do recurso de identidade atribuído pelo utilizador que representa a identidade da área de trabalho. valor predefinido: None
|
|
allow_public_access_when_behind_vnet
|
Permitir o acesso público à área de trabalho de ligação privada. valor predefinido: None
|
|
v1_legacy_mode
|
Impedir a utilização do serviço de API v2 no Azure público Resource Manager valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário de informações atualizadas. |
update_dependencies
Atualize os recursos associados existentes para a área de trabalho nos seguintes casos.
a) Quando um utilizador elimina acidentalmente um recurso associado existente e quer atualizá-lo com um novo sem ter de recriar toda a área de trabalho. b) Quando um utilizador tem um recurso associado existente e quer substituir o atual associado à área de trabalho. c) Quando um recurso associado ainda não tiver sido criado e quiser utilizar um já existente que já tenha (aplica-se apenas ao registo de contentor).
update_dependencies(container_registry=None, force=False)Parâmetros
| Name | Description |
|---|---|
|
container_registry
|
ID do ARM para o registo de contentor. valor predefinido: None
|
|
force
|
Se forçar a atualização de recursos dependentes sem confirmação pedida. valor predefinido: False
|
Devoluções
| Tipo | Description |
|---|---|
write_config
Escreva as propriedades do Azure Resource Manager (ARM) numa configuração de ficheiro.
As propriedades arm da área de trabalho podem ser carregadas mais tarde com o from_config método . A path predefinição é ".azureml/" no diretório de trabalho atual e file_name a predefinição é "config.json".
O método fornece uma forma simples de reutilizar a mesma área de trabalho em vários blocos de notas ou projetos Python. Os utilizadores podem guardar as propriedades do ARM da área de trabalho com esta função e utilizar from_config para carregar a mesma área de trabalho em blocos de notas ou projetos Python diferentes sem voltar a escrever as propriedades do ARM da área de trabalho.
write_config(path=None, file_name=None)Parâmetros
| Name | Description |
|---|---|
|
path
|
O utilizador forneceu a localização para escrever o ficheiro config.json. O parâmetro é predefinido para ".azureml/" no diretório de trabalho atual. valor predefinido: None
|
|
file_name
|
Nome a utilizar para o ficheiro de configuração. O parâmetro é predefinido para config.json. valor predefinido: None
|
Atributos
compute_targets
Listar todos os destinos de computação na área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome de destino de computação e valor como ComputeTarget objeto. |
datasets
Listar todos os conjuntos de dados na área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome e valor do conjunto de dados como Dataset objeto. |
datastores
Listar todos os arquivos de dados na área de trabalho. Esta operação não devolve credenciais dos arquivos de dados.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome e valor do arquivo de dados como Datastore objeto. |
discovery_url
Devolva o URL de deteção desta área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
O URL de deteção desta área de trabalho. |
environments
Listar todos os ambientes na área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome do ambiente e valor como Environment objeto. |
experiments
Listar todas as experimentações na área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome de experimentação e valor como Experiment objeto. |
images
Devolva a lista de imagens na área de trabalho.
Gera um WebserviceException problema se ocorreu um problema ao interagir com o serviço de gestão de modelos.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome de imagem e valor como Image objeto. |
Exceções
| Tipo | Description |
|---|---|
|
Ocorreu um problema ao interagir com o serviço de gestão de modelos. |
linked_services
Listar todos os serviços ligados na área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário em que a chave é um nome de serviço ligado e o valor é um LinkedService objeto. |
location
Devolva a localização desta área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
A localização desta área de trabalho. |
models
Devolver uma lista de modelos na área de trabalho.
Gera um WebserviceException problema se ocorreu um problema ao interagir com o serviço de gestão de modelos.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário de modelo com chave como nome de modelo e valor como Model objeto. |
Exceções
| Tipo | Description |
|---|---|
|
Ocorreu um problema ao interagir com o serviço de gestão de modelos. |
name
private_endpoints
Listar todos os pontos finais privados da área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um ditado de objetos PrivateEndPoint associados à área de trabalho. A chave é nome de ponto final privado. |
resource_group
Devolva o nome do grupo de recursos para esta área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
O nome do grupo de recursos. |
service_context
Devolva o contexto de serviço para esta área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
<xref:azureml._restclient.service_context.ServiceContext>
|
Devolve o objeto ServiceContext. |
sku
subscription_id
Devolva o ID da subscrição para esta área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
O ID da subscrição. |
tags
Devolva as Etiquetas desta área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
As Etiquetas desta área de trabalho. |
webservices
Devolva uma lista de serviços Web na área de trabalho.
Levanta um WebserviceException problema se ocorreu um problema ao devolver a lista.
Devoluções
| Tipo | Description |
|---|---|
|
Uma lista de webservices na área de trabalho. |
Exceções
| Tipo | Description |
|---|---|
|
Ocorreu um problema ao devolver a lista. |
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'Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários