Workspace Classe

Define um recurso Azure Machine Learning para a gestão de artefactos de formação e implantação.

Um Espaço de Trabalho é um recurso fundamental para a aprendizagem automática em Azure Machine Learning. Usa-se um espaço de trabalho para experimentar, treinar e implementar modelos de aprendizagem automática. Cada espaço de trabalho está ligado a um grupo de subscrição e recursos Azure, 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, _cloud='AzureCloud')

Parâmetros

subscription_id
<xref:str>

O ID de assinatura Azure contendo o espaço de trabalho.

resource_group
<xref:str>

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

workspace_name
<xref:str>

O nome do espaço de trabalho existente.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication ou MsiAuthentication

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

_location
<xref:str>

Uso interno apenas.

_disable_service_check
<xref:bool>

Uso interno apenas.

_workspace_id
<xref:str>

Uso interno apenas.

sku
<xref:str>

O parâmetro está presente para retrocompatibilidade e é ignorado. Para mais informações consulte Azure Machine Learning SKUs.

_cloud
<xref:str>

Uso interno apenas.

Observações

A amostra que se segue 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'
               )

Definir create_resource_group para Falso se tiver um grupo de recursos Azure existente que pretende utilizar para o espaço de trabalho.

Para utilizar o mesmo espaço de trabalho em vários ambientes, crie um ficheiro de configuração JSON. O ficheiro de configuração guarda o nome de subscrição, recurso e espaço de trabalho para que possa ser facilmente carregado. Para guardar a configuração, utilize o write_config método.


   ws.write_config(path="./file-path", file_name="ws_config.json")

Consulte Criar um ficheiro de configuração do espaço de trabalho para um exemplo do ficheiro de configuração.

Para carregar o espaço de trabalho a partir do ficheiro de configuração, utilize o from_config método.


   ws = Workspace.from_config()
   ws.get_details()

Em alternativa, utilize o get método para carregar um espaço de trabalho existente sem utilizar ficheiros de configuração.


   ws = Workspace.get(name="myworkspace",
               subscription_id='<azure-subscription-id>',
               resource_group='myresourcegroup')

As amostras acima podem pedir-lhe credenciais de autenticação Azure usando um diálogo de login interativo. Para outros casos de utilização, incluindo a utilização do CLI Azure para autenticar e autenticar em fluxos de trabalho automatizados, consulte autenticação em Azure Machine Learning.

Métodos

add_private_endpoint

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

create

Criar um novo espaço de trabalho Azure Machine Learning.

Lança uma exceção se o espaço de trabalho já existe ou se qualquer um dos requisitos do espaço de trabalho não estiver satisfeito.

delete

Elimine os recursos associados Azure Machine Learning Workspace.

delete_connection

Elimine uma ligação do espaço de trabalho.

delete_private_endpoint_connection

Elimine a ligação do ponto final privado ao espaço de trabalho.

diagnose_workspace

Diagnosticar problemas de configuração do espaço de trabalho.

from_config

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

Lê a configuração do espaço de trabalho a partir de um ficheiro. Abre uma exceção se o ficheiro config não puder ser encontrado.

O método fornece uma forma simples de reutilizar o mesmo espaço de trabalho em vários cadernos ou projetos python. Os utilizadores podem guardar as propriedades do Workspace Azure Resource Manager (ARM) utilizando o write_config método, e usar este método para carregar o mesmo espaço de trabalho em diferentes cadernos ou projetos python sem revestir as propriedades ARM do espaço de trabalho.

get

Devolva um objeto de espaço de trabalho para um espaço de trabalho Azure Machine Learning existente.

Lança uma exceção se o espaço de trabalho não existe ou os campos necessários não identificarem exclusivamente um espaço de trabalho.

get_connection

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

get_default_compute_target

Obtenha o alvo de computação padrão para o espaço de trabalho.

get_default_datastore

Obtenha a datastore padrão para o espaço de trabalho.

get_default_keyvault

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

get_details

Devolva os detalhes do espaço de trabalho.

get_mlflow_tracking_uri

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

MLflow https://mlflow.org/ é uma plataforma de código aberto para rastrear experiências de machine learning e gestão de modelos. Pode utilizar APIs de registo de MLflow com Azure Machine Learning para que métricas, modelos e artefactos sejam registados no seu espaço de trabalho Azure Machine Learning.

get_run

Volte a correr com as run_id especificadas no espaço de trabalho.

list

Listar todos os espaços de trabalho a que o utilizador tem acesso dentro da subscrição.

A lista de espaços de trabalho pode ser filtrada com base no grupo de recursos.

list_connections

Listar ligações neste espaço de trabalho.

list_keys

Listar as chaves para o espaço de trabalho atual.

set_connection

Adicione ou atualize uma ligação no espaço de trabalho.

set_default_datastore

Desa estade a datastore predefinido para o espaço de trabalho.

setup

Criar um novo espaço de trabalho ou recuperar um espaço de trabalho existente.

sync_keys

Aciona o espaço de trabalho para sincronizar imediatamente as teclas.

Se as teclas de qualquer recurso no espaço de trabalho forem alteradas, pode levar cerca de uma hora para serem atualizadas automaticamente. Esta função permite que as chaves sejam atualizadas mediante pedido. Um cenário exemplo é a necessidade de acesso imediato ao armazenamento após a regeneração das chaves de armazenamento.

update

Atualizar nome amigável, descrição, tags, computação de construção de imagem e outras configurações associadas a um espaço de trabalho.

update_dependencies

Atualizar os recursos associados para o espaço de trabalho nos seguintes casos.

a) Quando um utilizador elimina acidentalmente um recurso associado existente e gostaria de atualizá-lo com um novo sem ter de recriar todo o espaço de trabalho. b) Quando um utilizador tem um recurso associado existente e quer substituir o atual que está associado ao espaço de trabalho. c) Quando um recurso associado ainda não tiver sido criado e pretender utilizar um existente que já tenha (só se aplica ao registo de contentores).

write_config

Escreva as propriedades do workspace Azure Resource Manager (ARM) num ficheiro config.

As propriedades ARM do espaço de trabalho podem ser carregadas mais tarde utilizando o from_config método. Os path incumprimentos de '.azureml/' no atual diretório de trabalho e file_name incumprimentos para "config.jsem frente".

O método fornece uma forma simples de reutilizar o mesmo espaço de trabalho em vários cadernos ou projetos python. Os utilizadores podem guardar as propriedades arm do espaço de trabalho usando esta função, e usar from_config para carregar o mesmo espaço de trabalho em diferentes cadernos python ou projetos sem reformular as propriedades arm do espaço de trabalho.

add_private_endpoint

Adicione um ponto final 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 final privado para criar um ponto final privado para o espaço de trabalho.

private_endpoint_auto_approval
<xref:bool>
valor predefinido: True

Uma bandeira booleana que denota se a criação do ponto final privado deve ser auto-aprovada ou aprovada manualmente a partir do Azure Private Link Center. Em caso de aprovação manual, os utilizadores podem visualizar o pedido pendente no portal Private Link para aprovar/rejeitar o pedido.

location
string
valor predefinido: None

Localização do ponto final privado, o padrão é a localização do espaço de trabalho

show_output
<xref:bool>
valor predefinido: True

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

tags
<xref:dict>
valor predefinido: None

Etiquetas para associar ao espaço de trabalho.

Devoluções

O objeto PrivateEndPoint criado.

Tipo de retorno

create

Criar um novo espaço de trabalho Azure Machine Learning.

Lança uma exceção se o espaço de trabalho já existe ou se qualquer um dos requisitos do espaço de trabalho não estiver satisfeito.

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 espaço de trabalho. O nome tem de ter entre 2 e 32 carateres. O primeiro carácter do nome deve ser alfanumérico (letra ou número), mas o resto do nome pode conter alfanuméricos, hífens e sublinhados. Whitespace não é permitido.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor predefinido: None

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

subscription_id
<xref:str>
valor predefinido: None

O ID de subscrição da assinatura contendo para o novo espaço de trabalho. O parâmetro é necessário se o utilizador tiver acesso a mais de uma subscrição.

resource_group
<xref:str>
valor predefinido: None

O grupo de recursos Azure que contém o espaço de trabalho. O parâmetro não tem mutação do nome do espaço de trabalho.

location
<xref:str>
valor predefinido: None

A localização do espaço de trabalho. O parâmetro é padrão para a localização do grupo de recursos. A localização tem de ser uma região apoiada para Azure Machine Learning.

create_resource_group
<xref:bool>
valor predefinido: True

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

sku
<xref:str>
valor predefinido: basic

O parâmetro está presente para retrocompatibilidade e é ignorado. Para mais informações consulte Azure Machine Learning SKUs.

tags
<xref:dict>
valor predefinido: None

Etiquetas para associar ao espaço de trabalho.

friendly_name
<xref:str>
valor predefinido: None

Um nome amigável opcional para o espaço de trabalho que pode ser exibido na UI.

storage_account
<xref:str>
valor predefinido: None

Uma conta de armazenamento existente no formato ID de recurso Azure. O armazenamento será utilizado pelo espaço de trabalho para poupar saídas, códigos, registos, etc. Se Nenhuma, será criada uma nova conta de armazenamento.

key_vault
<xref:str>
valor predefinido: None

Um cofre-chave existente no formato de ID de recurso Azure. Consulte o código de exemplo abaixo para obter mais detalhes sobre o formato de ID de recurso Azure. O cofre-chave será utilizado pelo espaço de trabalho para armazenar credenciais adicionadas ao espaço de trabalho pelos utilizadores. Se nenhum, um novo cofre-chave será criado.

app_insights
<xref:str>
valor predefinido: None

Uma aplicação existente Informações no formato ID de recurso Azure. Consulte o código de exemplo abaixo para obter mais detalhes sobre o formato de ID de recurso Azure. O Informações de aplicação será usado pelo espaço de trabalho para registar eventos de webservices. Se Nenhum, será criado um novo Informações de aplicação.

container_registry
<xref:str>
valor predefinido: None

Registo de contentores existente no formato ID de recurso Azure (ver código de exemplo abaixo para mais detalhes sobre o formato ID de recursos Azure). O registo do contentor será utilizado pelo espaço de trabalho para puxar e empurrar imagens de experimentação e serviços web. Se Nenhum, um novo registo de contentores só será criado quando necessário e não juntamente com a criação do espaço de trabalho.

adb_workspace
<xref:str>
valor predefinido: None

Um espaço de trabalho Adb existente no formato ID de recurso Azure (ver código de exemplo abaixo para mais detalhes sobre o formato ID de recursos Azure). O espaço de trabalho do Adb será usado para se ligar ao espaço de trabalho. Se nenhum, a ligação do espaço de trabalho não vai acontecer.

primary_user_assigned_identity
<xref:str>
valor predefinido: None

O id de recursos do utilizador atribuído identidade que costumava representar o espaço de trabalho

cmk_keyvault
<xref:str>
valor predefinido: None

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

resource_cmk_uri
<xref:str>
valor predefinido: None

A chave URI do cliente conseguiu a chave para encriptar os dados em repouso. O formato 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 passos sobre como criar uma chave e obter o seu URI.

hbi_workspace
<xref:bool>
valor predefinido: False

Especifica se o espaço de trabalho contém dados de Alto Impacto Empresarial (HBI), ou seja, contém informações confidenciais sobre negócios. Esta bandeira só pode ser colocada durante a criação do espaço de trabalho. O seu valor não pode ser alterado após a criação do espaço de trabalho. O valor predefinido é falso.

Quando definidos para True, são executados mais passos de encriptação, e dependendo do componente SDK, resulta em informações redigidas na telemetria recolhida internamente. Para obter mais informações, consulte a encriptação de dados.

Quando esta bandeira é definida para True, um possível impacto é o aumento das dificuldades na resolução de problemas. Isto pode acontecer porque alguma telemetria não é enviada para a Microsoft e há menos visibilidade em taxas de sucesso ou tipos de problemas, e, portanto, pode não ser capaz de reagir de forma tão proativa quando esta bandeira é Verdadeira. A recomendação é usar o padrão de Falso para esta bandeira, a menos que estritamente necessário para ser verdadeiro.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
valor predefinido: None

(PRECADO) Uma configuração que será usada para criar um computo CPU. O parâmetro não se deve a {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicado"} Se nenhum, nenhum cálculo será criado.

default_gpu_compute_target
AmlComputeProvisioningConfiguration
valor predefinido: None

(PRECADO) Uma configuração que será usada para criar um cálculo gpu. O parâmetro não se deve a {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicado"} Se nenhum, nenhum cálculo será criado.

private_endpoint_config
PrivateEndPointConfig
valor predefinido: None

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

private_endpoint_auto_approval
<xref:bool>
valor predefinido: True

Uma bandeira booleana que denota se a criação do ponto final privado deve ser auto-aprovada ou aprovada manualmente a partir do Azure Private Link Center. Em caso de aprovação manual, os utilizadores podem visualizar o pedido pendente no portal Private Link para aprovar/rejeitar o pedido.

exist_ok
<xref:bool>
valor predefinido: False

Indica se este método tem sucesso se o espaço de trabalho já existe. Se falso, este método falha se o espaço de trabalho existir. Se for verdade, este método devolve o espaço de trabalho existente se existir.

show_output
<xref:bool>
valor predefinido: True

Indica se este método irá imprimir progressos incrementais.

user_assigned_identity_for_cmk_encryption
<xref:str>
valor predefinido: None

O id de recursos da identidade atribuída ao utilizador que precisa de ser usado para aceder à chave de gestão do cliente

system_datastores_auth_mode
<xref:str>
valor predefinido: accessKey

Determina se deve ou não utilizar credenciais para as datas do sistema do espaço de trabalho 'workspaceblobstore' e 'workspacefilestore'. O valor padrão é 'accessKey', caso em que o espaço de trabalho criará as datas do sistema com credenciais. Se definido como 'identidade', o espaço de trabalho criará as datas do sistema sem credenciais.

Devoluções

O objeto do espaço de trabalho.

Tipo de retorno

Exceções

Criado para problemas de criação do espaço de trabalho.

Observações

Este primeiro exemplo requer apenas uma especificação mínima, e todos os recursos dependentes, bem como o grupo de recursos, serão criados automaticamente.


   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=True,
                         location='eastus2')

O exemplo a seguir mostra como reutilizar os recursos Azure existentes utilizando o formato de ID de recurso Azure. Os IDs específicos de recursos Azure podem ser recuperados através do Portal Azure ou SDK. Isto pressupõe que o grupo de recursos, a conta de armazenamento, o cofre-chave, a app Informações e o registo de contentores 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

Elimine os recursos associados Azure Machine Learning Workspace.

delete(delete_dependent_resources=False, no_wait=False)

Parâmetros

delete_dependent_resources
<xref:bool>
valor predefinido: False

Se eliminar os recursos associados ao espaço de trabalho, ou seja, o registo de contentores, a conta de armazenamento, o cofre-chave e os insights de aplicação. O padrão é falso. Definir para True para apagar estes recursos.

no_wait
<xref:bool>
valor predefinido: False

Se esperar que a eliminação do espaço de trabalho esteja completa.

Devoluções

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

Tipo de retorno

<xref:None>

delete_connection

Elimine uma ligação do espaço de trabalho.

delete_connection(name)

Parâmetros

name
<xref:str>

O nome único da conexão no espaço de trabalho

delete_private_endpoint_connection

Elimine a ligação do ponto final privado ao espaço de trabalho.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parâmetros

private_endpoint_connection_name
<xref:str>

O nome único da conexão de ponto final privado no espaço de trabalho

diagnose_workspace

Diagnosticar problemas de configuração do espaço de trabalho.

diagnose_workspace(diagnose_parameters)

Parâmetros

diagnose_parameters
<xref:_restclient.models.DiagnoseWorkspaceParameters>

O parâmetro do diagnóstico da saúde do espaço de trabalho

Devoluções

Um caso de AzureOperationPoller que devolve o DiagnoseResponseResult

Tipo de retorno

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

from_config

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

Lê a configuração do espaço de trabalho a partir de um ficheiro. Abre uma exceção se o ficheiro config não puder ser encontrado.

O método fornece uma forma simples de reutilizar o mesmo espaço de trabalho em vários cadernos ou projetos python. Os utilizadores podem guardar as propriedades do Workspace Azure Resource Manager (ARM) utilizando o write_config método, e usar este método para carregar o mesmo espaço de trabalho em diferentes cadernos ou projetos python sem revestir as propriedades ARM do espaço de trabalho.

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

Parâmetros

path
<xref:str>
valor predefinido: None

O caminho para o ficheiro config ou diretório inicial para pesquisar. O parâmetro não permite iniciar a pesquisa no diretório atual.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor predefinido: None

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

_logger
<xref:logging.Logger>
valor predefinido: None

Permite sobreprimir o madeireiro predefinido.

_file_name
<xref:str>
valor predefinido: None

Permite que o nome do ficheiro config procure quando o caminho é um caminho de diretório.

Devoluções

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

Tipo de retorno

get

Devolva um objeto de espaço de trabalho para um espaço de trabalho Azure Machine Learning existente.

Lança uma exceção se o espaço de trabalho não existe ou os campos necessários não identificarem exclusivamente um espaço de trabalho.

get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)

Parâmetros

name
<xref:str>

O nome do espaço de trabalho para obter.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor predefinido: None

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

subscription_id
<xref:str>
valor predefinido: None

O ID de assinatura para usar. O parâmetro é necessário se o utilizador tiver acesso a mais de uma subscrição.

resource_group
<xref:str>
valor predefinido: None

O grupo de recursos para usar. Se Nenhum, o método procurará todos os grupos de recursos na subscrição.

location
<xref:str>
valor predefinido: None

A localização do espaço de trabalho.

cloud
<xref:str>
valor predefinido: AzureCloud

O nome da nuvem-alvo. Pode ser um dos "AzureCloud", "AzureChinaCloud", ou "AzureUSGovernment". Se não for especificada nenhuma nuvem "AzureCloud".

id
<xref:str>
valor predefinido: None

A identificação do espaço de trabalho.

Devoluções

O objeto do espaço de trabalho.

Tipo de retorno

get_connection

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

get_connection(name)

Parâmetros

name
<xref:str>

O nome único da conexão no espaço de trabalho

get_default_compute_target

Obtenha o alvo de computação padrão para o espaço de trabalho.

get_default_compute_target(type)

Parâmetros

type
<xref:str>

O tipo de cálculo. Os valores possíveis são 'CPU' ou 'GPU'.

Devoluções

O alvo de computação padrão para determinado tipo de cálculo.

Tipo de retorno

get_default_datastore

Obtenha a datastore padrão para o espaço de trabalho.

get_default_datastore()

Devoluções

A loja de dados predefinido.

Tipo de retorno

get_default_keyvault

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

get_default_keyvault()

Devoluções

O objeto KeyVault associado ao espaço de trabalho.

Tipo de retorno

get_details

Devolva os detalhes do espaço de trabalho.

get_details()

Devoluções

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

Tipo de retorno

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

Observações

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

  • id: URI apontando para este recurso do espaço de trabalho, contendo ID de assinatura, grupo de recursos e nome do espaço de trabalho.

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

  • localização: A região do espaço de trabalho.

  • tipo: Um URI do formato "{providerName}/workspaces".

  • tags: Não utilizado atualmente.

  • workspaceid: A identificação deste espaço de trabalho.

  • descrição: Não atualmente utilizado.

  • friendlyName: Um nome amigável para o espaço de trabalho exibido na UI.

  • criaçãoTime: Tempo este espaço de trabalho foi criado, em formato ISO8601.

  • containerRegistry: O registo do contentor do espaço de trabalho utilizado para puxar e empurrar imagens de experimentação e serviços web.

  • keyVault: O cofre da chave do espaço de trabalho utilizado para armazenar credenciais adicionadas ao espaço de trabalho pelos utilizadores.

  • aplicaçõesInsights: O Informações de aplicação será utilizado pelo espaço de trabalho para registar eventos de webservices.

  • identidadePrincipalId:

  • identidadeTenantId

  • IdentidadeType

  • armazenamentoSA contagem: O armazenamento será utilizado pelo espaço de trabalho para poupar saídas de execução, código, registos, etc.

  • sku: O espaço de trabalho SKU (também referido como edição). Para mais informações consulte Azure Machine Learning SKUs.

  • recursoCmkUri: A chave URI do cliente geriu a chave para encriptar 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 passos sobre como criar uma chave e obter o seu URI.

  • hbiWorkspace: Especifica se os dados do cliente são de alto impacto no negócio.

  • imageBuildCompute: O alvo de computação para a construção de imagens.

  • systemDatastoresAuthMode: Determina se deve ou não utilizar credenciais para as datas do sistema das 'workspaceblobstore' e 'workspacefilestore'. O valor padrão é 'accessKey', caso em que o espaço de trabalho criará as datas do sistema com credenciais. Se definido como 'identidade', o espaço de trabalho criará as datas do sistema sem credenciais.

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

get_mlflow_tracking_uri

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

MLflow https://mlflow.org/ é uma plataforma de código aberto para rastrear experiências de machine learning e gestão de modelos. Pode utilizar APIs de registo de MLflow com Azure Machine Learning para que métricas, modelos e artefactos sejam registados no seu espaço de trabalho Azure Machine Learning.

get_mlflow_tracking_uri(_with_auth=False)

Parâmetros

_with_auth
<xref:bool>
valor predefinido: False

(PRECADO) Adicione informações auth ao rastreio de URI.

Devoluções

O URI de rastreio compatível com mLflow.

Tipo de retorno

<xref:str>

Observações

Utilize a seguinte amostra para configurar o rastreio do MLflow para enviar dados para o espaço de trabalho Azure ML:


   import mlflow
   from azureml.core import Workspace
   workspace = Workspace.from_config()
   mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())

get_run

Volte a correr com as run_id especificadas no espaço de trabalho.

get_run(run_id)

Parâmetros

run_id
string

A identificação da corrida.

Devoluções

A corrida submetida.

Tipo de retorno

Run

list

Listar todos os espaços de trabalho a que o utilizador tem acesso dentro da subscrição.

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

O ID de subscrição para a lista de espaços de trabalho.

auth
ServicePrincipalAuthentication ou InteractiveLoginAuthentication
valor predefinido: None

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

resource_group
<xref:str>
valor predefinido: None

Um grupo de recursos para filtrar os espaços de trabalho devolvidos. Se Nenhum, o método listará todos os espaços de trabalho dentro da subscrição especificada.

Devoluções

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

Tipo de retorno

<xref:dict>

list_connections

Listar ligações neste espaço de trabalho.

list_connections(category=None, target=None)

Parâmetros

type
<xref:str>
valor predefinido: None

O tipo desta ligação que será filtrada

target
<xref:str>
valor predefinido: None

o alvo desta ligação que será filtrado em

list_keys

Listar as chaves para o espaço de trabalho atual.

list_keys()

Tipo de retorno

<xref:object>

set_connection

Adicione ou atualize uma ligação no espaço de trabalho.

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

Parâmetros

name
<xref:str>

O nome único da conexão no espaço de trabalho

category
<xref:str>

A categoria desta ligação

target
<xref:str>

o alvo esta ligação liga-se a

authType
<xref:str>

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

value
<xref:str>

a cadeia de serialização do formato json dos detalhes da ligação

set_default_datastore

Desa estade a datastore predefinido para o espaço de trabalho.

set_default_datastore(name)

Parâmetros

name
<xref:str>

O nome do Datastore a definir como padrão.

setup

Criar um novo espaço de trabalho ou recuperar um espaço de trabalho existente.

setup()

Devoluções

Um objeto do espaço de trabalho.

Tipo de retorno

sync_keys

Aciona o espaço de trabalho para sincronizar imediatamente as teclas.

Se as teclas de qualquer recurso no espaço de trabalho forem alteradas, pode levar cerca de uma hora para serem atualizadas automaticamente. Esta função permite que as chaves sejam atualizadas mediante pedido. Um cenário 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 predefinido: False

Se esperar que as teclas de sincronização do espaço de trabalho sejam completadas.

Devoluções

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

Tipo de retorno

<xref:None>

update

Atualizar nome amigável, descrição, tags, computação de construção de imagem e outras configurações associadas a um espaço de trabalho.

update(friendly_name=None, description=None, tags=None, image_build_compute=None, service_managed_resources_settings=None, primary_user_assigned_identity=None, allow_public_access_when_behind_vnet=None)

Parâmetros

friendly_name
<xref:str>
valor predefinido: None

Um nome amigável para o espaço de trabalho que pode ser exibido na UI.

description
<xref:str>
valor predefinido: None

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

tags
<xref:dict>
valor predefinido: None

Etiquetas para associar ao espaço de trabalho.

image_build_compute
<xref:str>
valor predefinido: None

O nome computacional para a construção de imagem.

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

O serviço geriu as definições de recursos.

primary_user_assigned_identity
<xref:str>
valor predefinido: None

O utilizador atribuiu o id de recursos de identidade que representa a identidade do espaço de trabalho.

allow_public_access_when_behind_vnet
<xref:bool>
valor predefinido: None

Permitir o acesso público ao espaço de trabalho de ligação privada.

Devoluções

Um dicionário de informação atualizada.

Tipo de retorno

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

update_dependencies

Atualizar os recursos associados para o espaço de trabalho nos seguintes casos.

a) Quando um utilizador elimina acidentalmente um recurso associado existente e gostaria de atualizá-lo com um novo sem ter de recriar todo o espaço de trabalho. b) Quando um utilizador tem um recurso associado existente e quer substituir o atual que está associado ao espaço de trabalho. c) Quando um recurso associado ainda não tiver sido criado e pretender utilizar um existente que já tenha (só se aplica ao registo de contentores).

update_dependencies(container_registry=None, force=False)

Parâmetros

container_registry
<xref:str>
valor predefinido: None

IDENTIFICAÇÃO DA ARM para o registo do contentor.

force
<xref:bool>
valor predefinido: False

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

write_config

Escreva as propriedades do workspace Azure Resource Manager (ARM) num ficheiro config.

As propriedades ARM do espaço de trabalho podem ser carregadas mais tarde utilizando o from_config método. Os path incumprimentos de '.azureml/' no atual diretório de trabalho e file_name incumprimentos para "config.jsem frente".

O método fornece uma forma simples de reutilizar o mesmo espaço de trabalho em vários cadernos ou projetos python. Os utilizadores podem guardar as propriedades arm do espaço de trabalho usando esta função, e usar from_config para carregar o mesmo espaço de trabalho em diferentes cadernos python ou projetos sem reformular as propriedades arm do espaço de trabalho.

write_config(path=None, file_name=None)

Parâmetros

path
<xref:str>
valor predefinido: None

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

file_name
<xref:str>
valor predefinido: None

Nome a utilizar para o ficheiro config. O parâmetro não config.js.

Atributos

compute_targets

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

Devoluções

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

Tipo de retorno

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

datasets

Listar todos os conjuntos de dados no espaço de trabalho.

Devoluções

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

Tipo de retorno

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

datastores

Listar todas as datas-lojas no espaço de trabalho. Esta operação não devolve credenciais das datas-lojas.

Devoluções

Um dicionário com chave como nome de datastore e valor como Datastore objeto.

Tipo de retorno

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

discovery_url

Devolva o URL de descoberta deste espaço de trabalho.

Devoluções

A URL de descoberta deste espaço de trabalho.

Tipo de retorno

<xref:str>

environments

Listar todos os ambientes no espaço de trabalho.

Devoluções

Um dicionário com chave como nome ambiental e valor como Ambiente objeto.

Tipo de retorno

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

experiments

Lista todas as experiências no espaço de trabalho.

Devoluções

Um dicionário com chave como nome de experiência e valor como Experiment objeto.

Tipo de retorno

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

images

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

Levanta um WebserviceException problema se houvesse um problema interagindo com o serviço de gestão de modelos.

Devoluções

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

Tipo de retorno

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

Exceções

Houve um problema em interagir com o serviço de gestão de modelos.

linked_services

Listar todos os serviços ligados no espaço de trabalho.

Devoluções

Um dicionário onde a chave é um nome de serviço e valor ligados é um LinkedService objeto.

Tipo de retorno

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

location

Devolva a localização deste espaço de trabalho.

Devoluções

A localização deste espaço de trabalho.

Tipo de retorno

<xref:str>

models

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

Levanta um WebserviceException problema se houvesse um problema interagindo com o serviço de gestão de modelos.

Devoluções

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

Tipo de retorno

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

Exceções

Houve um problema em interagir com o serviço de gestão de modelos.

name

Devolva o nome do espaço de trabalho.

Devoluções

O nome do espaço de trabalho.

Tipo de retorno

<xref:str>

private_endpoints

Listar todos os pontos finais privados do espaço de trabalho.

Devoluções

Um dict de objetos PrivateEndPoint associados ao espaço de trabalho. A chave é o nome do ponto final privado.

Tipo de retorno

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

resource_group

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

Devoluções

O nome do grupo de recursos.

Tipo de retorno

<xref:str>

service_context

Devolva o contexto de serviço para este espaço de trabalho.

Devoluções

Devolve o objeto ServiceContext.

Tipo de retorno

<xref:azureml._restclient.service_context.ServiceContext>

sku

Devolva o SKU deste espaço de trabalho.

Devoluções

O SKU deste espaço de trabalho.

Tipo de retorno

<xref:str>

subscription_id

Devolva o ID de assinatura para este espaço de trabalho.

Devoluções

O ID da assinatura.

Tipo de retorno

<xref:str>

tags

Devolva as Etiquetas deste espaço de trabalho.

Devoluções

As etiquetas deste espaço de trabalho.

Tipo de retorno

<xref:dict>

webservices

Devolva uma lista de serviços web no espaço de trabalho.

Levanta um WebserviceException se houvesse um problema de devolver a lista.

Devoluções

Uma lista de serviços web no espaço de trabalho.

Tipo de retorno

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

Exceções

Houve um problema em devolver a lista.

DEFAULT_CPU_CLUSTER_CONFIGURATION

DEFAULT_CPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_CPU_CLUSTER_NAME

DEFAULT_CPU_CLUSTER_NAME = 'cpu-cluster'

DEFAULT_GPU_CLUSTER_CONFIGURATION

DEFAULT_GPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_GPU_CLUSTER_NAME

DEFAULT_GPU_CLUSTER_NAME = 'gpu-cluster'