Workspace Classe

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

Retornos

Crie um novo workspace do Azure Machine Learning.

Gerará uma exceção se o workspace já existir ou se qualquer um dos requisitos do workspace não estiver satisfeito.

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

Exclua os recursos associados ao Workspace do Azure Machine Learning.

delete(delete_dependent_resources=False, no_wait=False)

Parâmetros

Retornos

Exclua uma conexão do workspace.

delete_connection(name)

Parâmetros

Exclua a conexão de 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 existente do Azure Machine Learning.

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

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

Parâmetros

Retornos

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

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

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

Parâmetros

Retornos

Obtenha uma conexão do workspace.

get_connection(name)

Parâmetros

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

get_default_compute_target(type)

Parâmetros

Retornos

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

get_default_datastore()

Retornos

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

get_default_keyvault()

Retornos

Retorne os detalhes do workspace.

get_details()

Retornos

Comentários

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

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

• nome: o nome deste workspace.

• local: a região do workspace.

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

• marcas: não usadas no momento.

• workspaceid: a ID deste workspace.

• descrição: 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 efetuar push de imagens de experimentação e webservices.

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

• systemDatastoresAuthMode: determina se deve ou não usar credenciais 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 'identidade', o workspace criará os repositórios de dados do sistema sem credenciais.

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

Obtenha o URI de acompanhamento do MLflow para o workspace.

O MLflow (https://mlflow.org/) é uma plataforma de software livre para acompanhar experimentos de machine learning e gerenciar modelos. Você pode usar APIs de registro em log do MLflow com o Azure Machine Learning para que métricas, modelos e artefatos sejam registrados no 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 do 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())

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

get_run(run_id)

Parâmetros

Retornos

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

A lista de workspaces pode ser filtrada com base no 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 para o workspace atual.

list_keys()

Retornos

Adicione ou atualize uma conexão no workspace.

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

Parâmetros

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

set_default_datastore(name)

Parâmetros

Crie um novo workspace ou recupere um workspace existente.

static setup()

Retornos

Dispara o workspace para sincronizar imediatamente as chaves.

Se as chaves de qualquer recurso no workspace forem alteradas, poderá 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 depois de regenerar chaves de armazenamento.

sync_keys(no_wait=False)

Parâmetros

Retornos

Atualizar nome amigável, descrição, marcas, computação de build de 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

Atualize os recursos associados para o workspace nos casos a seguir.

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

update_dependencies(container_registry=None, force=False)

Parâmetros

Retornos

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

As propriedades arm do workspace podem ser carregadas posteriormente usando o from_config método. O path padrão é '.azureml/' no diretório de trabalho atual e file_name usa como padrão 'config.json'.

O método fornece uma maneira simples de reutilização do mesmo workspace em vários notebooks ou projetos do Python. Os usuários podem salvar as propriedades arm do workspace usando essa função e usar from_config para carregar o mesmo workspace em diferentes blocos de anotações ou projetos do Python sem redigir as propriedades arm do workspace.

write_config(path=None, file_name=None)

Parâmetros

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

Retornos

Liste todos os conjuntos de dados no workspace.

Retornos

Liste todos os repositórios de dados no workspace. Essa operação não retorna credenciais dos armazenamentos de dados.

Retornos

Retorne a URL de descoberta deste workspace.

Retornos

Listar todos os ambientes no workspace.

Retornos

Liste todos os experimentos no workspace.

Retornos

Retorne a lista de imagens no workspace.

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

Retornos

Exceções

Liste todos os serviços vinculados no workspace.

Retornos

Retorne o local deste workspace.

Retornos

Retorne uma lista de modelos no workspace.

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

Retornos

Exceções

Retorne o nome do workspace.

Retornos

Listar todos os pontos de extremidade privados do workspace.

Retornos

Retorne o nome do grupo de recursos para este workspace.

Retornos

Retorne o contexto de serviço para este workspace.

Retornos

Retorne a SKU deste workspace.

Retornos

Retorne a ID da assinatura para este workspace.

Retornos

Retorne as marcas deste workspace.

Retornos

Retorne uma lista de serviços Web no workspace.

Gera um WebserviceException 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'