Workspace Classe

Adicionar um ponto de extremidade privado a um workspace.

add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)

Parâmetros

Retornos

Criar um novo Workspace do Azure Machine Learning.

Gera uma exceção se o workspace já existe ou nenhum dos requisitos do workspace não é atendido.

static create(name, auth=None, subscription_id=None, resource_group=None, location=None, create_resource_group=True, sku='basic', tags=None, friendly_name=None, storage_account=None, key_vault=None, app_insights=None, container_registry=None, adb_workspace=None, primary_user_assigned_identity=None, cmk_keyvault=None, resource_cmk_uri=None, hbi_workspace=False, default_cpu_compute_target=None, default_gpu_compute_target=None, private_endpoint_config=None, private_endpoint_auto_approval=True, exist_ok=False, show_output=True, user_assigned_identity_for_cmk_encryption=None, system_datastores_auth_mode='accessKey', v1_legacy_mode=None)

Parâmetros

Retornos

Exceções

Comentários

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

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

O exemplo a seguir mostra como reutilizar os recursos existentes do Azure utilizando o formato da ID do recurso do Azure. As IDs específicas do recurso do Azure podem ser recuperadas por meio do SDK ou do Portal do Azure. Isso pressupõe que o grupo de recursos, a conta de armazenamento, o cofre de chaves, o App Insights e o registro de contêiner já existem.

   import os
   from azureml.core import Workspace
   from azureml.core.authentication import ServicePrincipalAuthentication

   service_principal_password = os.environ.get("AZUREML_PASSWORD")

   service_principal_auth = ServicePrincipalAuthentication(
       tenant_id="<tenant-id>",
       username="<application-id>",
       password=service_principal_password)

   ws = Workspace.create(name='myworkspace',
                         auth=service_principal_auth,
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=False,
                         location='eastus2',
                         friendly_name='My workspace',
                         storage_account='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.storage/storageaccounts/mystorageaccount',
                         key_vault='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault',
                         app_insights='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.insights/components/myappinsights',
                         container_registry='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.containerregistry/registries/mycontainerregistry',
                         exist_ok=False)

Excluir os recursos associados ao Workspace do Azure Machine Learning.

delete(delete_dependent_resources=False, no_wait=False)

Parâmetros

Retornos

Excluir uma conexão do workspace.

delete_connection(name)

Parâmetros

Excluir a conexão do ponto de extremidade privado com o workspace.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parâmetros

Diagnosticar problemas de instalação do workspace.

diagnose_workspace(diagnose_parameters)

Parâmetros

Retornos

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

Lê a configuração do workspace de um arquivo. Gera uma exceção caso o arquivo de configuração não seja encontrado.

O método fornece uma maneira simples de reutilizar o mesmo workspace em vários notebooks ou projetos do Python. Os usuários podem salvar as propriedades do ARM (Azure Resource Manager) do workspace usando o método write_config e usar esse método para carregar o mesmo workspace em diferentes notebooks ou projetos do Python sem digitar novamente as propriedades do ARM do workspace.

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

Parâmetros

Retornos

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

Gera uma exceção caso o workspace não exista ou os campos obrigatórios não identifiquem exclusivamente um workspace.

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

Parâmetros

Retornos

Obter uma conexão do workspace.

get_connection(name)

Parâmetros

Obter o destino de computação padrão para o workspace.

get_default_compute_target(type)

Parâmetros

Retornos

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

get_default_datastore()

Retornos

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

get_default_keyvault()

Retornos

Retornar os detalhes do workspace.

get_details()

Retornos

Comentários

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

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

• name: o nome deste workspace.

• location: a região do workspace.

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

• tags: não usado no momento.

• workspaceid: a ID deste workspace.

• description: não usado no momento.

• friendlyName: um nome amigável para o workspace exibido na interface do usuário.

• creationTime: hora em que este workspace foi criado, no formato ISO8601.

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

• keyVault: o cofre de chaves do workspace usado para armazenar credenciais adicionadas ao workspace pelos usuários.

• applicationInsights: o Application Insights será usado pelo workspace para registrar eventos de serviços Web.

• identityPrincipalId:

• identityTenantId

• identityType

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

• sku: o SKU do workspace (também conhecido como edição). O parâmetro está presente para compatibilidade com versões anteriores e é ignorado.

• resourceCmkUri: o URI da chave gerenciada pelo cliente para criptografar dados inativos. Consulte https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 para obter as etapas sobre como criar uma chave e obter seu URI.

• hbiWorkspace: especifica se os dados do cliente são de alto impacto nos negócios.

• imageBuildCompute: o destino de computação para a compilação da imagem.

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

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

Obter o URI de acompanhamento de MLflow para o workspace.

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

get_mlflow_tracking_uri(_with_auth=False)

Parâmetros

Retornos

Comentários

Use o exemplo a seguir para configurar o acompanhamento de MLflow para enviar dados para o Workspace do Azure ML:

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

Retornar a execução com o run_id especificado no workspace.

get_run(run_id)

Parâmetros

Retornos

Listar todos os workspaces aos quais o usuário tem acesso na assinatura.

A lista de workspaces pode ser filtrada de acordo com o grupo de recursos.

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

Parâmetros

Retornos

Listar conexões neste workspace.

list_connections(category=None, target=None)

Parâmetros

Listar chaves do workspace atual.

list_keys()

Retornos

Adicionar ou atualizar uma conexão no workspace.

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

Parâmetros

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

set_default_datastore(name)

Parâmetros

Criar um novo workspace ou recuperar um existente.

static setup()

Retornos

Dispara o workspace para sincronizar as chaves imediatamente.

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

sync_keys(no_wait=False)

Parâmetros

Retornos

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

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

Parâmetros

Retornos

Atualizar os recursos associados existentes para o workspace nos casos a seguir.

a) Quando um usuário exclui acidentalmente um recurso associado existente e gostaria de atualizá-lo com um novo sem precisar recriar o workspace inteiro. b) Quando um usuário tem um recurso associado existente e deseja substituir o atual que está associado ao workspace. c) Quando um recurso associado ainda não foi criado e o usuário precisa usar um existente que já tenha (aplica-se somente ao registro de contêiner).

update_dependencies(container_registry=None, force=False)

Parâmetros

Retornos

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

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

O método fornece uma maneira simples de reutilizar o mesmo workspace em vários notebooks ou projetos do Python. Os usuários podem salvar as propriedades do ARM do workspace usando esta função e usar from_config para carregar o mesmo workspace em diferentes notebooks ou projetos do Python sem digitar novamente as propriedades do ARM do workspace.

write_config(path=None, file_name=None)

Parâmetros

Listar todos os destinos de computação no workspace.

Retornos

Listar todos os conjuntos de dados no workspace.

Retornos

Listar todos os armazenamentos de dados no workspace. Essa operação não retorna credenciais dos armazenamentos de dados.

Retornos

Retornar a URL de descoberta deste workspace.

Retornos

Listar todos os ambientes no workspace.

Retornos

Listar todos os experimentos no workspace.

Retornos

Retornar a lista de imagens no workspace.

Gera um WebserviceException caso haja um problema ao interagir com o serviço de gerenciamento de modelos.

Retornos

Exceções

Listar todos os serviços vinculados no workspace.

Retornos

Retornar a localização deste workspace.

Retornos

Retornar uma lista de modelos no workspace.

Gera um WebserviceException caso haja um problema ao interagir com o serviço de gerenciamento de modelos.

Retornos

Exceções

Retornar o nome do workspace.

Retornos

Listar todos os pontos de extremidade privados do workspace.

Retornos

Retornar o nome do grupo de recursos para este workspace.

Retornos

Retornar o contexto de serviço deste workspace.

Retornos

Retornar o SKU deste workspace.

Retornos

Retornar a ID da assinatura para este workspace.

Retornos

Retornar as marcas deste workspace.

Retornos

Retornar uma lista de serviços Web no workspace.

Gera um WebserviceException caso haja um problema ao retornar a lista.

Retornos

Exceções

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

DEFAULT_CPU_CLUSTER_NAME = 'cpu-cluster'

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

DEFAULT_GPU_CLUSTER_NAME = 'gpu-cluster'