Workspace Класс

Добавляет частную конечную точку в рабочую область.

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

Параметры

Возвращаемое значение

Создает новую рабочую область машинного обучения Azure.

Выдает исключение, если рабочая область уже существует или не выполняются какие-либо требования к рабочей области.

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)

Параметры

Возвращаемое значение

Исключения

Комментарии

В первом примере требуется только минимальная спецификация, а все зависимые ресурсы, как и группа ресурсов, будут созданы автоматически.

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

В следующем примере показано, как повторно использовать существующие ресурсы Azure, применяя формат идентификатора ресурса Azure. Конкретные идентификаторы ресурсов Azure можно получить на портале Azure или в пакете SDK. В этом примере предполагается, что группа ресурсов, учетная запись хранения, хранилище ключей, Application Insights и реестр контейнеров уже существуют.

   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)

Удаляет ресурсы, связанные с рабочей областью машинного обучения Azure.

delete(delete_dependent_resources=False, no_wait=False)

Параметры

Возвращаемое значение

Удаляет подключение рабочей области.

delete_connection(name)

Параметры

Удаляет подключение к частной конечной точке в рабочей области.

delete_private_endpoint_connection(private_endpoint_connection_name)

Параметры

Диагностика проблем установки рабочей области.

diagnose_workspace(diagnose_parameters)

Параметры

Возвращаемое значение

Возвращает объект рабочей области из существующей рабочей области машинного обучения Azure.

Считывает конфигурацию рабочей области из файла. Выдает исключение, если не удается найти файл конфигурации.

Этот метод предоставляет простой способ повторного использования одной и той же рабочей области в нескольких записных книжках или проектах Python. Пользователи могут сохранять свойства Azure Resource Manager (ARM) рабочей области с помощью метода write_config и использовать этот метод для загрузки одной и той же рабочей области в разные записные книжки или проекты Python без повторного ввода свойств ARM рабочей области.

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

Параметры

Возвращаемое значение

Возвращает объект рабочей области для имеющейся рабочей области машинного обучения Azure.

Создает исключение, если рабочая область не существует или обязательные поля не позволяют однозначно ее идентифицировать.

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

Параметры

Возвращаемое значение

Получает сведения о подключении рабочей области.

get_connection(name)

Параметры

Получает целевой объект вычислений по умолчанию для рабочей области.

get_default_compute_target(type)

Параметры

Возвращаемое значение

Получает хранилище данных по умолчанию для рабочей области.

get_default_datastore()

Возвращаемое значение

Получает объект хранилища ключей по умолчанию для рабочей области.

get_default_keyvault()

Возвращаемое значение

Возврат сведений о рабочей области.

get_details()

Возвращаемое значение

Комментарии

Возвращаемый словарь содержит следующие пары "ключ-значение".

• id: универсальный код ресурса (URI), указывающий на этот ресурс рабочей области, содержащий идентификатор подписки, группу ресурсов и имя рабочей области.

• name: имя этой рабочей области.

• location: регион рабочей области.

• type: универсальный код ресурса (URI) в формате "{название_поставщика_услуг}/workspaces".

• tags: в настоящее время не используется.

• workspaceid: идентификатор этой рабочей области.

• description: в настоящее время не используется.

• friendlyName: понятное имя рабочей области, отображаемое в пользовательском интерфейсе.

• creationTime: время создания этой рабочей области в формате ISO8601.

• containerRegistry: реестр контейнеров рабочей области, используемый для извлечения и отправки образов экспериментов и веб-служб.

• keyVault: хранилище ключей рабочей области, используемое для хранения учетных данных, добавляемых пользователями в рабочую область.

• applicationInsights: Application Insights будет использоваться рабочей областью для регистрации событий веб-служб.

• identityPrincipalId:

• identityTenantId

• identityType

• storageAccount: хранилище будет использоваться рабочей областью для сохранения выходных данных выполнения, кодов, журналов и т. д.

• sku: номер SKU рабочей области (также называется выпуском). Имеется параметр для обеспечения обратной совместимости, но он игнорируется.

• resourceCmkUri: универсальный код ресурса (URI) ключа, управляемого клиентом, для шифрования неактивных данных. Инструкции по созданию ключа и получению его URI см. в разделе https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910.

• hbiWorkspace: указывает, обладают ли данные клиента высокой степенью влияния на бизнес.

• imageBuildCompute: целевой объект вычислений для сборки образа.

• systemDatastoresAuthMode: определяет, следует ли использовать учетные данные для системных хранилищ данных workspaceblobstore и workspacefilestore рабочей области. Значение по умолчанию — accessKey. В этом случае рабочая область создаст системные хранилища данных с учетными данными. Если задано значение identity, рабочая область создаст системные хранилища данных без учетных данных.

Дополнительные сведения об этих парах "ключ-значение" см. в разделе create.

Получает URI отслеживания MLflow для рабочей области.

MLflow (https://mlflow.org/) — это платформа с открытым исходным кодом для отслеживания экспериментов машинного обучения и управления моделями. API ведения журналов MLflow можно использовать с Машинным обучением Azure, чтобы метрики, модели и артефакты фиксировались в рабочей области машинного обучения Azure.

get_mlflow_tracking_uri(_with_auth=False)

Параметры

Возвращаемое значение

Комментарии

Используйте следующий пример, чтобы настроить отслеживание MLflow для отправки данных в рабочую область Azure ML.

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

Возвращает запуск с указанным run_id в рабочей области.

get_run(run_id)

Параметры

Возвращаемое значение

Список всех рабочих областей, к которым у пользователя есть доступ в рамках подписки.

Список рабочих областей можно фильтровать по группе ресурсов.

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

Параметры

Возвращаемое значение

Список подключений в этой рабочей области.

list_connections(category=None, target=None)

Параметры

Список ключей для текущей рабочей области.

list_keys()

Возвращаемое значение

Добавляет или обновляет подключение в рабочей области.

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

Параметры

Задает хранилище данных по умолчанию для рабочей области.

set_default_datastore(name)

Параметры

Создает новую или получает имеющуюся рабочую область.

static setup()

Возвращаемое значение

Активирует рабочую область для немедленной синхронизации ключей.

В случае изменения ключей для любого ресурса в рабочей области их автоматическое обновление может занять около часа. Эта функция позволяет обновлять ключи по запросу. В примере сценария требуется немедленный доступ к хранилищу после повторного создания ключей хранилища.

sync_keys(no_wait=False)

Параметры

Возвращаемое значение

Обновление понятного имени, описания, тегов, вычисления сборки образа и других параметров, связанных с рабочей областью.

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)

Параметры

Возвращаемое значение

Обновляет существующие связанные ресурсы для рабочей области в следующих случаях.

а) Если пользователь случайно удаляет существующий связанный ресурс и хочет обновить его, используя новый ресурс, но не создавая заново всю рабочую область. б) Если у пользователя есть связанный ресурс и он хочет заменить текущий ресурс, связанный с рабочей областью. в) Если связанный ресурс еще не создан и нужно использовать уже имеющийся ресурс (применяется только к реестру контейнеров).

update_dependencies(container_registry=None, force=False)

Параметры

Возвращаемое значение

Записывает свойства Azure Resource Manager (ARM) рабочей области в файл конфигурации.

Свойства ARM рабочей области можно загрузить позже с помощью метода from_config. По умолчанию параметр path имеет значение .azureml/ в текущем рабочем каталоге, а параметр file_name — config.json.

Этот метод предоставляет простой способ повторного использования одной и той же рабочей области в нескольких записных книжках или проектах Python. Пользователи могут сохранять свойства ARM рабочей области с помощью этой функции и использовать from_config для загрузки одной и той же рабочей области в разные записные книжки или проекты Python без повторного ввода свойств ARM рабочей области.

write_config(path=None, file_name=None)

Параметры

Список всех целевых объектов вычислений в рабочей области.

Возвращаемое значение

Список всех наборов данных в рабочей области.

Возвращаемое значение

Список всех хранилищ данных в рабочей области. Эта операция не возвращает учетные данные хранилищ данных.

Возвращаемое значение

Возвращает URL-адрес обнаружения этой рабочей области.

Возвращаемое значение

Список всех сред рабочей области.

Возвращаемое значение

Список всех экспериментов рабочей области.

Возвращаемое значение

Возвращает список образов рабочей области.

Выдает WebserviceException, если возникает проблема при взаимодействии со службой управления моделями.

Возвращаемое значение

Исключения

Список всех связанных служб в рабочей области.

Возвращаемое значение

Возвращает расположения этой рабочей области.

Возвращаемое значение

Возвращает список модели в рабочей области.

Выдает WebserviceException, если возникает проблема при взаимодействии со службой управления моделями.

Возвращаемое значение

Исключения

Возвращает имя рабочей области.

Возвращаемое значение

Список всех частных конечных точек рабочей области.

Возвращаемое значение

Возвращает имя группы ресурсов для этой рабочей области.

Возвращаемое значение

Возвращает контекст службы для этой рабочей области.

Возвращаемое значение

Возвращает номер SKU этой рабочей области.

Возвращаемое значение

Возвращает идентификатор подписки для этой рабочей области.

Возвращаемое значение

Возвращает теги этой рабочей области.

Возвращаемое значение

Возвращает список веб-служб рабочей области.

Выдает WebserviceException, если возникает проблема с возвратом списка.

Возвращаемое значение

Исключения

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'