Workspace Classe
Define um recurso do Azure Machine Learning para gerenciar artefatos de treinamento e implantação.
Um workspace é um recurso fundamental para machine learning no Azure Machine Learning. Use um workspace para experimentar, treinar e implantar modelos de machine learning. Cada workspace está vinculado a uma assinatura e um grupo de recursos do Azure e tem um SKU associado.
Para obter mais informações sobre workspaces, confira:
Construtor de workspace de classe para carregar um workspace existente do Azure Machine Learning.
- 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
| Nome | Description |
|---|---|
|
subscription_id
Obrigatório
|
A ID da assinatura do Azure que contém o workspace. |
|
resource_group
Obrigatório
|
O grupo de recursos que contém o workspace. |
|
workspace_name
Obrigatório
|
O nome do workspace existente. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se for None, serão usadas as credenciais padrão da CLI do Azure ou a API solicitará credenciais. Valor padrão: None
|
|
_location
|
Apenas para uso interno. Valor padrão: None
|
|
_disable_service_check
|
Apenas para uso interno. Valor padrão: False
|
|
_workspace_id
|
Apenas para uso interno. Valor padrão: None
|
|
sku
|
O parâmetro está presente para compatibilidade com versões anteriores e é ignorado. Valor padrão: basic
|
|
_cloud
|
Somente para uso interno. Valor padrão: AzureCloud
|
|
subscription_id
Obrigatório
|
A ID da assinatura do Azure que contém o workspace. |
|
resource_group
Obrigatório
|
O grupo de recursos que contém o workspace. |
|
workspace_name
Obrigatório
|
O nome do workspace. O nome deve ter entre 2 e 32 caracteres. O primeiro caractere do nome deve ser alfanumérico (letra ou número), mas o restante do nome pode conter alfanuméricos, hifens e sublinhados. Não é permitido espaço em branco. |
|
auth
Obrigatório
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se for None, serão usadas as credenciais padrão da CLI do Azure ou a API solicitará credenciais. |
|
_location
Obrigatório
|
Apenas para uso interno. |
|
_disable_service_check
Obrigatório
|
Apenas para uso interno. |
|
_workspace_id
Obrigatório
|
Apenas para uso interno. |
|
sku
Obrigatório
|
O parâmetro está presente para compatibilidade com versões anteriores e é ignorado. |
|
tags
|
Marcas para associar ao workspace. Valor padrão: None
|
|
_cloud
Obrigatório
|
Somente para uso interno. |
Comentários
A amostra a seguir mostra como criar um workspace.
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 False se você tiver um grupo de recursos do Azure já existente que você deseja para o workspace.
Para usar o mesmo workspace em vários ambientes, crie um arquivo de configuração JSON. O arquivo de configuração salva a assinatura, o recurso e o nome do workspace para que ele possa ser facilmente carregado. Para salvar a configuração, use o método write_config.
ws.write_config(path="./file-path", file_name="ws_config.json")
Consulte Criar um arquivo de configuração de workspace para obter um exemplo do arquivo de configuração.
Para carregar o workspace do arquivo de configuração, use o método from_config.
ws = Workspace.from_config()
ws.get_details()
Como alternativa, use o método get para carregar um workspace existente sem usar arquivos de configuração.
ws = Workspace.get(name="myworkspace",
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup')
As amostras acima podem solicitar as credenciais de autenticação do Azure usando uma caixa de diálogo de logon interativo. Para outros casos de uso, incluindo o uso da CLI do Azure para autenticar e da autenticação em fluxos de trabalho automatizados, consulte Autenticação no Azure Machine Learning.
Métodos
| add_private_endpoint |
Adicionar um ponto de extremidade privado a um workspace. |
| create |
Criar um novo Workspace do Azure Machine Learning. Gera uma exceção se o workspace já existe ou nenhum dos requisitos do workspace não é atendido. |
| delete |
Excluir os recursos associados ao Workspace do Azure Machine Learning. |
| delete_connection |
Excluir uma conexão do workspace. |
| delete_private_endpoint_connection |
Excluir a conexão do ponto de extremidade privado com o workspace. |
| diagnose_workspace |
Diagnosticar problemas de instalação do workspace. |
| from_config |
Retornar um objeto de workspace de um Workspace do Azure Machine Learning existente. Lê a configuração do workspace de um arquivo. Gera uma exceção caso o arquivo de configuração não seja encontrado. O método fornece uma maneira simples de reutilizar o mesmo workspace em vários notebooks ou projetos do Python. Os usuários podem salvar as propriedades do ARM (Azure Resource Manager) do workspace usando o método write_config e usar esse método para carregar o mesmo workspace em diferentes notebooks ou projetos do Python sem digitar novamente as propriedades do ARM do workspace. |
| get |
Retornar um objeto de workspace de um Workspace do Azure Machine Learning existente. Gera uma exceção caso o workspace não exista ou os campos obrigatórios não identifiquem exclusivamente um workspace. |
| get_connection |
Obter uma conexão do workspace. |
| get_default_compute_target |
Obter o destino de computação padrão para o workspace. |
| get_default_datastore |
Obter o armazenamento de dados padrão para o workspace. |
| get_default_keyvault |
Obter o objeto do cofre de chaves padrão para o workspace. |
| get_details |
Retornar os detalhes do workspace. |
| get_mlflow_tracking_uri |
Obter o URI de acompanhamento de MLflow para o workspace. O MLflow (https://mlflow.org/) é uma plataforma de código aberto para rastrear experimentos de machine learning e gerenciar modelos. Você pode usar as APIs de registro em log do MLflow com o Azure Machine Learning para que as métricas, os modelos e os artefatos sejam registrados em seu workspace do Azure Machine Learning. |
| get_run |
Retornar a execução com o run_id especificado no workspace. |
| list |
Listar todos os workspaces aos quais o usuário tem acesso na assinatura. A lista de workspaces pode ser filtrada de acordo com o grupo de recursos. |
| list_connections |
Listar conexões neste workspace. |
| list_keys |
Listar chaves do workspace atual. |
| set_connection |
Adicionar ou atualizar uma conexão no workspace. |
| set_default_datastore |
Definir o armazenamento de dados padrão para o workspace. |
| setup |
Criar um novo workspace ou recuperar um existente. |
| sync_keys |
Dispara o workspace para sincronizar as chaves imediatamente. Se as chaves de qualquer recurso no workspace forem alteradas, pode levar cerca de uma hora para que elas sejam atualizadas automaticamente. Essa função permite que as chaves 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 |
Atualizar o nome amigável, a descrição, as marcas, a computação da compilação da imagem e outras configurações associadas a um workspace. |
| update_dependencies |
Atualizar os recursos associados existentes para o workspace nos casos a seguir. a) Quando um usuário exclui acidentalmente um recurso associado existente e gostaria de atualizá-lo com um novo sem precisar recriar o workspace inteiro. b) Quando um usuário tem um recurso associado existente e deseja substituir o atual que está associado ao workspace. c) Quando um recurso associado ainda não foi criado e o usuário precisa usar um existente que já tenha (aplica-se somente ao registro de contêiner). |
| write_config |
Gravar as propriedades do ARM (Azure Resource Manager) do workspace em um arquivo de configuração. As propriedades do ARM de workspace podem ser carregadas mais tarde usando o método from_config. O O método fornece uma maneira simples de reutilizar o mesmo workspace em vários notebooks ou projetos do Python. Os usuários podem salvar as propriedades do ARM do workspace usando esta função e usar from_config para carregar o mesmo workspace em diferentes notebooks ou projetos do Python sem digitar novamente as propriedades do ARM do workspace. |
add_private_endpoint
Adicionar um ponto de extremidade privado a um workspace.
add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)Parâmetros
| Nome | Description |
|---|---|
|
private_endpoint_config
Obrigatório
|
A configuração do ponto de extremidade privado para criar um ponto de extremidade privado para o workspace. |
|
private_endpoint_auto_approval
|
Um sinalizador booliano que indica se a criação do ponto de extremidade privado deve ser aprovada de forma automática ou manual no Centro de Link Privado do Azure. No caso de aprovação manual, os usuários podem exibir a solicitação pendente no portal do Link Privado para aprovar/rejeitar a solicitação. Valor padrão: True
|
|
location
|
Local do ponto de extremidade privado, o padrão é o local do workspace Valor padrão: None
|
|
show_output
|
Sinalizador para mostrar o progresso da criação do workspace Valor padrão: True
|
|
tags
|
Marcas para associar ao workspace. Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto PrivateEndPoint criado. |
create
Criar um novo Workspace do Azure Machine Learning.
Gera uma exceção se o workspace já existe ou nenhum dos requisitos do workspace não é atendido.
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
| Nome | Description |
|---|---|
|
name
Obrigatório
|
O novo nome do workspace. O nome deve ter entre 2 e 32 caracteres. O primeiro caractere do nome deve ser alfanumérico (letra ou número), mas o restante do nome pode conter alfanuméricos, hifens e sublinhados. Não é permitido espaço em branco. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se for None, serão usadas as credenciais padrão da CLI do Azure ou a API solicitará credenciais. Valor padrão: None
|
|
subscription_id
|
A ID da assinatura do novo workspace. O parâmetro será necessário se o usuário tiver acesso a mais de uma assinatura. Valor padrão: None
|
|
resource_group
|
O grupo de recursos do Azure que contém o workspace. O parâmetro segue o padrão para uma mutação do nome do workspace. Valor padrão: None
|
|
location
|
A localização do workspace. O parâmetro segue o padrão para o local do grupo de recursos. O local deve ser uma região compatível do Azure Machine Learning. Valor padrão: None
|
|
create_resource_group
|
Indica se o grupo de recursos deve ser criado caso ele não exista. Valor padrão: True
|
|
sku
|
O parâmetro está presente para compatibilidade com versões anteriores e é ignorado. Valor padrão: basic
|
|
tags
|
Marcas para associar ao workspace. Valor padrão: None
|
|
friendly_name
|
Um nome amigável opcional para o workspace que pode ser exibido na interface do usuário. Valor padrão: None
|
|
storage_account
|
Uma conta de armazenamento existente no formato de ID do recurso do Azure. O armazenamento será usado pelo workspace para salvar saídas de execução, código, logs etc. Se o valor for None, uma nova conta de armazenamento será criada. Valor padrão: None
|
|
key_vault
|
Um cofre de chaves existente no formato da ID do recurso do Azure. Veja o código de exemplo abaixo para obter detalhes sobre o formato da ID do recurso do Azure. O cofre de chaves será usado pelo workspace para armazenar as credenciais adicionadas ao workspace pelos usuários. Se o valor for None, um novo cofre de chaves será criado. Valor padrão: None
|
|
app_insights
|
Um Application Insights existente no formato da ID do recurso do Azure. Veja o código de exemplo abaixo para obter detalhes sobre o formato da ID do recurso do Azure. O Application Insights será usado pelo workspace para registrar eventos de serviços Web. Se o valor for None, um novo Application Insights será criado. Valor padrão: None
|
|
container_registry
|
Um registro de contêiner existente no formato da ID do recurso do Azure (veja o código de exemplo abaixo para obter detalhes sobre o formato da ID do recurso do Azure). O registro de contêiner será usado pelo workspace para efetuar pull e push das imagens de experimentação e dos serviços Web. Se o valor for None, um novo registro de contêiner será criado somente quando necessário e não junto com a criação do workspace. Valor padrão: None
|
|
adb_workspace
|
Um Workspace Adb existente no formato da ID do recurso do Azure (veja o código de exemplo abaixo para obter detalhes sobre o formato da ID do recurso do Azure). O Workspace Adb será usado para vincular com o workspace. Se o valor for None, o link do workspace não ocorrerá. Valor padrão: None
|
|
primary_user_assigned_identity
|
A ID do recurso da identidade atribuída pelo usuário que representava o workspace Valor padrão: None
|
|
cmk_keyvault
|
O cofre de chaves que contém a chave gerenciada pelo cliente no formato da ID do recurso do Azure:
Valor padrão: None
|
|
resource_cmk_uri
|
O URI da chave gerenciada pelo cliente para criptografar dados inativos.
O formato do URI é: Valor padrão: None
|
|
hbi_workspace
|
Especifica se o workspace contém dados de HBI (alto impacto nos negócios), ou seja, contém informações comerciais confidenciais. Este sinalizador só pode ser definido durante a criação do workspace. Seu valor não poderá ser alterado após a criação deste workspace. O valor padrão é False. Quando definido como True, as etapas de criptografia adicionais são executadas e, dependendo do componente do SDK, resultam em informações editadas na telemetria coletada internamente. Para obter mais informações, confira Criptografia de dados. Quando esse sinalizador é definido como True, um possível impacto é a maior dificuldade de solucionar problemas. Isso pode acontecer porque alguma telemetria não é enviada à Microsoft e há menos visibilidade sobre taxas de sucesso ou tipos de problema e, portanto, ela pode não conseguir reagir preventivamente quando esse sinalizador é True. A recomendação é usar o padrão False para esse sinalizador, a menos que seja estritamente necessário usar True. Valor padrão: False
|
|
default_cpu_compute_target
|
(PRETERIDO) Uma configuração que será usada para criar uma computação de CPU. O parâmetro segue o padrão para {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Se o valor for None, nenhuma computação será criada. Valor padrão: None
|
|
default_gpu_compute_target
|
(PRETERIDO) Uma configuração que será usada para criar uma computação de GPU. O parâmetro segue o padrão para {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Se o valor for None, nenhuma computação será criada. Valor padrão: None
|
|
private_endpoint_config
|
A configuração do ponto de extremidade privado para criar um ponto de extremidade privado para o workspace do Azure ML. Valor padrão: None
|
|
private_endpoint_auto_approval
|
Um sinalizador booliano que indica se a criação do ponto de extremidade privado deve ser aprovada de forma automática ou manual no Centro de Link Privado do Azure. No caso de aprovação manual, os usuários podem exibir a solicitação pendente no portal do Link Privado para aprovar/rejeitar a solicitação. Valor padrão: True
|
|
exist_ok
|
Indica se esse método terá sucesso caso o workspace já exista. Caso o valor seja False, esse método falhará se o workspace existir. Caso o valor seja True, esse método retornará o workspace existente se ele existir. Valor padrão: False
|
|
show_output
|
Indica se esse método imprimirá o progresso incremental. Valor padrão: True
|
|
user_assigned_identity_for_cmk_encryption
|
A ID do recurso da identidade atribuída pelo usuário que precisa ser usada para acessar a chave de gerenciamento do cliente Valor padrão: None
|
|
system_datastores_auth_mode
|
Determina se as credenciais devem ser usadas ou não para os armazenamentos de dados do sistema do workspace 'workspaceblobstore' e 'workspacefilestore'. O valor padrão é 'accessKey'; nesse caso, o workspace criará os armazenamentos de dados do sistema com credenciais. Se definido como 'identity', o workspace criará os armazenamentos de dados do sistema sem credenciais. Valor padrão: accessKey
|
|
v1_legacy_mode
|
Impedir o uso do serviço de API v2 no Resource Manager público do Azure Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto de workspace. |
Exceções
| Tipo | Description |
|---|---|
|
Gerado para problemas ao criar o workspace. |
Comentários
Este primeiro exemplo requer apenas 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 os recursos existentes do Azure utilizando o formato da ID do recurso do Azure. As IDs específicas do recurso do Azure podem ser recuperadas por meio do SDK ou do Portal do Azure. 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á 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
Excluir os recursos associados ao Workspace do Azure Machine Learning.
delete(delete_dependent_resources=False, no_wait=False)Parâmetros
| Nome | Description |
|---|---|
|
delete_dependent_resources
|
Se deve excluir os recursos associados ao workspace, ou seja, o registro de contêiner, a conta de armazenamento, o cofre de chaves e o Application Insights. O padrão é False. Definir como True para excluir esses recursos também. Valor padrão: False
|
|
no_wait
|
Se deve aguardar a conclusão da exclusão do workspace. Valor padrão: False
|
Retornos
| Tipo | Description |
|---|---|
|
None, se for bem-sucedido; caso contrário, vai gerar um erro. |
delete_connection
Excluir uma conexão do workspace.
delete_connection(name)Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
O nome exclusivo da conexão no workspace |
delete_private_endpoint_connection
Excluir a conexão do ponto de extremidade privado com o workspace.
delete_private_endpoint_connection(private_endpoint_connection_name)Parâmetros
| Nome | Description |
|---|---|
|
private_endpoint_connection_name
Obrigatório
|
O nome exclusivo da conexão do ponto de extremidade privado no workspace |
diagnose_workspace
Diagnosticar problemas de instalação do workspace.
diagnose_workspace(diagnose_parameters)Parâmetros
| Nome | Description |
|---|---|
|
diagnose_parameters
Obrigatório
|
<xref:_restclient.models.DiagnoseWorkspaceParameters>
O parâmetro de diagnóstico da integridade do workspace |
Retornos
| Tipo | Description |
|---|---|
|
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]
|
Uma instância de AzureOperationPoller que retorna DiagnoseResponseResult |
from_config
Retornar um objeto de workspace de um Workspace do Azure Machine Learning existente.
Lê a configuração do workspace de um arquivo. Gera uma exceção caso o arquivo de configuração não seja encontrado.
O método fornece uma maneira simples de reutilizar o mesmo workspace em vários notebooks ou projetos do Python. Os usuários podem salvar as propriedades do ARM (Azure Resource Manager) do workspace usando o método write_config e usar esse método para carregar o mesmo workspace em diferentes notebooks ou projetos do Python sem digitar novamente as propriedades do ARM do workspace.
static from_config(path=None, auth=None, _logger=None, _file_name=None)Parâmetros
| Nome | Description |
|---|---|
|
path
|
O caminho para o arquivo de configuração ou para o diretório inicial a ser pesquisado. O parâmetro segue o padrão para iniciar a pesquisa no diretório atual. Valor padrão: None
|
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se for None, serão usadas as credenciais padrão da CLI do Azure ou a API solicitará credenciais. Valor padrão: None
|
|
_logger
|
Permite substituir o agente padrão. Valor padrão: None
|
|
_file_name
|
Permite substituir o nome do arquivo de configuração para pesquisar quando o caminho é um caminho de diretório. Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto de workspace para um Workspace do Azure ML existente. |
get
Retornar um objeto de workspace de um Workspace do Azure Machine Learning existente.
Gera uma exceção caso o workspace não exista ou os campos obrigatórios não identifiquem exclusivamente um workspace.
static get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
O nome do workspace a ser obtido. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se o valor for None, serão usadas as credenciais padrão da CLI do Azure ou a API solicitará credenciais. Valor padrão: None
|
|
subscription_id
|
A ID da assinatura a ser usada. O parâmetro será necessário se o usuário tiver acesso a mais de uma assinatura. Valor padrão: None
|
|
resource_group
|
O grupo de recursos a ser usado. Se o valor for None, o método pesquisará todos os grupos de recursos na assinatura. Valor padrão: None
|
|
location
|
O local do workspace. Valor padrão: None
|
|
cloud
|
O nome da nuvem de destino. Pode ser "AzureCloud", "AzureChinaCloud" ou "AzureUSGovernment". Se nenhuma nuvem for especificada, "AzureCloud" será usado. Valor padrão: AzureCloud
|
|
id
|
A ID do workspace. Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto de workspace. |
get_connection
Obter uma conexão do workspace.
get_connection(name)Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
O nome exclusivo da conexão no workspace |
get_default_compute_target
Obter o destino de computação padrão para o workspace.
get_default_compute_target(type)Parâmetros
| Nome | Description |
|---|---|
|
type
Obrigatório
|
O tipo de computação. Os valores possíveis são 'CPU' ou 'GPU'. |
Retornos
| Tipo | Description |
|---|---|
|
O destino de computação padrão para o tipo de computação fornecido. |
get_default_datastore
Obter o armazenamento de dados padrão para o workspace.
get_default_datastore()Retornos
| Tipo | Description |
|---|---|
|
O armazenamento de dados padrão. |
get_default_keyvault
Obter o objeto do cofre de chaves padrão para o workspace.
get_default_keyvault()Retornos
| Tipo | Description |
|---|---|
|
O objeto KeyVault associado ao workspace. |
get_details
Retornar os detalhes do workspace.
get_details()Retornos
| Tipo | Description |
|---|---|
|
Detalhes do workspace no formato de dicionário. |
Comentários
O dicionário retornado contém os seguintes pares chave-valor.
id: URI que aponta para este recurso de workspace, que contém a ID de assinatura, o grupo de recursos e o nome do workspace.
name: o nome deste workspace.
location: a região do workspace.
type: um URI do formato "{providerName}/workspaces".
tags: não usado no momento.
workspaceid: a ID deste workspace.
description: não usado no momento.
friendlyName: um nome amigável para o workspace exibido na interface do usuário.
creationTime: hora em que este workspace foi criado, no formato ISO8601.
containerRegistry: o registro de contêiner do workspace usado para efetuar pull e push das imagens de experimentação e de serviços Web.
keyVault: o cofre de chaves do workspace usado para armazenar credenciais adicionadas ao workspace pelos usuários.
applicationInsights: o Application Insights será usado pelo workspace para registrar eventos de serviços Web.
identityPrincipalId:
identityTenantId
identityType
storageAccount: o armazenamento será usado pelo workspace para salvar saídas de execução, código, logs etc.
sku: o SKU do workspace (também conhecido como edição). O parâmetro está presente para compatibilidade com versões anteriores e é ignorado.
resourceCmkUri: o URI da chave gerenciada pelo cliente para criptografar dados inativos. Consulte https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 para obter as 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 da imagem.
systemDatastoresAuthMode: determina se as credenciais devem ser usadas ou não para os armazenamentos de dados do sistema do workspace 'workspaceblobstore' e 'workspacefilestore'. O valor padrão é 'accessKey'; nesse caso, o workspace criará os armazenamentos de dados do sistema com credenciais. Se definido como 'identity', o workspace 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
Obter o URI de acompanhamento de MLflow para o workspace.
O MLflow (https://mlflow.org/) é uma plataforma de código aberto para rastrear experimentos de machine learning e gerenciar modelos. Você pode usar as APIs de registro em log do MLflow com o Azure Machine Learning para que as métricas, os modelos e os artefatos sejam registrados em seu workspace do Azure Machine Learning.
get_mlflow_tracking_uri(_with_auth=False)Parâmetros
| Nome | Description |
|---|---|
|
_with_auth
|
(PRETERIDO) Adicionar informações de autenticação ao URI de rastreamento. Valor padrão: False
|
Retornos
| Tipo | Description |
|---|---|
|
O URI de acompanhamento compatível com MLflow. |
Comentários
Use o exemplo a seguir para configurar o acompanhamento de MLflow para enviar dados para o Workspace 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
Retornar a execução com o run_id especificado no workspace.
get_run(run_id)Parâmetros
| Nome | Description |
|---|---|
|
run_id
Obrigatório
|
A ID de execução. |
Retornos
| Tipo | Description |
|---|---|
|
A execução enviada. |
list
Listar todos os workspaces aos quais o usuário tem acesso na assinatura.
A lista de workspaces pode ser filtrada de acordo com o grupo de recursos.
static list(subscription_id, auth=None, resource_group=None)Parâmetros
| Nome | Description |
|---|---|
|
subscription_id
Obrigatório
|
A ID da assinatura para a qual listar workspaces. |
|
auth
|
O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth. Se o valor for None, serão usadas as credenciais padrão da CLI do Azure ou a API solicitará credenciais. Valor padrão: None
|
|
resource_group
|
Um grupo de recursos para filtrar os workspaces retornados. Se o valor for None, o método listará todos os workspaces na assinatura especificada. Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário em que a chave é o nome do workspace e o valor é uma lista de objetos de Workspace. |
list_connections
Listar conexões neste workspace.
list_connections(category=None, target=None)Parâmetros
| Nome | Description |
|---|---|
|
type
Obrigatório
|
O tipo desta conexão que será filtrada |
|
target
|
o destino desta conexão que será filtrada Valor padrão: None
|
|
category
|
Valor padrão: None
|
list_keys
set_connection
Adicionar ou atualizar uma conexão no workspace.
set_connection(name, category, target, authType, value)Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
O nome exclusivo da conexão no workspace |
|
category
Obrigatório
|
A categoria desta conexão |
|
target
Obrigatório
|
o destino desta conexão |
|
authType
Obrigatório
|
o tipo de autorização desta conexão |
|
value
Obrigatório
|
a cadeia de caracteres de serialização do formato json dos detalhes da conexão |
set_default_datastore
Definir o armazenamento de dados padrão para o workspace.
set_default_datastore(name)Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
O nome do Datastore a ser definido como padrão. |
setup
Criar um novo workspace ou recuperar um existente.
static setup()Retornos
| Tipo | Description |
|---|---|
|
O objeto de Workspace. |
sync_keys
Dispara o workspace para sincronizar as chaves imediatamente.
Se as chaves de qualquer recurso no workspace forem alteradas, pode levar cerca de uma hora para que elas sejam atualizadas automaticamente. Essa função permite que as chaves 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
| Nome | Description |
|---|---|
|
no_wait
|
Se deve aguardar a conclusão das chaves de sincronização do workspace. Valor padrão: False
|
Retornos
| Tipo | Description |
|---|---|
|
None, se for bem-sucedido; caso contrário, vai gerar um erro. |
update
Atualizar o nome amigável, a descrição, as marcas, a computação da compilação da imagem e outras configurações associadas a um workspace.
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
| Nome | Description |
|---|---|
|
friendly_name
|
Um nome amigável opcional para o workspace que pode ser exibido na interface do usuário. Valor padrão: None
|
|
description
|
Uma descrição do workspace. Valor padrão: None
|
|
tags
|
Marcas para associar ao workspace. Valor padrão: None
|
|
image_build_compute
|
O nome de computação para a compilação da imagem. Valor padrão: None
|
|
service_managed_resources_settings
|
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
As configurações de recursos gerenciados do serviço. Valor padrão: None
|
|
primary_user_assigned_identity
|
A ID de recurso de identidade atribuída pelo usuário que representa a identidade do workspace. Valor padrão: None
|
|
allow_public_access_when_behind_vnet
|
Permitir acesso público ao workspace do link privado. Valor padrão: None
|
|
v1_legacy_mode
|
Impedir o uso do serviço de API v2 no Resource Manager público do Azure Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário de informações atualizadas. |
update_dependencies
Atualizar os recursos associados existentes para o workspace nos casos a seguir.
a) Quando um usuário exclui acidentalmente um recurso associado existente e gostaria de atualizá-lo com um novo sem precisar recriar o workspace inteiro. b) Quando um usuário tem um recurso associado existente e deseja substituir o atual que está associado ao workspace. c) Quando um recurso associado ainda não foi criado e o usuário precisa usar um existente que já tenha (aplica-se somente ao registro de contêiner).
update_dependencies(container_registry=None, force=False)Parâmetros
| Nome | Description |
|---|---|
|
container_registry
|
ID do ARM para o registro de contêiner. Valor padrão: None
|
|
force
|
Se forçar a atualização de recursos dependentes sem confirmação solicitada. Valor padrão: False
|
Retornos
| Tipo | Description |
|---|---|
write_config
Gravar as propriedades do ARM (Azure Resource Manager) do workspace em um arquivo de configuração.
As propriedades do ARM de workspace podem ser carregadas mais tarde usando o método from_config. O path segue o padrão para '.azureml/' no diretório de trabalho atual e file_name segue o padrão para 'config.json'.
O método fornece uma maneira simples de reutilizar o mesmo workspace em vários notebooks ou projetos do Python. Os usuários podem salvar as propriedades do ARM do workspace usando esta função e usar from_config para carregar o mesmo workspace em diferentes notebooks ou projetos do Python sem digitar novamente as propriedades do ARM do workspace.
write_config(path=None, file_name=None)Parâmetros
| Nome | Description |
|---|---|
|
path
|
Local fornecido pelo usuário para gravar o arquivo config.json. O parâmetro segue o padrão para '.azureml/' no diretório de trabalho atual. Valor padrão: None
|
|
file_name
|
Nome a ser usado para o arquivo de configuração. O parâmetro segue o padrão para config.json. Valor padrão: None
|
Atributos
compute_targets
Listar todos os destinos de computação no workspace.
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome do destino de computação e um valor como objeto ComputeTarget. |
datasets
Listar todos os conjuntos de dados no workspace.
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome do conjunto de dados e um valor como objeto Dataset. |
datastores
Listar todos os armazenamentos de dados no workspace. Essa operação não retorna credenciais dos armazenamentos de dados.
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome do armazenamento de dados e um valor como objeto Datastore. |
discovery_url
Retornar a URL de descoberta deste workspace.
Retornos
| Tipo | Description |
|---|---|
|
A URL de descoberta deste workspace. |
environments
Listar todos os ambientes no workspace.
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome do ambiente e um valor como objeto Environment. |
experiments
Listar todos os experimentos no workspace.
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome do experimento e um valor como objeto Experiment. |
images
Retornar a lista de imagens no workspace.
Gera um WebserviceException caso haja um problema ao interagir com o serviço de gerenciamento de modelos.
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário com chave como nome da imagem e um valor como objeto Image. |
Exceções
| Tipo | Description |
|---|---|
|
Houve um problema ao interagir com o serviço de gerenciamento de modelos. |
linked_services
Listar todos os serviços vinculados no workspace.
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário em que a chave é um nome de serviço vinculado e o valor é um objeto LinkedService. |
location
Retornar a localização deste workspace.
Retornos
| Tipo | Description |
|---|---|
|
A localização deste workspace. |
models
Retornar uma lista de modelos no workspace.
Gera um WebserviceException caso haja um problema ao interagir com o serviço de gerenciamento de modelos.
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário de modelo com chave como nome do modelo e um valor como objeto Model. |
Exceções
| Tipo | Description |
|---|---|
|
Houve um problema ao interagir com o serviço de gerenciamento de modelos. |
name
private_endpoints
Listar todos os pontos de extremidade privados do workspace.
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário de objetos PrivateEndPoint associados ao workspace. A chave é o nome do ponto de extremidade privado. |
resource_group
Retornar o nome do grupo de recursos para este workspace.
Retornos
| Tipo | Description |
|---|---|
|
O nome do grupo de recursos. |
service_context
Retornar o contexto de serviço deste workspace.
Retornos
| Tipo | Description |
|---|---|
|
<xref:azureml._restclient.service_context.ServiceContext>
|
Retorna o objeto ServiceContext. |
sku
subscription_id
tags
webservices
Retornar uma lista de serviços Web no workspace.
Gera um WebserviceException caso haja um problema ao retornar a lista.
Retornos
| Tipo | Description |
|---|---|
|
Uma lista de serviços Web no workspace. |
Exceções
| Tipo | Description |
|---|---|
|
Houve um problema ao retornar 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'