Workspace Classe

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

Um workspace é um recurso fundamental para o aprendizado de máquina Azure Machine Learning. Você usa um workspace para experimentar, treinar e implantar modelos de machine learning. Cada workspace está vinculado a uma assinatura e grupo de recursos do Azure e tem uma SKU associada.

Para obter mais informações sobre workspaces, 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
<xref:str>

A ID da assinatura do Azure que contém o workspace.

resource_group
<xref:str>

O grupo de recursos que contém o workspace.

workspace_name
<xref:str>

O nome do workspace 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 CLI do Azure padrão serão usadas ou a API solicitará credenciais.

_location
<xref:str>

Apenas para uso interno.

_disable_service_check
<xref:bool>

Apenas para uso interno.

_workspace_id
<xref:str>

Apenas para uso interno.

sku
<xref:str>

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

Comentários

O exemplo 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 sua assinatura, recurso e nome do workspace 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 workspace para ver um exemplo do arquivo de configuração.

Para carregar o workspace 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 workspace 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 interativo. Para outros casos de uso, incluindo o uso CLI do Azure autenticação 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 workspace.

create

Crie um novo Workspace do Azure Machine Learning.

Lançará uma exceção se o workspace já existir ou se algum dos requisitos de workspace não for atendido.

delete

Exclua Workspace do Azure Machine Learning recursos associados.

delete_connection

Exclua uma conexão do workspace.

delete_private_endpoint_connection

Exclua a conexão de ponto de extremidade privado com o workspace.

from_config

Retornar um objeto de workspace de um Workspace do Azure Machine Learning.

Lê a configuração do workspace de um arquivo. Lançará 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 workspace em vários notebooks ou projetos python. Os usuários podem salvar as propriedades do ARM (workspace Azure Resource Manager) usando o método e usar esse método para carregar o mesmo workspace em diferentes notebooks ou projetos do Python sem reatipar as propriedades arm do write_config workspace.

get

Retornar um objeto de workspace para um Workspace do Azure Machine Learning.

Lançará uma exceção se o workspace não existir ou se os campos necessários não identificarem 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 do MLflow para o workspace.

O MLflow ( https://mlflow.org/ ) é uma plataforma de código aberto para acompanhar experimentos de machine learning e gerenciar modelos. Você pode usar APIs de log do MLflow com Azure Machine Learning para que métricas, modelos e artefatos sejam registrados no workspace Azure Machine Learning.

get_run

Retornar a executar com a run_id especificada no workspace.

list

Liste todos os workspaces aos que o usuário tem acesso dentro da assinatura.

A lista de workspaces pode ser filtrada com base no grupo de recursos.

list_connections

Listar conexões nesse workspace.

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

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

private_endpoint_auto_approval
<xref:bool>
valor padrão: True

Um sinalizador booliana que indica se a criação do ponto de extremidade privado deve ser aprovada automaticamente ou aprovada manualmente do Link Privado do Azure Center. 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.

location
string
valor padrão: None

Local do ponto de extremidade privado, o padrão é o local do workspace

show_output
<xref:bool>
valor padrão: True

Sinalizador para mostrar o progresso da criação do workspace

tags
<xref:dict>
valor padrão: None

Marcas a associar ao workspace.

Retornos

O objeto PrivateEndPoint criado.

Tipo de retorno

create

Crie um novo Workspace do Azure Machine Learning.

Lançará uma exceção se o workspace já existir ou se algum dos requisitos de workspace não for 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
<xref:str>

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. O 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 CLI do Azure padrão serão usadas ou a API solicitará credenciais.

subscription_id
<xref:str>
valor padrão: None

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

resource_group
<xref:str>
valor padrão: None

O grupo de recursos do Azure que contém o workspace. O parâmetro assume como padrão uma mutação do nome do workspace.

location
<xref:str>
valor padrão: None

O local do workspace. O parâmetro assume 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
<xref:bool>
valor padrão: True

Indica se o grupo de recursos deve ser criado se ele não existir.

sku
<xref:str>
valor padrão: basic

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

tags
<xref:dict>
valor padrão: None

Marcas a associar ao workspace.

friendly_name
<xref:str>
valor padrão: None

Um nome amigável opcional para o workspace que pode ser exibido na interface do usuário.

storage_account
<xref:str>
valor padrão: None

Uma conta de armazenamento existente no formato de ID de recurso do Azure. O armazenamento será usado pelo workspace para salvar saídas de executar, código, logs etc. Se Nenhum, uma nova conta de armazenamento será criada.

key_vault
<xref:str>
valor padrão: None

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 workspace para armazenar as credenciais adicionadas ao workspace pelos usuários. Se Nenhum, um novo cofre de chaves será criado.

app_insights
<xref:str>
valor padrão: None

Um arquivo Application Insights 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 workspace para registrar eventos de serviços Web. Se Nenhum, uma nova Application Insights será criada.

container_registry
<xref:str>
valor padrão: None

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 workspace para efetuar pull e efetuar push de imagens de experimentação e serviços Web. Se Nenhum, um novo registro de contêiner será criado somente quando necessário e não junto com a criação do workspace.

adb_workspace
<xref:str>
valor padrão: None

Um workspace do 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 Workspace do Adb será usado para vincular com o workspace. Se Nenhum, o link do workspace não acontecerá.

primary_user_assigned_identity
<xref:str>
valor padrão: None

A ID do recurso da identidade atribuída pelo usuário que costumava representar o workspace

cmk_keyvault
<xref: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 da ID de recurso do Azure.

resource_cmk_uri
<xref:str>
valor padrão: None

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

hbi_workspace
<xref:bool>
valor padrão: False

Especifica se o workspace contém dados de alto impacto empresarial (HBI), ou seja, contém informações comerciais confidenciais. Esse sinalizador pode ser definido somente durante a criação do workspace. Seu valor não pode ser alterado depois que o workspace é criado. O valor padrão é False.

Quando definido como True, outras etapas de criptografia são executadas e, dependendo do componente do SDK, resulta em informações reprovadas na telemetria coletada internamente. Para obter mais informações, consulte Criptografia de dados.

Quando esse sinalizador é definido como True, um possível impacto é a maior dificuldade para 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, pode não ser capaz de reagir de forma proativa quando esse sinalizador é True. A recomendação é usar o padrão false para esse sinalizador, a menos que seja estritamente necessário ser True.

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 assume como padrão {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} 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 assume como padrão {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} 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 workspace do Azure ML.

private_endpoint_auto_approval
<xref:bool>
valor padrão: True

Um sinalizador booliana que indica se a criação do ponto de extremidade privado deve ser aprovada automaticamente ou aprovada manualmente do Link Privado do Azure Center. 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.

exist_ok
<xref:bool>
valor padrão: False

Indica se esse método terá êxito se o workspace já existir. Se False, esse método falhará se o workspace existir. Se True, esse método retornará o workspace existente se ele existir.

show_output
<xref:bool>
valor padrão: True

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

user_assigned_identity_for_cmk_encryption
<xref:str>
valor padrão: None

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

system_datastores_auth_mode
<xref:str>
valor padrão: accessKey

Determina se as credenciais deverão ou não ser usadas para os armazenamentos de dados do sistema do workspace 'workspaceblobstore' e 'workspacefilestore'. O valor padrão é 'accessKey', nesse caso, o workspace criará os datastores do sistema com credenciais. Se definido como 'identity', o workspace criará os datastores do sistema sem credenciais.

Retornos

O objeto do workspace.

Tipo de retorno

Exceções

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 recursos existentes do Azure utilizando o formato de ID de recurso do Azure. As IDs de recurso específicas do Azure podem ser recuperadas por meio do Portal do Azure ou do SDK. Isso pressuém 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,
                         sku='enterprise')

delete

Exclua Workspace do Azure Machine Learning recursos associados.

delete(delete_dependent_resources=False, no_wait=False)

Parâmetros

delete_dependent_resources
<xref:bool>
valor padrão: False

Se os recursos associados ao workspace serão excluídos, ou seja, o registro de contêiner, a conta de armazenamento, o cofre de chaves e o application insights. O padrão é False. De definido como True para excluir esses recursos.

no_wait
<xref:bool>
valor padrão: False

Se a exclusão do workspace deve ser concluída.

Retornos

Nenhum se for bem-sucedido; caso contrário, lançará um erro.

Tipo de retorno

<xref:None>

delete_connection

Exclua uma conexão do workspace.

delete_connection(name)

Parâmetros

name
<xref:str>

O nome exclusivo da conexão no workspace

delete_private_endpoint_connection

Exclua a conexão de ponto de extremidade privado com o workspace.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parâmetros

private_endpoint_connection_name
<xref:str>

O nome exclusivo da conexão de ponto de extremidade privado no workspace

from_config

Retornar um objeto de workspace de um Workspace do Azure Machine Learning.

Lê a configuração do workspace de um arquivo. Lançará 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 workspace em vários notebooks ou projetos python. Os usuários podem salvar as propriedades do ARM (workspace Azure Resource Manager) usando o método e usar esse método para carregar o mesmo workspace em diferentes notebooks ou projetos do Python sem reatipar as propriedades arm do write_config workspace.

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

Parâmetros

path
<xref:str>
valor padrão: None

O caminho para o arquivo de configuração ou o diretório inicial a ser pesquisado. O parâmetro assume como padrão 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 CLI do Azure padrão serão usadas ou a API solicitará credenciais.

_logger
<xref:logging.Logger>
valor padrão: None

Permite a substituição do logger padrão.

_file_name
<xref:str>
valor padrão: None

Permite a substituição do nome do arquivo de configuração a ser pesquisado quando path é um caminho de diretório.

Retornos

O objeto de workspace para um Azure Workspace do ML.

Tipo de retorno

get

Retornar um objeto de workspace para um Workspace do Azure Machine Learning.

Lançará uma exceção se o workspace não existir ou se os campos necessários não identificarem exclusivamente um workspace.

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

Parâmetros

name
<xref:str>

O nome do workspace a ser obter.

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 CLI do Azure padrão serão usadas ou a API solicitará credenciais.

subscription_id
<xref: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
<xref:str>
valor padrão: None

O grupo de recursos a ser usado. Se Nenhum, o método pesquisa todos os grupos de recursos na assinatura.

Retornos

O objeto do workspace.

Tipo de retorno

get_connection

Obter uma conexão do workspace.

get_connection(name)

Parâmetros

name
<xref:str>

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

type
<xref:str>

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

Retornos

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

Tipo de retorno

get_default_datastore

Obter o armazenamento de dados padrão para o workspace.

get_default_datastore()

Retornos

O armazenamento de dados padrão.

Tipo de retorno

get_default_keyvault

Obter o objeto do cofre de chaves padrão para o workspace.

get_default_keyvault()

Retornos

O objeto KeyVault associado ao workspace.

Tipo de retorno

get_details

Retornar os detalhes do workspace.

get_details()

Retornos

Detalhes do workspace no formato de dicionário.

Tipo de retorno

<xref:dict>[<xref:str>, <xref:str>]

Comentários

O dicionário retornado contém os pares chave-valor a seguir.

  • id: URI apontando para esse recurso de workspace, contendo a ID da assinatura, o grupo de recursos e o nome do workspace.

  • name: o nome desse workspace.

  • location: a região do workspace.

  • type: um URI do formato "{providerName}/workspaces".

  • tags: não usadas 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 esse workspace foi criado, no formato ISO8601.

  • containerRegistry: o registro de contêiner do workspace usado para efetuar pull e efetuar push de imagens de experimentação e serviços Web.

  • keyVault: o cofre de chaves do workspace usado para armazenar as 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 executar, código, logs etc.

  • sku: o SKU do workspace (também conhecido como edição). Para obter mais informações, consulte Azure Machine Learning SKUs.

  • resourceCmkUri: o URI de chave da chave gerenciada pelo cliente para criptografar os dados em repouso. Consulte para https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 obter 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 build de imagem.

  • systemDatastoresAuthMode: determina se as credenciais deverão ou não ser usadas para os armazenamentos de dados do sistema do workspace 'workspaceblobstore' e 'workspacefilestore'. O valor padrão é 'accessKey', nesse caso, o workspace criará os datastores do sistema com credenciais. Se definido como 'identity', o workspace criará os datastores 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 do MLflow para o workspace.

O MLflow ( https://mlflow.org/ ) é uma plataforma de código aberto para acompanhar experimentos de machine learning e gerenciar modelos. Você pode usar APIs de log do MLflow com Azure Machine Learning para que métricas, modelos e artefatos sejam registrados no workspace Azure Machine Learning.

get_mlflow_tracking_uri(_with_auth=False)

Parâmetros

_with_auth
<xref:bool>
valor padrão: False

(PRETERIDO) Adicione informações de auth ao URI de acompanhamento.

Retornos

O URI de acompanhamento compatível com MLflow.

Tipo de retorno

<xref:str>

Comentários

Use o exemplo a seguir para configurar o acompanhamento do MLflow para enviar dados para o Azure Workspace do 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 executar com a run_id especificada no workspace.

get_run(run_id)

Parâmetros

run_id
string

A ID de executar.

Retornos

A executar enviada.

Tipo de retorno

Run

list

Liste todos os workspaces aos que o usuário tem acesso dentro da assinatura.

A lista de workspaces pode ser filtrada com base no grupo de recursos.

list(subscription_id, auth=None, resource_group=None)

Parâmetros

subscription_id
<xref:str>

A ID da assinatura para a qual listar workspaces.

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 CLI do Azure padrão serão usadas ou a API solicitará credenciais.

resource_group
<xref:str>
valor padrão: None

Um grupo de recursos para filtrar os workspaces retornados. Se Nenhum, o método lista todos os workspaces dentro da assinatura especificada.

Retornos

Um dicionário em que a chave é o nome do workspace e o valor é uma lista de objetos do Workspace.

Tipo de retorno

<xref:dict>

list_connections

Listar conexões nesse workspace.

list_connections(category=None, target=None)

Parâmetros

type
<xref:str>
valor padrão: None

O tipo dessa conexão em que será filtrado

target
<xref:str>
valor padrão: None

o destino dessa conexão em que será filtrado

list_keys

Listar chaves para o espaço de trabalho atual.

list_keys()

Tipo de retorno

<xref:object>

set_connection

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

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

Parâmetros

name
<xref:str>

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

category
<xref:str>

A categoria desta conexão

target
<xref:str>

o destino ao qual essa conexão se conecta

authType
<xref:str>

o tipo de autorização desta conexão

value
<xref: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
<xref: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(no_wait=False)

Parâmetros

no_wait
<xref:bool>
valor padrão: False

Se deve aguardar a conclusão das chaves de sincronização do espaço de trabalho.

Retornos

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

Tipo de retorno

<xref:None>

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
<xref: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
<xref:str>
valor padrão: None

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

tags
<xref:dict>
valor padrão: None

Marcas a serem associadas ao espaço de trabalho.

image_build_compute
<xref: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
<xref: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
<xref: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

<xref:dict>[<xref:str>, <xref:str>]

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
<xref:str>
valor padrão: None

ID do ARM para o registro de contêiner.

force
<xref: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
<xref: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
<xref: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

<xref:dict>[<xref:str>, ComputeTarget]

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

<xref:dict>[<xref:str>, Dataset]

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

<xref:dict>[<xref:str>, Datastore]

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

<xref: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

<xref:dict>[<xref:str>, Ambiente]

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

<xref:dict>[<xref:str>, Experiment]

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

<xref:dict>[<xref:str>, Image]

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

<xref:dict>[<xref:str>, LinkedService]

location

Retornar o local deste espaço de trabalho.

Retornos

O local deste espaço de trabalho.

Tipo de retorno

<xref: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

<xref:dict>[<xref:str>, Model]

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

<xref: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

<xref:dict>[<xref:str>, PrivateEndPoint]

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

<xref: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

<xref:str>

subscription_id

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

Retornos

A ID da assinatura.

Tipo de retorno

<xref:str>

tags

Retornar as marcas deste espaço de trabalho.

Retornos

As marcas deste espaço de trabalho.

Tipo de retorno

<xref:dict>

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

<xref:dict>[<xref:str>, Webservice]

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'