Workspace Classe
Define um recurso do Azure Machine Learning para gerenciar artefatos de treinamento e implantação.
Um Espaço de Trabalho é um recurso fundamental para o aprendizado de máquina no Azure Machine Learning. Você usa um espaço de trabalho para experimentar, treinar e implantar modelos de aprendizado de máquina. Cada espaço de trabalho está vinculado a uma assinatura do Azure e a um grupo de recursos e tem uma SKU associada.
Para obter mais informações sobre espaços de trabalho, consulte:
Construtor de Espaço de Trabalho de Classe para carregar um Espaço de Trabalho de Aprendizado de Máquina do Azure existente.
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
|
A ID de assinatura do Azure que contém o espaço de trabalho. |
|
resource_group
Necessário
|
O grupo de recursos que contém o espaço de trabalho. |
|
workspace_name
Necessário
|
O nome do espaço de trabalho existente. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se Nenhum, as credenciais padrão da CLI do Azure serão usadas ou a API solicitará credenciais. Default value: None
|
|
_location
|
Apenas para uso interno. Default value: None
|
|
_disable_service_check
|
Apenas para uso interno. Default value: False
|
|
_workspace_id
|
Apenas para uso interno. Default value: None
|
|
sku
|
O parâmetro está presente para compatibilidade com versões anteriores e é ignorado. Default value: basic
|
|
_cloud
|
Apenas para uso interno. Default value: AzureCloud
|
|
subscription_id
Necessário
|
A ID de assinatura do Azure que contém o espaço de trabalho. |
|
resource_group
Necessário
|
O grupo de recursos que contém o espaço de trabalho. |
|
workspace_name
Necessário
|
O nome do espaço de trabalho. O nome tem de ter entre 2 e 32 carateres. O primeiro caractere do nome deve ser alfanumérico (letra ou número), mas o resto do nome pode conter alfanuméricos, hífenes e sublinhados. 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 Nenhum, as credenciais padrão da CLI do Azure serão usadas ou a API solicitará credenciais. |
|
_location
Necessário
|
Apenas para uso interno. |
|
_disable_service_check
Necessário
|
Apenas para uso interno. |
|
_workspace_id
Necessário
|
Apenas para uso interno. |
|
sku
Necessário
|
O parâmetro está presente para compatibilidade com versões anteriores e é ignorado. |
|
tags
|
Tags para associar ao espaço de trabalho. Default value: None
|
|
_cloud
Necessário
|
Apenas para uso interno. |
Observações
O exemplo a seguir mostra como criar um espaço 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 você tiver um grupo de recursos do Azure existente que deseja usar para o espaço de trabalho.
Para usar o mesmo espaço de trabalho em vários ambientes, crie um arquivo de configuração JSON. O arquivo de configuração salva sua assinatura, recurso e nome do espaço de trabalho para que possa ser facilmente carregado. Para salvar a configuração, use o write_config método.
ws.write_config(path="./file-path", file_name="ws_config.json")
Consulte Criar um arquivo de configuração de espaço de trabalho para obter um exemplo do arquivo de configuração.
Para carregar o espaço de trabalho a partir do arquivo de configuração, use o from_config método.
ws = Workspace.from_config()
ws.get_details()
Como alternativa, use o get método para carregar um espaço de trabalho existente sem usar arquivos de configuração.
ws = Workspace.get(name="myworkspace",
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup')
Os exemplos acima podem solicitar credenciais de autenticação do Azure usando uma caixa de diálogo de logon interativa. Para outros casos de uso, incluindo o uso da CLI do Azure para autenticação e autenticação em fluxos de trabalho automatizados, consulte Autenticação no Aprendizado de Máquina do Azure.
Métodos
| add_private_endpoint |
Adicione um ponto de extremidade privado ao espaço de trabalho. |
| create |
Crie um novo Espaço de Trabalho do Azure Machine Learning. Lança uma exceção se o espaço de trabalho já existir ou se qualquer um dos requisitos do espaço de trabalho não for satisfeito. |
| delete |
Exclua os recursos associados ao Espaço de Trabalho do Azure Machine Learning. |
| delete_connection |
Exclua uma conexão do espaço de trabalho. |
| delete_private_endpoint_connection |
Exclua a conexão de ponto de extremidade privado para o espaço de trabalho. |
| diagnose_workspace |
Diagnostique problemas de configuração do espaço de trabalho. |
| from_config |
Retornar um objeto de espaço de trabalho de um Espaço de Trabalho de Aprendizado de Máquina do Azure existente. Lê a configuração do espaço de trabalho de um arquivo. Lança uma exceção se o arquivo de configuração não puder ser encontrado. O método fornece uma maneira simples de reutilizar o mesmo espaço de trabalho em vários notebooks ou projetos Python. Os usuários podem salvar as propriedades do Azure Resource Manager (ARM) do espaço de trabalho usando o write_config método e usar esse método para carregar o mesmo espaço de trabalho em diferentes blocos de anotações ou projetos Python sem digitar novamente as propriedades ARM do espaço de trabalho. |
| get |
Retornar um objeto de espaço de trabalho para um Espaço de Trabalho do Azure Machine Learning existente. Lança uma exceção se o espaço de trabalho não existir ou se os campos obrigatórios não identificarem exclusivamente um espaço de trabalho. |
| get_connection |
Obtenha uma conexão do espaço de trabalho. |
| get_default_compute_target |
Obtenha o destino de computação padrão para o espaço de trabalho. |
| get_default_datastore |
Obtenha o armazenamento de dados padrão para o espaço de trabalho. |
| get_default_keyvault |
Obtenha o objeto de cofre de chave padrão para o espaço de trabalho. |
| get_details |
Retornar os detalhes do espaço de trabalho. |
| get_mlflow_tracking_uri |
Obtenha o URI de acompanhamento MLflow para o espaço de trabalho. MLflow (https://mlflow.org/) é uma plataforma de código aberto para rastrear experimentos de aprendizado de máquina e gerenciar modelos. Você pode usar APIs de log de MLflow com o Azure Machine Learning para que métricas, modelos e artefatos sejam registrados em seu espaço de trabalho do Azure Machine Learning. |
| get_run |
Retorne a execução com o run_id especificado no espaço de trabalho. |
| list |
Liste todos os espaços de trabalho aos quais o usuário tem acesso dentro da assinatura. A lista de espaços de trabalho pode ser filtrada com base no grupo de recursos. |
| list_connections |
Liste conexões neste espaço de trabalho. |
| list_keys |
Listar chaves para o espaço de trabalho atual. |
| set_connection |
Adicione ou atualize uma conexão no espaço de trabalho. |
| set_default_datastore |
Defina o armazenamento de dados padrão para o espaço de trabalho. |
| setup |
Crie um novo espaço de trabalho ou recupere um espaço de trabalho existente. |
| sync_keys |
Aciona o espaço de trabalho para sincronizar imediatamente as chaves. Se as chaves de qualquer recurso no espaço de trabalho forem alteradas, pode levar cerca de uma hora para que elas sejam atualizadas automaticamente. Esta função permite que as teclas sejam atualizadas mediante solicitação. Um cenário de exemplo é a necessidade de acesso imediato ao armazenamento após a regeneração das chaves de armazenamento. |
| update |
Atualize o nome amigável, a descrição, as tags, a computação de construção de imagem e outras configurações associadas a um espaço de trabalho. |
| update_dependencies |
Atualize os recursos associados existentes para o espaço de trabalho nos seguintes casos. a) Quando um usuário exclui acidentalmente um recurso associado existente e gostaria de atualizá-lo com um novo sem ter que recriar todo o espaço de trabalho. b) Quando um usuário tem um recurso associado existente e deseja substituir o atual que está associado ao espaço de trabalho. c) Quando um recurso associado ainda não foi criado e eles querem usar um existente que já têm (só se aplica ao registro de contêiner). |
| write_config |
Escreva as propriedades do Azure Resource Manager (ARM) do espaço de trabalho em um arquivo de configuração. As propriedades ARM do espaço de trabalho podem ser carregadas posteriormente usando o from_config método. O O método fornece uma maneira simples de reutilizar o mesmo espaço de trabalho em vários notebooks ou projetos Python. Os usuários podem salvar as propriedades ARM do espaço de trabalho usando essa função e usar from_config para carregar o mesmo espaço de trabalho em diferentes blocos de anotações ou projetos Python sem digitar novamente as propriedades ARM do espaço de trabalho. |
add_private_endpoint
Adicione um ponto de extremidade privado ao espaço 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 de ponto de extremidade privado para criar um ponto de extremidade privado para espaço de trabalho. |
|
private_endpoint_auto_approval
|
Um sinalizador booleano que indica se a criação do ponto de extremidade privado deve ser aprovada automaticamente ou manualmente no Centro de Link Privado do Azure. Em caso de aprovação manual, os usuários podem visualizar a solicitação pendente no portal Private Link para aprovar/rejeitar a solicitação. Default value: True
|
|
location
|
Local do ponto de extremidade privado, o padrão é o local do espaço de trabalho Default value: None
|
|
show_output
|
Sinalizador para mostrar o progresso da criação do espaço de trabalho Default value: True
|
|
tags
|
Tags para associar ao espaço de trabalho. Default value: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto PrivateEndPoint criado. |
create
Crie um novo Espaço de Trabalho do Azure Machine Learning.
Lança uma exceção se o espaço de trabalho já existir ou se qualquer um dos requisitos do espaço de trabalho não for 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 do espaço de trabalho. O nome tem de ter entre 2 e 32 carateres. O primeiro caractere do nome deve ser alfanumérico (letra ou número), mas o resto do nome pode conter alfanuméricos, hífenes e sublinhados. 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 Nenhum, as credenciais padrão da CLI do Azure serão usadas ou a API solicitará credenciais. Default value: None
|
|
subscription_id
|
A ID de assinatura da assinatura que contém o novo espaço de trabalho. O parâmetro é necessário se o usuário tiver acesso a mais de uma assinatura. Default value: None
|
|
resource_group
|
O grupo de recursos do Azure que contém o espaço de trabalho. O parâmetro assume como padrão uma mutação do nome do espaço de trabalho. Default value: None
|
|
location
|
A localização do espaço de trabalho. O parâmetro assume como padrão o local do grupo de recursos. O local deve ser uma região com suporte para o Azure Machine Learning. Default value: None
|
|
create_resource_group
|
Indica se o grupo de recursos deve ser criado, caso ele não exista. Default value: True
|
|
sku
|
O parâmetro está presente para compatibilidade com versões anteriores e é ignorado. Default value: basic
|
|
tags
|
Tags para associar ao espaço de trabalho. Default value: None
|
|
friendly_name
|
Um nome amigável opcional para o espaço de trabalho que pode ser exibido na interface do usuário. Default value: None
|
|
storage_account
|
Uma conta de armazenamento existente no formato de ID de recurso do Azure. O armazenamento será usado pelo espaço de trabalho para salvar saídas de execução, código, logs, etc. Se Nenhum, uma nova conta de armazenamento será criada. Default value: None
|
|
key_vault
|
Um cofre de chaves existente no formato de ID de recurso do Azure. Consulte o código de exemplo abaixo para obter detalhes do formato de ID de recurso do Azure. O cofre de chaves será usado pelo espaço de trabalho para armazenar credenciais adicionadas ao espaço de trabalho pelos usuários. Se Nenhum, um novo cofre de chaves será criado. Default value: None
|
|
app_insights
|
Um Application Insights existente no formato de ID de recurso do Azure. Consulte o código de exemplo abaixo para obter detalhes do formato de ID de recurso do Azure. O Application Insights será usado pelo espaço de trabalho para registrar eventos de webservices. Se Nenhum, um novo Application Insights será criado. Default value: None
|
|
container_registry
|
Um registro de contêiner existente no formato de ID de recurso do Azure (consulte o código de exemplo abaixo para obter detalhes do formato de ID de recurso do Azure). O registro de contêiner será usado pelo espaço de trabalho para extrair e enviar por push imagens de experimentação e webservices. Se Nenhum, um novo registro de contêiner será criado somente quando necessário e não junto com a criação do espaço de trabalho. Default value: None
|
|
adb_workspace
|
Um Espaço de Trabalho Adb existente no formato de ID de recurso do Azure (consulte o código de exemplo abaixo para obter detalhes do formato de ID de recurso do Azure). O espaço de trabalho do Adb será usado para vincular ao espaço de trabalho. Se Nenhum, o link do espaço de trabalho não acontecerá. Default value: None
|
|
primary_user_assigned_identity
|
A id de recurso da identidade atribuída ao usuário usada para representar o espaço de trabalho Default value: None
|
|
cmk_keyvault
|
O cofre de chaves que contém a chave gerenciada pelo cliente no formato de ID de recurso do Azure:
Default value: None
|
|
resource_cmk_uri
|
O URI de chave da chave gerenciada pelo cliente para criptografar os dados em repouso.
O formato URI é: Default value: None
|
|
hbi_workspace
|
Especifica se o espaço de trabalho contém dados de Alto Impacto nos Negócios (HBI), ou seja, contém informações comerciais confidenciais. Esse sinalizador pode ser definido somente durante a criação do espaço de trabalho. Seu valor não pode ser alterado após a criação do espaço de trabalho. O valor padrão é False. Quando definido como True, outras etapas de criptografia são executadas e, dependendo do componente SDK, resultam em informações editadas na telemetria coletada internamente. Para obter mais informações, consulte Criptografia de dados. Quando esse sinalizador é definido como True, um impacto possível é o aumento da dificuldade em solucionar problemas. Isso pode acontecer porque alguma telemetria não é enviada para a Microsoft e há menos visibilidade sobre taxas de sucesso ou tipos de problemas e, portanto, pode não ser capaz de reagir de forma tão proativa quando esse sinalizador é True. A recomendação é usar o padrão de False para este sinalizador, a menos que seja estritamente necessário para ser True. Default value: False
|
|
default_cpu_compute_target
|
(PRETERIDO) Uma configuração que será usada para criar uma computação de CPU. O parâmetro assume como padrão {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Se Nenhum, nenhum cálculo será criado. Default value: None
|
|
default_gpu_compute_target
|
(PRETERIDO) Uma configuração que será usada para criar uma computação de GPU. O parâmetro assume como padrão {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Se Nenhum, nenhum cálculo será criado. Default value: None
|
|
private_endpoint_config
|
A configuração de ponto de extremidade privado para criar um ponto de extremidade privado para o espaço de trabalho do Azure ML. Default value: None
|
|
private_endpoint_auto_approval
|
Um sinalizador booleano que indica se a criação do ponto de extremidade privado deve ser aprovada automaticamente ou manualmente no Centro de Link Privado do Azure. Em caso de aprovação manual, os usuários podem visualizar a solicitação pendente no portal Private Link para aprovar/rejeitar a solicitação. Default value: True
|
|
exist_ok
|
Indica se esse método terá êxito se o espaço de trabalho já existir. Se False, esse método falhará se o espaço de trabalho existir. Se True, esse método retorna o espaço de trabalho existente, se ele existir. Default value: False
|
|
show_output
|
Indica se esse método imprimirá o progresso incremental. Default value: True
|
|
user_assigned_identity_for_cmk_encryption
|
A ID de recurso da identidade atribuída ao usuário que precisa ser usada para acessar a chave de gerenciamento do cliente Default value: None
|
|
system_datastores_auth_mode
|
Determina se as credenciais devem ou não ser usadas para os armazenamentos de dados do sistema do espaço de trabalho 'workspaceblobstore' e 'workspacefilestore'. O valor padrão é 'accessKey', nesse caso, o espaço de trabalho criará os armazenamentos de dados do sistema com credenciais. Se definido como 'identidade', o espaço de trabalho criará os armazenamentos de dados do sistema sem credenciais. Default value: accessKey
|
|
v1_legacy_mode
|
Impedir o uso do serviço de API v2 no Azure Resource Manager público Default value: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto de espaço de trabalho. |
Exceções
| Tipo | Description |
|---|---|
|
Gerado por problemas na criação do espaço 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 a seguir mostra como reutilizar recursos existentes do Azure utilizando o formato de ID de recurso do Azure. As IDs de recursos específicas do Azure podem ser recuperadas por meio do Portal do Azure ou SDK. Isso pressupõe que o grupo de recursos, a conta de armazenamento, o cofre de chaves, o App Insights e o registro de contêiner já existam.
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
Exclua os recursos associados ao Espaço de Trabalho do Azure Machine Learning.
delete(delete_dependent_resources=False, no_wait=False)Parâmetros
| Name | Description |
|---|---|
|
delete_dependent_resources
|
Se deseja excluir recursos associados ao espaço de trabalho, ou seja, registro de contêiner, conta de armazenamento, cofre de chaves e insights de aplicativos. O padrão é False. Defina como True para excluir esses recursos. Default value: False
|
|
no_wait
|
Se deve aguardar a conclusão da exclusão do espaço de trabalho. Default value: False
|
Devoluções
| Tipo | Description |
|---|---|
|
Nenhum se for bem-sucedido; caso contrário, lança um erro. |
delete_connection
Exclua uma conexão do espaço de trabalho.
delete_connection(name)Parâmetros
| Name | Description |
|---|---|
|
name
Necessário
|
O nome exclusivo da conexão sob o espaço de trabalho |
delete_private_endpoint_connection
Exclua a conexão de ponto de extremidade privado para o espaço de trabalho.
delete_private_endpoint_connection(private_endpoint_connection_name)Parâmetros
| Name | Description |
|---|---|
|
private_endpoint_connection_name
Necessário
|
O nome exclusivo da conexão de ponto de extremidade privado no espaço de trabalho |
diagnose_workspace
Diagnostique problemas de configuração do espaço de trabalho.
diagnose_workspace(diagnose_parameters)Parâmetros
| Name | Description |
|---|---|
|
diagnose_parameters
Necessário
|
<xref:_restclient.models.DiagnoseWorkspaceParameters>
O parâmetro de diagnóstico da integridade do espaço de trabalho |
Devoluções
| Tipo | Description |
|---|---|
|
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]
|
Uma instância do AzureOperationPoller que retorna DiagnoseResponseResult |
from_config
Retornar um objeto de espaço de trabalho de um Espaço de Trabalho de Aprendizado de Máquina do Azure existente.
Lê a configuração do espaço de trabalho de um arquivo. Lança uma exceção se o arquivo de configuração não puder ser encontrado.
O método fornece uma maneira simples de reutilizar o mesmo espaço de trabalho em vários notebooks ou projetos Python. Os usuários podem salvar as propriedades do Azure Resource Manager (ARM) do espaço de trabalho usando o write_config método e usar esse método para carregar o mesmo espaço de trabalho em diferentes blocos de anotações ou projetos Python sem digitar novamente as propriedades ARM do espaço de trabalho.
static from_config(path=None, auth=None, _logger=None, _file_name=None)Parâmetros
| Name | Description |
|---|---|
|
path
|
O caminho para o arquivo de configuração ou diretório inicial para pesquisar. O parâmetro assume como padrão iniciar a pesquisa no diretório atual. Default value: None
|
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se Nenhum, as credenciais padrão da CLI do Azure serão usadas ou a API solicitará credenciais. Default value: None
|
|
_logger
|
Permite substituir o registrador padrão. Default value: None
|
|
_file_name
|
Permite substituir o nome do arquivo de configuração para procurar quando o caminho é um caminho de diretório. Default value: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto de espaço de trabalho para um Espaço de Trabalho do Azure ML existente. |
get
Retornar um objeto de espaço de trabalho para um Espaço de Trabalho do Azure Machine Learning existente.
Lança uma exceção se o espaço de trabalho não existir ou se os campos obrigatórios não identificarem exclusivamente um espaço 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 do espaço de trabalho a ser obtido. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, https://aka.ms/aml-notebook-authconsulte . Se Nenhum, as credenciais padrão da CLI do Azure serão usadas ou a API solicitará credenciais. Default value: None
|
|
subscription_id
|
O ID da subscrição a utilizar. O parâmetro é necessário se o usuário tiver acesso a mais de uma assinatura. Default value: None
|
|
resource_group
|
O grupo de recursos a ser usado. Se Nenhum, o método pesquisará todos os grupos de recursos na assinatura. Default value: None
|
|
location
|
O local do espaço de trabalho. Default value: None
|
|
cloud
|
O nome da nuvem de destino. Pode ser um dos "AzureCloud", "AzureChinaCloud" ou "AzureUSGovernment". Se nenhuma nuvem for especificada, "AzureCloud" será usado. Default value: AzureCloud
|
|
id
|
A id do espaço de trabalho. Default value: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto de espaço de trabalho. |
get_connection
Obtenha uma conexão do espaço de trabalho.
get_connection(name)Parâmetros
| Name | Description |
|---|---|
|
name
Necessário
|
O nome exclusivo da conexão sob o espaço de trabalho |
get_default_compute_target
Obtenha o destino de computação padrão para o espaço 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 padrão para determinado tipo de computação. |
get_default_datastore
Obtenha o armazenamento de dados padrão para o espaço de trabalho.
get_default_datastore()Devoluções
| Tipo | Description |
|---|---|
|
O armazenamento de dados padrão. |
get_default_keyvault
Obtenha o objeto de cofre de chave padrão para o espaço de trabalho.
get_default_keyvault()Devoluções
| Tipo | Description |
|---|---|
|
O objeto KeyVault associado ao espaço de trabalho. |
get_details
Retornar os detalhes do espaço de trabalho.
get_details()Devoluções
| Tipo | Description |
|---|---|
|
Detalhes do espaço de trabalho em formato de dicionário. |
Observações
O dicionário retornado contém os seguintes pares chave-valor.
id: URI apontando para este recurso de espaço de trabalho, contendo ID de assinatura, grupo de recursos e nome do espaço de trabalho.
name: O nome deste espaço de trabalho.
local: A região do espaço de trabalho.
type: Um URI do formato "{providerName}/workspaces".
tags: Não usado atualmente.
workspaceid: A ID deste espaço de trabalho.
descrição: Não usado atualmente.
friendlyName: um nome amigável para o espaço de trabalho exibido na interface do usuário.
creationTime: Hora em que este espaço de trabalho foi criado, em formato ISO8601.
containerRegistry: O registro de contêiner de espaço de trabalho usado para extrair e enviar por push imagens de experimentação e serviços Web.
keyVault: O cofre de chaves do espaço de trabalho usado para armazenar credenciais adicionadas ao espaço de trabalho pelos usuários.
applicationInsights: O Application Insights será usado pelo espaço de trabalho para registrar eventos de webservices.
identityPrincipalId:
identityTenantId
identityType
storageAccount: O armazenamento será usado pelo espaço de trabalho para salvar saídas de execução, código, logs, etc.
sku: O espaço de trabalho SKU (também conhecido como edição). O parâmetro está presente para compatibilidade com versões anteriores e é ignorado.
resourceCmkUri: O URI de chave da chave gerenciada pelo cliente para criptografar os dados em repouso. Consulte as https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 etapas sobre como criar uma chave e obter seu URI.
hbiWorkspace: Especifica se os dados do cliente são de alto impacto nos negócios.
imageBuildCompute: O destino de computação para a compilação de imagens.
systemDatastoresAuthMode: Determina se as credenciais devem ou não ser usadas para os armazenamentos de dados do sistema do espaço de trabalho 'workspaceblobstore' e 'workspacefilestore'. O valor padrão é 'accessKey', nesse caso, o espaço de trabalho criará os armazenamentos de dados do sistema com credenciais. Se definido como 'identidade', o espaço de trabalho criará os armazenamentos de dados do sistema sem credenciais.
Para obter mais informações sobre esses pares chave-valor, consulte create.
get_mlflow_tracking_uri
Obtenha o URI de acompanhamento MLflow para o espaço de trabalho.
MLflow (https://mlflow.org/) é uma plataforma de código aberto para rastrear experimentos de aprendizado de máquina e gerenciar modelos. Você pode usar APIs de log de MLflow com o Azure Machine Learning para que métricas, modelos e artefatos sejam registrados em seu espaço 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 ao URI de rastreamento. Default value: False
|
Devoluções
| Tipo | Description |
|---|---|
|
O URI de rastreamento compatível com MLflow. |
Observações
Use o exemplo a seguir para configurar o controle de fluxo de MLpara enviar dados para o Espaço de Trabalho de ML do Azure:
import mlflow
from azureml.core import Workspace
workspace = Workspace.from_config()
mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())
get_run
list
Liste todos os espaços de trabalho aos quais o usuário tem acesso dentro da assinatura.
A lista de espaços 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
|
A ID da assinatura para a qual listar espaços de trabalho. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, https://aka.ms/aml-notebook-authconsulte . Se Nenhum, as credenciais padrão da CLI do Azure serão usadas ou a API solicitará credenciais. Default value: None
|
|
resource_group
|
Um grupo de recursos para filtrar os espaços de trabalho retornados. Se Nenhum, o método listará todos os espaços de trabalho dentro da assinatura especificada. Default value: None
|
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário onde a chave é o nome do espaço de trabalho e o valor é uma lista de objetos Workspace. |
list_connections
list_keys
set_connection
Adicione ou atualize uma conexão no espaço de trabalho.
set_connection(name, category, target, authType, value)Parâmetros
| Name | Description |
|---|---|
|
name
Necessário
|
O nome exclusivo da conexão sob o espaço de trabalho |
|
category
Necessário
|
A categoria desta ligação |
|
target
Necessário
|
o destino ao qual essa conexão se conecta |
|
authType
Necessário
|
O tipo de autorização desta conexão |
|
value
Necessário
|
A cadeia de caracteres de serialização do formato JSON dos detalhes da conexão |
set_default_datastore
setup
Crie um novo espaço de trabalho ou recupere um espaço de trabalho existente.
static setup()Devoluções
| Tipo | Description |
|---|---|
|
Um objeto Workspace. |
sync_keys
Aciona o espaço de trabalho para sincronizar imediatamente as chaves.
Se as chaves de qualquer recurso no espaço de trabalho forem alteradas, pode levar cerca de uma hora para que elas sejam atualizadas automaticamente. Esta função permite que as teclas sejam atualizadas mediante solicitação. Um cenário de exemplo é a necessidade de acesso imediato ao armazenamento após a regeneração das chaves de armazenamento.
sync_keys(no_wait=False)Parâmetros
| Name | Description |
|---|---|
|
no_wait
|
Se deve aguardar a conclusão das chaves de sincronização do espaço de trabalho. Default value: False
|
Devoluções
| Tipo | Description |
|---|---|
|
Nenhum se for bem-sucedido; caso contrário, lança um erro. |
update
Atualize o nome amigável, a descrição, as tags, a computação de construção de imagem e outras configurações associadas a um espaço 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 o espaço de trabalho que pode ser exibido na interface do usuário. Default value: None
|
|
description
|
Uma descrição do espaço de trabalho. Default value: None
|
|
tags
|
Tags para associar ao espaço de trabalho. Default value: None
|
|
image_build_compute
|
O nome de computação para a compilação de imagem. Default value: None
|
|
service_managed_resources_settings
|
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
As configurações de recursos gerenciados pelo serviço. Default value: None
|
|
primary_user_assigned_identity
|
A ID do recurso de identidade atribuída ao usuário que representa a identidade do espaço de trabalho. Default value: None
|
|
allow_public_access_when_behind_vnet
|
Permitir acesso público ao espaço de trabalho de link privado. Default value: None
|
|
v1_legacy_mode
|
Impedir o uso do serviço de API v2 no Azure Resource Manager público Default value: None
|
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário de informações atualizadas. |
update_dependencies
Atualize os recursos associados existentes para o espaço de trabalho nos seguintes casos.
a) Quando um usuário exclui acidentalmente um recurso associado existente e gostaria de atualizá-lo com um novo sem ter que recriar todo o espaço de trabalho. b) Quando um usuário tem um recurso associado existente e deseja substituir o atual que está associado ao espaço de trabalho. c) Quando um recurso associado ainda não foi criado e eles querem usar um existente que já têm (só se aplica ao registro de contêiner).
update_dependencies(container_registry=None, force=False)Parâmetros
| Name | Description |
|---|---|
|
container_registry
|
ID ARM para o registro de contêiner. Default value: None
|
|
force
|
Se forçar a atualização de recursos dependentes sem confirmação solicitada. Default value: False
|
Devoluções
| Tipo | Description |
|---|---|
write_config
Escreva as propriedades do Azure Resource Manager (ARM) do espaço de trabalho em um arquivo de configuração.
As propriedades ARM do espaço de trabalho podem ser carregadas posteriormente usando o from_config método. O path padrão é '.azureml/' no diretório de trabalho atual e file_name o padrão é 'config.json'.
O método fornece uma maneira simples de reutilizar o mesmo espaço de trabalho em vários notebooks ou projetos Python. Os usuários podem salvar as propriedades ARM do espaço de trabalho usando essa função e usar from_config para carregar o mesmo espaço de trabalho em diferentes blocos de anotações ou projetos Python sem digitar novamente as propriedades ARM do espaço de trabalho.
write_config(path=None, file_name=None)Parâmetros
| Name | Description |
|---|---|
|
path
|
O usuário forneceu o local para gravar o arquivo config.json. O parâmetro assume como padrão '.azureml/' no diretório de trabalho atual. Default value: None
|
|
file_name
|
Nome a ser usado para o arquivo de configuração. O parâmetro assume como padrão config.json. Default value: None
|
Atributos
compute_targets
Liste todos os destinos de computação no espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome de destino de computação e valor como ComputeTarget objeto. |
datasets
datastores
discovery_url
Retornar a URL de descoberta deste espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
A URL de descoberta deste espaço de trabalho. |
environments
Liste todos os ambientes no espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome do ambiente e valor como Environment objeto. |
experiments
Liste todos os experimentos no espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome do experimento e valor como Experiment objeto. |
images
Retornar a lista de imagens no espaço de trabalho.
Levanta um WebserviceException problema se houve um problema interagindo com o serviço de gerenciamento de modelo.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome da imagem e valor como Image objeto. |
Exceções
| Tipo | Description |
|---|---|
|
Houve um problema ao interagir com o serviço de gerenciamento de modelos. |
linked_services
Liste todos os serviços vinculados no espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário onde chave é um nome de serviço vinculado e valor é um LinkedService objeto. |
location
Retornar o local deste espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
A localização deste espaço de trabalho. |
models
Retornar uma lista de modelo no espaço de trabalho.
Levanta um WebserviceException problema se houve um problema interagindo com o serviço de gerenciamento de modelo.
Devoluções
| Tipo | Description |
|---|---|
|
Um dicionário de modelo com chave como nome do modelo e valor como Model objeto. |
Exceções
| Tipo | Description |
|---|---|
|
Houve um problema ao interagir com o serviço de gerenciamento de modelos. |
name
private_endpoints
Liste todos os pontos de extremidade privados do espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
Um ditado de objetos PrivateEndPoint associados ao espaço de trabalho. A chave é o nome do ponto de extremidade privado. |
resource_group
Retornar o nome do grupo de recursos para este espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
O nome do grupo de recursos. |
service_context
Retornar o contexto de serviço para este espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
<xref:azureml._restclient.service_context.ServiceContext>
|
Retorna o objeto ServiceContext. |
sku
Retornar a SKU deste espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
O SKU deste espaço de trabalho. |
subscription_id
Devolver o ID de subscrição para esta área de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
O ID da subscrição. |
tags
Retorne as tags deste espaço de trabalho.
Devoluções
| Tipo | Description |
|---|---|
|
As Tags deste espaço de trabalho. |
webservices
Retornar uma lista de serviços Web no espaço de trabalho.
Levanta um WebserviceException se houve um problema ao retornar a lista.
Devoluções
| Tipo | Description |
|---|---|
|
Uma lista de serviços Web no espaço de trabalho. |
Exceções
| Tipo | Description |
|---|---|
|
Houve 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'