Workspace Classe

Define um recurso de Azure Machine Learning para gerenciar artefatos de implantação e treinamento.

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 um SKU associado.

Para obter mais informações sobre espaços de trabalho, consulte:

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)

Parâmetros

subscription_id
str

A ID da assinatura do Azure que contém o espaço de trabalho.

resource_group
str

O grupo de recursos que contém o espaço de trabalho.

workspace_name
str

O nome do espaço de trabalho existente.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication ou MsiAuthentication

O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth . Se nenhum, as credenciais de CLI do Azure padrão serão usadas ou a API solicitará credenciais.

_location
str

Apenas para uso interno.

_disable_service_check
bool

Apenas para uso interno.

_workspace_id
str

Apenas para uso interno.

sku
str

O parâmetro está presente para compatibilidade com versões anteriores e é ignorado. Para obter mais informações, consulte SKUs Azure Machine Learning.

Comentários

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 false 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 a assinatura, o recurso e o nome do espaço de trabalho para que ele 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 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 as credenciais de autenticação do Azure usando uma caixa de diálogo de logon interativo. Para outros casos de uso, incluindo o uso do CLI do Azure para autenticar e autenticação em fluxos de trabalho automatizados, consulte autenticação no Azure Machine Learning.

Métodos

add_private_endpoint

Adicione um ponto de extremidade privado ao espaço de trabalho.

create

Crie um novo Workspace do Azure Machine Learning.

Gera uma exceção se o espaço de trabalho já existe ou qualquer um dos requisitos de espaço de trabalho não é atendido.

delete

Exclua os Workspace do Azure Machine Learning recursos associados.

delete_connection

Exclua uma conexão do espaço de trabalho.

delete_private_endpoint_connection

Exclua a conexão de ponto de extremidade particular para o espaço de trabalho.

from_config

Retornar um objeto de espaço de trabalho de um Workspace do Azure Machine Learning existente.

Lê a configuração do espaço de trabalho de um arquivo. Gera 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 blocos de anotações ou projetos do Python. Os usuários podem salvar as propriedades do espaço de trabalho Azure Resource Manager (ARM) 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 do Python sem digitar novamente as propriedades do ARM do espaço de trabalho.

get

Retornar um objeto de espaço de trabalho para um Workspace do Azure Machine Learning existente.

Gera uma exceção se o espaço de trabalho não existe ou os campos obrigatórios não identificam 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 repositório de armazenamento padrão para o espaço de trabalho.

get_default_keyvault

Obtenha o objeto do cofre de chaves 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 de MLflow para o espaço de trabalho.

MLflow ( https://mlflow.org/ ) é uma plataforma de software livre para acompanhar experimentos de aprendizado de máquina e gerenciar modelos. Você pode usar as APIs de log do MLflow com Azure Machine Learning para que as métricas, os modelos e os 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

Lista 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

Listar conexões neste espaço de trabalho.

list_keys

Listar chaves para o espaço de trabalho atual.

set_connection

Adicionar ou atualizar uma conexão no espaço de trabalho.

set_default_datastore

Defina o repositório de armazenamento 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

Dispara o espaço de trabalho para sincronizar as chaves imediatamente.

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

Atualize o nome amigável, a descrição, as marcas, a computação da compilação da imagem e outras configurações associadas a um espaço de trabalho.

update_dependencies

Atualize os recursos associados para o espaço de trabalho 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 espaço de trabalho inteiro. 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 tiver sido criado e quiser usar um existente que já tenha (aplica-se somente ao registro de contêiner).

write_config

Gravar as propriedades de Azure Resource Manager do espaço de trabalho (ARM) em um arquivo de configuração.

As propriedades do ARM de espaço de trabalho podem ser carregadas mais tarde usando o from_config método. O path padrão é '. azureml/' no diretório de trabalho atual e o file_name padrão é ' config.jsem '.

O método fornece uma maneira simples de reutilizar o mesmo espaço de trabalho em vários blocos de anotações ou projetos do Python. Os usuários podem salvar as propriedades do ARM de 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 do Python sem digitar novamente as propriedades do 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

private_endpoint_config
PrivateEndPointConfig

A configuração do ponto de extremidade privado para criar um ponto de extremidade privado para o espaço de trabalho.

private_endpoint_auto_approval
bool
valor padrão: True

Um sinalizador booliano que denota se a criação do ponto de extremidade privado deve ser aprovada automaticamente ou aprovada manualmente no centro de links privados do Azure. No caso de aprovação manual, os usuários podem exibir a solicitação pendente no portal de link privado para aprovar/rejeitar a solicitação.

location
string
valor padrão: None

Local do ponto de extremidade privado, o padrão é o local do espaço de trabalho

show_output
bool
valor padrão: True

Sinalizador para mostrar o progresso da criação do espaço de trabalho

tags
dict
valor padrão: None

Marcas a serem associadas ao espaço de trabalho.

Retornos

O objeto PrivateEndPoint criado.

Tipo de retorno

create

Crie um novo Workspace do Azure Machine Learning.

Gera uma exceção se o espaço de trabalho já existe ou qualquer um dos requisitos de espaço de trabalho não é atendido.

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')

Parâmetros

name
str

O novo nome do espaço de trabalho. 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. Espaço em branco não é permitido.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor padrão: None

O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth . Se nenhum, as credenciais de CLI do Azure padrão serão usadas ou a API solicitará credenciais.

subscription_id
str
valor padrão: None

A ID de assinatura da assinatura que a contém para o novo espaço de trabalho. O parâmetro será necessário se o usuário tiver acesso a mais de uma assinatura.

resource_group
str
valor padrão: None

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.

location
str
valor padrão: None

O local do espaço de trabalho. O parâmetro usa como padrão o local do grupo de recursos. O local deve ser uma região com suporte para Azure Machine Learning.

create_resource_group
bool
valor padrão: True

Indica se o grupo de recursos deve ser criado, caso ele não exista.

sku
str
valor padrão: basic

O parâmetro está presente para compatibilidade com versões anteriores e é ignorado. Para obter mais informações, consulte SKUs Azure Machine Learning.

tags
dict
valor padrão: None

Marcas a serem associadas ao espaço de trabalho.

friendly_name
str
valor padrão: None

Um nome amigável opcional para o espaço de trabalho que pode ser exibido na interface do usuário.

storage_account
str
valor padrão: None

Uma conta de armazenamento existente no formato de ID de recurso do Azure. O armazenamento será usado pelo espaço de trabalho para salvar as saídas, o código e os logs de execução, etc. Se nenhum, uma nova conta de armazenamento será criada.

key_vault
str
valor padrão: None

Um cofre de chaves existente no formato de ID de recurso do Azure. Confira o exemplo de código abaixo para obter detalhes do formato da ID de recurso do Azure. O cofre de chaves será usado pelo espaço de trabalho para armazenar as credenciais adicionadas ao espaço de trabalho pelos usuários. Se nenhum, um novo cofre de chaves será criado.

app_insights
str
valor padrão: None

Um Application Insights existente no formato de ID de recurso do Azure. Confira o exemplo de código abaixo para obter detalhes do formato da ID de recurso do Azure. O Application Insights será usado pelo espaço de trabalho para registrar eventos de serviços da WebServices. Se nenhum, um novo Application Insights será criado.

container_registry
str
valor padrão: None

Um registro de contêiner existente no formato de ID de recurso do Azure (Veja 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 efetuar pull e enviar por push as 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.

adb_workspace
str
valor padrão: None

Um espaço de trabalho ADB existente no formato de ID de recurso do Azure (Veja o código de exemplo abaixo para obter detalhes do formato de ID de recurso do Azure). O espaço de trabalho ADB será usado para vincular com o espaço de trabalho. Se nenhum, o link do espaço de trabalho não acontecerá.

primary_user_assigned_identity
str
valor padrão: None

A ID de recurso da identidade atribuída pelo usuário que costumava representar o espaço de trabalho

cmk_keyvault
str
valor padrão: None

O cofre de chaves que contém a chave gerenciada 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 nos comentários abaixo para obter mais detalhes sobre o formato de ID de recurso do Azure.

resource_cmk_uri
str
valor padrão: None

O URI de chave da chave gerenciada pelo cliente para criptografar os dados em repouso. O formato do URI é: https://<keyvault-dns-name>/keys/<key-name>/<key-version> . Por exemplo, ' https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b '. Consulte https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal para obter as etapas sobre como criar uma chave e obter seu URI.

hbi_workspace
bool
valor padrão: False

Especifica se o espaço de trabalho contém dados de alto impacto nos negócios (Ain), ou seja, contém informações comerciais confidenciais. Esse sinalizador só pode ser definido durante a criação do espaço de trabalho. Seu valor não pode ser alterado depois que o espaço de trabalho é criado. O valor padrão é False.

Quando definido como true, as etapas de criptografia adicionais são executadas e, dependendo do componente do SDK, resulta em informações redaçãos na telemetria coletada internamente. Para obter mais informações, consulte criptografia de dados.

Quando esse sinalizador é definido como true, um possível impacto é maior dificuldade para solucionar problemas. Isso pode acontecer porque alguma telemetria não é enviada à Microsoft e há menos visibilidade em taxas de sucesso ou tipos de problemas e, portanto, pode não ser capaz de reagir como de forma proativa quando esse sinalizador é verdadeiro. A recomendação é usar o padrão false para esse sinalizador, a menos que seja estritamente necessário para ser verdadeiro.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
valor padrão: None

PRETERIDO Uma configuração que será usada para criar uma computação de CPU. O parâmetro usa como padrão {min_nodes = 0, max_nodes = 2, vm_size = "STANDARD_DS2_V2", vm_priority = "dedicado"} se nenhum, nenhuma computação será criada.

default_gpu_compute_target
AmlComputeProvisioningConfiguration
valor padrão: None

PRETERIDO Uma configuração que será usada para criar uma computação de GPU. O parâmetro usa como padrão {min_nodes = 0, max_nodes = 2, vm_size = "STANDARD_NC6", vm_priority = "dedicado"} se nenhum, nenhuma computação será criada.

private_endpoint_config
PrivateEndPointConfig
valor padrão: None

A configuração do ponto de extremidade privado para criar um ponto de extremidade privado para o espaço de trabalho do Azure ML.

private_endpoint_auto_approval
bool
valor padrão: True

Um sinalizador booliano que denota se a criação do ponto de extremidade privado deve ser aprovada automaticamente ou aprovada manualmente no centro de links privados do Azure. No caso de aprovação manual, os usuários podem exibir a solicitação pendente no portal de link privado para aprovar/rejeitar a solicitação.

exist_ok
bool
valor padrão: False

Indica se esse método terá sucesso se o espaço de trabalho já existir. Se for false, esse método falhará se o espaço de trabalho existir. Se for true, esse método retornará o espaço de trabalho existente, se existir.

show_output
bool
valor padrão: True

Indica se esse método imprimirá o progresso incremental.

user_assigned_identity_for_cmk_encryption
str
valor padrão: None

A ID de recurso da identidade atribuída pelo usuário que precisa ser usada para acessar a chave de gerenciamento do cliente

system_datastores_auth_mode
str
valor padrão: accessKey

Determina se as credenciais devem ser usadas ou não para os repositórios de armazenamento do espaço de trabalho ' workspaceblobstore ' e ' workspacefilestore '. O valor padrão é ' accessKey '; nesse caso, o espaço de trabalho criará os repositórios de armazenamento do sistema com credenciais. Se definido como ' Identity ', o espaço de trabalho criará os repositórios de armazenamento do sistema sem credenciais.

Retornos

O objeto de espaço de trabalho.

Tipo de retorno

Exceções

Gerado para problemas ao criar o espaço de trabalho.

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 de ID de recurso do Azure. As IDs de recurso do Azure específicas podem ser recuperadas por meio do portal do Azure ou do SDK do. 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,
                         sku='enterprise')

delete

Exclua os Workspace do Azure Machine Learning recursos associados.

delete(delete_dependent_resources=False, no_wait=False)

Parâmetros

delete_dependent_resources
bool
valor padrão: False

Se é para excluir os recursos associados ao espaço de trabalho, ou seja, registro de contêiner, conta de armazenamento, Key Vault e Application insights. O padrão é False. Defina como true para excluir esses recursos.

no_wait
bool
valor padrão: False

Se deve aguardar a conclusão da exclusão do espaço de trabalho.

Retornos

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

Tipo de retorno

delete_connection

Exclua uma conexão do espaço de trabalho.

delete_connection(name)

Parâmetros

name
str

O nome exclusivo da conexão no espaço de trabalho

delete_private_endpoint_connection

Exclua a conexão de ponto de extremidade particular para o espaço de trabalho.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parâmetros

private_endpoint_connection_name
str

O nome exclusivo da conexão de ponto de extremidade privado no espaço de trabalho

from_config

Retornar um objeto de espaço de trabalho de um Workspace do Azure Machine Learning existente.

Lê a configuração do espaço de trabalho de um arquivo. Gera 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 blocos de anotações ou projetos do Python. Os usuários podem salvar as propriedades do espaço de trabalho Azure Resource Manager (ARM) 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 do Python sem digitar novamente as propriedades do ARM do espaço de trabalho.

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

Parâmetros

path
str
valor padrão: None

O caminho para o arquivo de configuração ou para o diretório inicial a ser pesquisado. O padrão do parâmetro é iniciar a pesquisa no diretório atual.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor padrão: None

O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth . Se nenhum, as credenciais de CLI do Azure padrão serão usadas ou a API solicitará credenciais.

_logger
Logger
valor padrão: None

Permite substituir o agente de log padrão.

_file_name
str
valor padrão: None

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

Retornos

O objeto de espaço de trabalho para um Workspace do ML do Azure existente.

Tipo de retorno

get

Retornar um objeto de espaço de trabalho para um Workspace do Azure Machine Learning existente.

Gera uma exceção se o espaço de trabalho não existe ou os campos obrigatórios não identificam exclusivamente um espaço de trabalho.

get(name, auth=None, subscription_id=None, resource_group=None)

Parâmetros

name
str

O nome do espaço de trabalho a ser obtido.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor padrão: None

O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth . Se nenhum, as credenciais de CLI do Azure padrão serão usadas ou a API solicitará credenciais.

subscription_id
str
valor padrão: None

A ID da assinatura a ser usada. O parâmetro será necessário se o usuário tiver acesso a mais de uma assinatura.

resource_group
str
valor padrão: None

O grupo de recursos a ser usado. Se nenhum, o método pesquisará todos os grupos de recursos na assinatura.

Retornos

O objeto de espaço de trabalho.

Tipo de retorno

get_connection

Obtenha uma conexão do espaço de trabalho.

get_connection(name)

Parâmetros

name
str

O nome exclusivo da conexão no 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

type
str

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

Retornos

O destino de computação padrão para o tipo de computação fornecido.

Tipo de retorno

get_default_datastore

Obtenha o repositório de armazenamento padrão para o espaço de trabalho.

get_default_datastore()

Retornos

O repositório de armazenamento padrão.

Tipo de retorno

get_default_keyvault

Obtenha o objeto do cofre de chaves padrão para o espaço de trabalho.

get_default_keyvault()

Retornos

O objeto keyvault associado ao espaço de trabalho.

Tipo de retorno

get_details

Retornar os detalhes do espaço de trabalho.

get_details()

Retornos

Detalhes do espaço de trabalho no formato de dicionário.

Tipo de retorno

Comentários

O dicionário retornado contém os seguintes pares de chave-valor.

  • ID: URI que aponta para este recurso de espaço de trabalho, que contém a ID de assinatura, grupo de recursos e nome do espaço de trabalho.

  • nome: o nome deste espaço de trabalho.

  • local: a região do espaço de trabalho.

  • tipo: um URI do formato "{ProviderName}/workspaces".

  • marcas: não usadas atualmente.

  • workspaceid: a ID deste espaço de trabalho.

  • Descrição: não usada 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, no formato ISO8601.

  • containerRegistry: o registro de contêiner do espaço de trabalho usado para efetuar pull e enviar por push as imagens de experimentação e WebServices.

  • keyvault: o cofre de chaves do espaço de trabalho usado para armazenar as 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 serviços da WebServices.

  • identityPrincipalId:

  • identityTenantId

  • identityType

  • storageAccount: o armazenamento será usado pelo espaço de trabalho para salvar a execução de saídas, código, logs, etc.

  • SKU: a SKU do espaço de trabalho (também conhecida como edição). Para obter mais informações, consulte SKUs Azure Machine Learning.

  • resourceCmkUri: o URI de chave da chave gerenciada pelo cliente para criptografar os dados em repouso. 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 para os repositórios de armazenamento do espaço de trabalho ' workspaceblobstore ' e ' workspacefilestore ' devem ser usadas. O valor padrão é ' accessKey '; nesse caso, o espaço de trabalho criará os repositórios de armazenamento do sistema com credenciais. Se definido como ' Identity ', o espaço de trabalho criará os repositórios de armazenamento do sistema sem credenciais.

Para obter mais informações sobre esses pares de chave-valor, consulte create .

get_mlflow_tracking_uri

Obtenha o URI de acompanhamento de MLflow para o espaço de trabalho.

MLflow ( https://mlflow.org/ ) é uma plataforma de software livre para acompanhar experimentos de aprendizado de máquina e gerenciar modelos. Você pode usar as APIs de log do MLflow com Azure Machine Learning para que as métricas, os modelos e os artefatos sejam registrados em seu espaço de trabalho do Azure Machine Learning.

get_mlflow_tracking_uri(_with_auth=False)

Parâmetros

_with_auth
bool
valor padrão: False

PRETERIDO Adicione informações de autenticação ao URI de rastreamento.

Retornos

O URI de acompanhamento compatível com MLflow.

Tipo de retorno

str

Comentários

Use o exemplo a seguir para configurar o acompanhamento de MLflow para enviar dados para o Workspace do 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

Retorne a execução com o run_id especificado no espaço de trabalho.

get_run(run_id)

Parâmetros

run_id
string

A ID de execução.

Retornos

A execução enviada.

Tipo de retorno

Run

list

Lista 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(subscription_id, auth=None, resource_group=None)

Parâmetros

subscription_id
str

A ID da assinatura para a qual listar espaços de trabalho.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor padrão: None

O objeto de autenticação. Para obter mais detalhes, consulte https://aka.ms/aml-notebook-auth . Se nenhum, as credenciais de CLI do Azure padrão serão usadas ou a API solicitará credenciais.

resource_group
str
valor padrão: None

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.

Retornos

Um dicionário em que a chave é o nome do espaço de trabalho e o valor é uma lista de objetos de espaço de trabalho.

Tipo de retorno

list_connections

Listar conexões neste espaço de trabalho.

list_connections(category=None, target=None)

Parâmetros

type
str
valor padrão: None

O tipo desta conexão que será filtrada

target
str
valor padrão: None

o destino desta conexão que será filtrada

list_keys

Listar chaves para o espaço de trabalho atual.

list_keys()

Tipo de retorno

set_connection

Adicionar ou atualizar uma conexão no espaço de trabalho.

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

Parâmetros

name
str

O nome exclusivo da conexão no espaço de trabalho

category
str

A categoria desta conexão

target
str

o destino ao qual essa conexão se conecta

authType
str

o tipo de autorização desta conexão

value
str

a cadeia de caracteres de serialização de formato JSON dos detalhes da conexão

set_default_datastore

Defina o repositório de armazenamento padrão para o espaço de trabalho.

set_default_datastore(name)

Parâmetros

name
str

O nome do a Datastore ser definido como padrão.

setup

Crie um novo espaço de trabalho ou recupere um espaço de trabalho existente.

setup()

Retornos

Um objeto de espaço de trabalho.

Tipo de retorno

sync_keys

Dispara o espaço de trabalho para sincronizar as chaves imediatamente.

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

Retornos

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

Tipo de retorno

update

Atualize o nome amigável, a descrição, as marcas, a computação da compilação da 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)

Parâmetros

friendly_name
str
valor padrão: None

Um nome amigável para o espaço de trabalho que pode ser exibido na interface do usuário.

description
str
valor padrão: None

Uma descrição do espaço de trabalho.

tags
dict
valor padrão: None

Marcas a serem associadas ao espaço de trabalho.

image_build_compute
str
valor padrão: None

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

service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
valor padrão: None

As configurações de recursos gerenciados do serviço.

primary_user_assigned_identity
str
valor padrão: None

A ID de recurso de identidade atribuída pelo usuário que representa a identidade do espaço de trabalho.

allow_public_access_when_behind_vnet
bool
valor padrão: None

Permitir acesso público ao espaço de trabalho de link privado.

Retornos

Um dicionário de informações atualizadas.

Tipo de retorno

update_dependencies

Atualize os recursos associados para o espaço de trabalho 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 espaço de trabalho inteiro. 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 tiver sido criado e quiser usar um existente que já tenha (aplica-se somente ao registro de contêiner).

update_dependencies(container_registry=None, force=False)

Parâmetros

container_registry
str
valor padrão: None

ID do ARM para o registro de contêiner.

force
bool
valor padrão: False

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

write_config

Gravar as propriedades de Azure Resource Manager do espaço de trabalho (ARM) em um arquivo de configuração.

As propriedades do ARM de espaço de trabalho podem ser carregadas mais tarde usando o from_config método. O path padrão é '. azureml/' no diretório de trabalho atual e o file_name padrão é ' config.jsem '.

O método fornece uma maneira simples de reutilizar o mesmo espaço de trabalho em vários blocos de anotações ou projetos do Python. Os usuários podem salvar as propriedades do ARM de 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 do Python sem digitar novamente as propriedades do ARM do espaço de trabalho.

write_config(path=None, file_name=None)

Parâmetros

path
str
valor padrão: None

Local fornecido pelo usuário para gravar o config.jsno arquivo. O parâmetro usa como padrão '. azureml/' no diretório de trabalho atual.

file_name
str
valor padrão: None

Nome a ser usado para o arquivo de configuração. O parâmetro usa como padrão config.js.

Atributos

compute_targets

Lista todos os destinos de computação no espaço de trabalho.

Retornos

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

Tipo de retorno

datasets

Liste todos os conjuntos de valores no espaço de trabalho.

Retornos

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

Tipo de retorno

datastores

Liste todos os repositórios de armazenamento no espaço de trabalho. Esta operação não retorna credenciais dos repositórios de armazenamento.

Retornos

Um dicionário com a chave como o nome do repositório de armazenamento e o valor como Datastore objeto.

Tipo de retorno

discovery_url

Retornar a URL de descoberta deste espaço de trabalho.

Retornos

A URL de descoberta deste espaço de trabalho.

Tipo de retorno

str

environments

Lista todos os ambientes no espaço de trabalho.

Retornos

Um dicionário com a chave como o nome do ambiente e o valor como Ambiente objeto.

Tipo de retorno

experiments

Listar todos os experimentos no espaço de trabalho.

Retornos

Um dicionário com a chave como o nome do teste e o valor como Experiment objeto.

Tipo de retorno

images

Retornar a lista de imagens no espaço de trabalho.

Gera um WebserviceException se houve um problema ao interagir com o serviço de gerenciamento de modelos.

Retornos

Um dicionário com a chave como o nome da imagem e o valor como Image objeto.

Tipo de retorno

Exceções

Houve um problema ao interagir com o serviço de gerenciamento de modelos.

linked_services

Lista todos os serviços vinculados no espaço de trabalho.

Retornos

Um dicionário em que Key é um nome de serviço vinculado e Value é um LinkedService objeto.

Tipo de retorno

location

Retornar o local deste espaço de trabalho.

Retornos

O local deste espaço de trabalho.

Tipo de retorno

str

models

Retornar uma lista de modelos no espaço de trabalho.

Gera um WebserviceException se houve um problema ao interagir com o serviço de gerenciamento de modelos.

Retornos

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

Tipo de retorno

Exceções

Houve um problema ao interagir com o serviço de gerenciamento de modelos.

name

Retornar o nome do espaço de trabalho.

Retornos

O nome do workspace.

Tipo de retorno

str

private_endpoints

Listar todo o ponto de extremidade privado do espaço de trabalho.

Retornos

Um dicto de objetos PrivateEndPoint associados ao espaço de trabalho. A chave é um nome de ponto de extremidade privado.

Tipo de retorno

resource_group

Retornar o nome do grupo de recursos para este espaço de trabalho.

Retornos

O nome do grupo de recursos.

Tipo de retorno

str

service_context

Retornar o contexto do serviço para este espaço de trabalho.

Retornos

Retorna o objeto do UserContext.

Tipo de retorno

<xref:azureml._restclient.service_context.ServiceContext>

sku

Retornar a SKU deste espaço de trabalho.

Retornos

A SKU deste espaço de trabalho.

Tipo de retorno

str

subscription_id

Retornar a ID da assinatura para este espaço de trabalho.

Retornos

A ID da assinatura.

Tipo de retorno

str

tags

Retornar as marcas deste espaço de trabalho.

Retornos

As marcas deste espaço de trabalho.

Tipo de retorno

webservices

Retornar uma lista de WebServices no espaço de trabalho.

Gera um WebserviceException se houve um problema ao retornar a lista.

Retornos

Uma lista de WebServices no espaço de trabalho.

Tipo de retorno

Exceções

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'