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.object
Workspace

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

subscription_id
str
Necessário

O ID da subscrição do Azure que contém a área de trabalho.

resource_group
str
Necessário

O grupo de recursos que contém a área de trabalho.

workspace_name
str
Necessário

O nome da área de trabalho existente.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication ou MsiAuthentication
valor predefinido: None

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
str
valor predefinido: None

Apenas utilização interna.

_disable_service_check
bool
valor predefinido: False

Apenas utilização interna.

_workspace_id
str
valor predefinido: None

Apenas utilização interna.

sku
str
valor predefinido: basic

O parâmetro está presente para retrocompatibilidade e é ignorado.

_cloud
str
valor predefinido: AzureCloud

Apenas utilização interna.

subscription_id
str
Necessário

O ID da subscrição do Azure que contém a área de trabalho.

resource_group
str
Necessário

O grupo de recursos que contém a área de trabalho.

workspace_name
str
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
ServicePrincipalAuthentication ou InteractiveLoginAuthentication ou MsiAuthentication
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
str
Necessário

Apenas utilização interna.

_disable_service_check
bool
Necessário

Apenas utilização interna.

_workspace_id
str
Necessário

Apenas utilização interna.

sku
str
Necessário

O parâmetro está presente para retrocompatibilidade e é ignorado.

tags
dict
valor predefinido: None

Etiquetas para associar à área de trabalho.

_cloud
str
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 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.

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

private_endpoint_config
PrivateEndPointConfig
Necessário

A configuração do ponto final privado para criar um ponto final privado para a área de trabalho.

private_endpoint_auto_approval
bool
valor predefinido: True

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.

location
string
valor predefinido: None

Localização do ponto final privado, a predefinição é a localização da área de trabalho

show_output
bool
valor predefinido: True

Sinalizador para mostrar o progresso da criação da área de trabalho

tags
dict
valor predefinido: None

Etiquetas para associar à área de trabalho.

Devoluções

O objeto PrivateEndPoint criado.

Tipo de retorno

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
str
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
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor predefinido: None

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.

subscription_id
str
valor predefinido: None

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.

resource_group
str
valor predefinido: None

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.

location
str
valor predefinido: None

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.

create_resource_group
bool
valor predefinido: True

Indica se pretende criar o grupo de recursos se não existir.

sku
str
valor predefinido: basic

O parâmetro está presente para retrocompatibilidade e é ignorado.

tags
dict
valor predefinido: None

Etiquetas para associar à área de trabalho.

friendly_name
str
valor predefinido: None

Um nome amigável opcional para a área de trabalho que pode ser apresentada na IU.

storage_account
str
valor predefinido: None

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.

key_vault
str
valor predefinido: None

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.

app_insights
str
valor predefinido: None

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.

container_registry
str
valor predefinido: None

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.

adb_workspace
str
valor predefinido: None

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

primary_user_assigned_identity
str
valor predefinido: None

O ID de recurso da identidade atribuída pelo utilizador que utilizou para representar a área de trabalho

cmk_keyvault
str
valor predefinido: None

O cofre de chaves que contém a chave gerida pelo cliente no formato de ID de recurso do Azure:/subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Por exemplo: "/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault" Consulte o código de exemplo nas Observações abaixo para obter mais detalhes sobre o formato de ID de recurso do Azure.

resource_cmk_uri
str
valor predefinido: None

O URI chave da chave gerida pelo cliente para encriptar os dados inativos. O formato URI é: https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Por exemplo, "https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b". Veja para https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal obter os passos sobre como criar uma chave e obter o respetivo URI.

hbi_workspace
bool
valor predefinido: False

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.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
valor predefinido: None

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

default_gpu_compute_target
AmlComputeProvisioningConfiguration
valor predefinido: None

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

private_endpoint_config
PrivateEndPointConfig
valor predefinido: None

A configuração do ponto final privado para criar um ponto final privado para a área de trabalho do Azure ML.

private_endpoint_auto_approval
bool
valor predefinido: True

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.

exist_ok
bool
valor predefinido: False

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.

show_output
bool
valor predefinido: True

Indica se este método irá imprimir o progresso incremental.

user_assigned_identity_for_cmk_encryption
str
valor predefinido: None

O ID de recurso da identidade atribuída pelo utilizador que tem de ser utilizado para aceder à chave de gestão do cliente

system_datastores_auth_mode
str
valor predefinido: accessKey

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.

v1_legacy_mode
bool
valor predefinido: None

Impedir a utilização do serviço de API v2 no Azure público Resource Manager

Devoluções

O objeto da área de trabalho.

Tipo de retorno

Exceções

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

delete_dependent_resources
bool
valor predefinido: False

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.

no_wait
bool
valor predefinido: False

Se pretende aguardar a conclusão da eliminação da área de trabalho.

Devoluções

Nenhum se for bem-sucedido; caso contrário, gera um erro.

Tipo de retorno

delete_connection

Elimine uma ligação da área de trabalho.

delete_connection(name)

Parâmetros

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

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

diagnose_parameters
<xref:_restclient.models.DiagnoseWorkspaceParameters>
Necessário

O parâmetro de diagnóstico do estado de funcionamento da área de trabalho

Devoluções

Uma instância do AzureOperationPoller que devolve DiagnosticResponseResult

Tipo de retorno

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

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

path
str
valor predefinido: None

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.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor predefinido: None

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.

_logger
Logger
valor predefinido: None

Permite substituir o logger predefinido.

_file_name
str
valor predefinido: None

Permite substituir o nome do ficheiro de configuração para procurar quando o caminho é um caminho de diretório.

Devoluções

O objeto de área de trabalho de uma Área de Trabalho do Azure ML existente.

Tipo de retorno

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
str
Necessário

O nome da área de trabalho a obter.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor predefinido: None

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.

subscription_id
str
valor predefinido: None

O ID da subscrição a utilizar. O parâmetro é necessário se o utilizador tiver acesso a mais do que uma subscrição.

resource_group
str
valor predefinido: None

O grupo de recursos a utilizar. Se Não, o método irá procurar todos os grupos de recursos na subscrição.

location
str
valor predefinido: None

A localização da área de trabalho.

cloud
str
valor predefinido: AzureCloud

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

id
str
valor predefinido: None

O ID da área de trabalho.

Devoluções

O objeto da área de trabalho.

Tipo de retorno

get_connection

Obter uma ligação da área de trabalho.

get_connection(name)

Parâmetros

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

type
str
Necessário

O tipo de computação. Os valores possíveis são "CPU" ou "GPU".

Devoluções

O destino de computação predefinido para um determinado tipo de computação.

Tipo de retorno

get_default_datastore

Obtenha o arquivo de dados predefinido para a área de trabalho.

get_default_datastore()

Devoluções

O arquivo de dados predefinido.

Tipo de retorno

get_default_keyvault

Obtenha o objeto do cofre de chaves predefinido para a área de trabalho.

get_default_keyvault()

Devoluções

O objeto KeyVault associado à área de trabalho.

Tipo de retorno

get_details

Devolver os detalhes da área de trabalho.

get_details()

Devoluções

Detalhes da área de trabalho no formato de dicionário.

Tipo de retorno

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

_with_auth
bool
valor predefinido: False

(PRETERIDO) Adicione informações de autenticação para controlar o URI.

Devoluções

O URI de controlo compatível com MLflow.

Tipo de retorno

str

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

run_id
string
Necessário

O ID de execução.

Devoluções

A execução submetida.

Tipo de retorno

Run

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

subscription_id
str
Necessário

O ID da subscrição para o qual listar áreas de trabalho.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor predefinido: None

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.

resource_group
str
valor predefinido: None

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.

Devoluções

Um dicionário onde a chave é o nome da área de trabalho e o valor é uma lista de objetos da Área de Trabalho.

Tipo de retorno

list_connections

Listar ligações nesta área de trabalho.

list_connections(category=None, target=None)

Parâmetros

type
str
Necessário

O tipo desta ligação que será filtrada em

target
str
valor predefinido: None

o destino desta ligação que será filtrada em

category
valor predefinido: None

list_keys

Listar chaves para a área de trabalho atual.

list_keys()

Tipo de retorno

set_connection

Adicionar ou atualizar uma ligação na área de trabalho.

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

Parâmetros

name
str
Necessário

O nome exclusivo da ligação na área de trabalho

category
str
Necessário

A categoria desta ligação

target
str
Necessário

o destino a que esta ligação se liga

authType
str
Necessário

o tipo de autorização desta ligação

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

Um objeto de Área de Trabalho.

Tipo de retorno

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

no_wait
bool
valor predefinido: False

Se pretende aguardar a conclusão das chaves de sincronização da área de trabalho.

Devoluções

Nenhum se for bem-sucedido; caso contrário, gera um erro.

Tipo de retorno

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

friendly_name
str
valor predefinido: None

Um nome amigável para a área de trabalho que pode ser apresentado na IU.

description
str
valor predefinido: None

Uma descrição da área de trabalho.

tags
dict
valor predefinido: None

Etiquetas a associar à área de trabalho.

image_build_compute
str
valor predefinido: None

O nome de computação da compilação da imagem.

service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
valor predefinido: None

As definições de recursos geridos pelo serviço.

primary_user_assigned_identity
str
valor predefinido: None

O ID do recurso de identidade atribuído pelo utilizador que representa a identidade da área de trabalho.

allow_public_access_when_behind_vnet
bool
valor predefinido: None

Permitir o acesso público à área de trabalho de ligação privada.

v1_legacy_mode
bool
valor predefinido: None

Impedir a utilização do serviço de API v2 no Azure público Resource Manager

Devoluções

Um dicionário de informações atualizadas.

Tipo de retorno

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

container_registry
str
valor predefinido: None

ID do ARM para o registo de contentor.

force
bool
valor predefinido: False

Se forçar a atualização de recursos dependentes sem confirmação pedida.

Tipo de retorno

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

path
str
valor predefinido: None

O utilizador forneceu a localização para escrever o ficheiro config.json. O parâmetro é predefinido para ".azureml/" no diretório de trabalho atual.

file_name
str
valor predefinido: None

Nome a utilizar para o ficheiro de configuração. O parâmetro é predefinido para config.json.

Atributos

compute_targets

Listar todos os destinos de computação na área de trabalho.

Devoluções

Um dicionário com chave como nome de destino de computação e valor como ComputeTarget objeto.

Tipo de retorno

datasets

Listar todos os conjuntos de dados na área de trabalho.

Devoluções

Um dicionário com chave como nome e valor do conjunto de dados como Dataset objeto.

Tipo de retorno

datastores

Listar todos os arquivos de dados na área de trabalho. Esta operação não devolve credenciais dos arquivos de dados.

Devoluções

Um dicionário com chave como nome e valor do arquivo de dados como Datastore objeto.

Tipo de retorno

discovery_url

Devolva o URL de deteção desta área de trabalho.

Devoluções

O URL de deteção desta área de trabalho.

Tipo de retorno

str

environments

Listar todos os ambientes na área de trabalho.

Devoluções

Um dicionário com chave como nome do ambiente e valor como Environment objeto.

Tipo de retorno

experiments

Listar todas as experimentações na área de trabalho.

Devoluções

Um dicionário com chave como nome de experimentação e valor como Experiment objeto.

Tipo de retorno

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

Um dicionário com chave como nome de imagem e valor como Image objeto.

Tipo de retorno

Exceções

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

Um dicionário em que a chave é um nome de serviço ligado e o valor é um LinkedService objeto.

Tipo de retorno

location

Devolva a localização desta área de trabalho.

Devoluções

A localização desta área de trabalho.

Tipo de retorno

str

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

Um dicionário de modelo com chave como nome de modelo e valor como Model objeto.

Tipo de retorno

Exceções

Ocorreu um problema ao interagir com o serviço de gestão de modelos.

name

Devolva o nome da área de trabalho.

Devoluções

O nome da área de trabalho.

Tipo de retorno

str

private_endpoints

Listar todos os pontos finais privados da área de trabalho.

Devoluções

Um ditado de objetos PrivateEndPoint associados à área de trabalho. A chave é nome de ponto final privado.

Tipo de retorno

resource_group

Devolva o nome do grupo de recursos para esta área de trabalho.

Devoluções

O nome do grupo de recursos.

Tipo de retorno

str

service_context

Devolva o contexto de serviço para esta área de trabalho.

Devoluções

Devolve o objeto ServiceContext.

Tipo de retorno

<xref:azureml._restclient.service_context.ServiceContext>

sku

Devolva o SKU desta área de trabalho.

Devoluções

O SKU desta área de trabalho.

Tipo de retorno

str

subscription_id

Devolva o ID da subscrição para esta área de trabalho.

Devoluções

O ID da subscrição.

Tipo de retorno

str

tags

Devolva as Etiquetas desta área de trabalho.

Devoluções

As Etiquetas desta área de trabalho.

Tipo de retorno

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

Uma lista de webservices na área de trabalho.

Tipo de retorno

Exceções

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'