Поделиться через


Workspace Класс

Определяет ресурс Машинного обучения Azure для управления артефактами обучения и развертывания.

Рабочая область — это фундаментальный ресурс для машинного обучения в Машинном обучении Azure. Рабочая область используется для экспериментов, обучения и развертывания моделей машинного обучения. Каждая рабочая область связана с подпиской Azure и группой ресурсов и имеет соответствующий номер SKU.

Дополнительные сведения о рабочих областях приведены в статьях:

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

Наследование
builtins.object
Workspace

Конструктор

Workspace(subscription_id, resource_group, workspace_name, auth=None, _location=None, _disable_service_check=False, _workspace_id=None, sku='basic', tags=None, _cloud='AzureCloud')

Параметры

Имя Описание
subscription_id
Обязательно
str

Идентификатор подписки Azure, содержащий рабочую область.

resource_group
Обязательно
str

Группа ресурсов, содержащая рабочую область.

workspace_name
Обязательно
str

Имя существующей рабочей области.

auth

Объект проверки подлинности. Дополнительные сведения см. по адресу https://aka.ms/aml-notebook-auth. Если задано значение None (Нет), будут использоваться учетные данные Azure CLI по умолчанию или API запросит учетные данные.

Default value: None
_location
str

Только для внутреннего использования.

Default value: None
_disable_service_check

Только для внутреннего использования.

Default value: False
_workspace_id
str

Только для внутреннего использования.

Default value: None
sku
str

Имеется параметр для обеспечения обратной совместимости, но он игнорируется.

Default value: basic
_cloud
str

Только для внутреннего применения.

Default value: AzureCloud
subscription_id
Обязательно
str

Идентификатор подписки Azure, содержащий рабочую область.

resource_group
Обязательно
str

Группа ресурсов, содержащая рабочую область.

workspace_name
Обязательно
str

Имя рабочей области. Количество символов в имени должно быть от 2 до 32.) Первый символ имени должен быть буквой или цифрой, все остальные символы могут быть буквами, цифрами, дефисами или символами подчеркивания. Использовать пробелы нельзя.

auth
Обязательно

Объект проверки подлинности. Дополнительные сведения см. по адресу https://aka.ms/aml-notebook-auth. Если задано значение None (Нет), будут использоваться учетные данные Azure CLI по умолчанию или API запросит учетные данные.

_location
Обязательно
str

Только для внутреннего использования.

_disable_service_check
Обязательно

Только для внутреннего использования.

_workspace_id
Обязательно
str

Только для внутреннего использования.

sku
Обязательно
str

Имеется параметр для обеспечения обратной совместимости, но он игнорируется.

tags

Теги для связывания с рабочей областью.

Default value: None
_cloud
Обязательно
str

Только для внутреннего применения.

Комментарии

В следующем примере показано, как создать рабочую область.


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

Задайте для параметра create_resource_group значение False, если у вас уже есть группа ресурсов Azure, которую вы хотите использовать для этой рабочей области.

Чтобы использовать одну и ту же рабочую область в нескольких средах, создайте файл конфигурации JSON. Файл конфигурации сохраняет подписку, ресурс и имя рабочей области, чтобы их можно было легко загрузить. Чтобы сохранить конфигурацию, используйте метод write_config.


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

Пример файла конфигурации см. в статье Создание файла конфигурации рабочей области.

Чтобы загрузить рабочую область из файла конфигурации, используйте метод from_config.


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

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


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

В приведенных выше примерах у вас могут запросить учетные данные для проверки подлинности Azure с помощью интерактивного диалогового окна входа. Другие варианты использования, включая применение Azure CLI для проверки подлинности и проверку подлинности в автоматизированных рабочих процессах, см. в статье Проверка подлинности в Машинном обучении Azure.

Методы

add_private_endpoint

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

create

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

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

delete

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

delete_connection

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

delete_private_endpoint_connection

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

diagnose_workspace

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

from_config

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

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

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

get

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

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

get_connection

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

get_default_compute_target

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

get_default_datastore

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

get_default_keyvault

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

get_details

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

get_mlflow_tracking_uri

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

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

get_run

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

list

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

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

list_connections

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

list_keys

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

set_connection

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

set_default_datastore

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

setup

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

sync_keys

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

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

update

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

update_dependencies

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

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

write_config

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

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

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

add_private_endpoint

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

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

Параметры

Имя Описание
private_endpoint_config
Обязательно

Конфигурация частной конечной точки для создания частной конечной точки в рабочей области.

private_endpoint_auto_approval

Логический флаг, определяющий, как следует утверждать создание частной конечной точки из Центра Приватного канала Azure: автоматически или вручную. В случае утверждения вручную пользователи могут просмотреть ожидающий запрос на портале Приватного канала, чтобы его утвердить или отклонить.

Default value: True
location

Расположение частной конечной точки; по умолчанию — расположение рабочей области

Default value: None
show_output

Флаг для отображения хода создания рабочей области

Default value: True
tags

Теги для связывания с рабочей областью.

Default value: None

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

Тип Описание

Созданный объект PrivateEndPoint.

create

Создает новую рабочую область машинного обучения 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)

Параметры

Имя Описание
name
Обязательно
str

Имя новой рабочей области. Количество символов в имени должно быть от 2 до 32.) Первый символ имени должен быть буквой или цифрой, все остальные символы могут быть буквами, цифрами, дефисами или символами подчеркивания. Использовать пробелы нельзя.

auth

Объект проверки подлинности. Дополнительные сведения см. по адресу https://aka.ms/aml-notebook-auth. Если задано значение None (Нет), будут использоваться учетные данные Azure CLI по умолчанию или API запросит учетные данные.

Default value: None
subscription_id
str

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

Default value: None
resource_group
str

Группа ресурсов Azure, которая содержит рабочую область. По умолчанию для параметра указывается вариация имени рабочей области.

Default value: None
location
str

Расположение рабочей области. По умолчанию для параметра указывается расположение группы ресурсов. В качестве расположения должен использоваться поддерживаемый регион Машинного обучения Azure.

Default value: None
create_resource_group

Указывает, создавать ли группу ресурсов, если она не существует.

Default value: True
sku
str

Имеется параметр для обеспечения обратной совместимости, но он игнорируется.

Default value: basic
tags

Теги для связывания с рабочей областью.

Default value: None
friendly_name
str

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

Default value: None
storage_account
str

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

Default value: None
key_vault
str

Существующее хранилище ключей в формате идентификатора ресурса Azure. Подробные сведения о формате идентификатора ресурса Azure см. в примере кода ниже. Хранилище ключей будет использоваться рабочей областью для хранения учетных данных, добавляемых пользователями в рабочую область. Если задано значение None (Нет), будет создано новое хранилище ключей.

Default value: None
app_insights
str

Существующий компонент Application Insights в формате идентификатора ресурса Azure. Подробные сведения о формате идентификатора ресурса Azure см. в примере кода ниже. Application Insights будет использоваться рабочей областью для регистрации событий веб-служб. Если задано значение None (Нет), будет создана новая служба Application Insights.

Default value: None
container_registry
str

Существующий реестр контейнеров в формате идентификатора ресурса Azure. (Подробные сведения о формате идентификатора ресурса Azure см. в примере кода ниже.) Реестр контейнеров будет использоваться рабочей областью для извлечения и отправки образов экспериментов и веб-служб. Если задано значение None (Нет), будет создан новый реестр контейнеров, но только при необходимости и не при создании рабочей области.

Default value: None
adb_workspace
str

Существующая рабочая область ADB в формате идентификатора ресурса Azure. (Подробные сведения о формате идентификатора ресурса Azure см. в примере кода ниже.) Рабочая область ADB будет использоваться для связи с рабочей областью. Если задано значение None (Нет), связывание с рабочей областью не произойдет.

Default value: None
primary_user_assigned_identity
str

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

Default value: None
cmk_keyvault
str

Хранилище ключей, содержащее управляемый клиентом ключ в формате идентификатора ресурса Azure: /subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name>Например: /subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault. Подробные сведения о формате идентификатора ресурса Azure см. в примере кода ниже в разделе "Комментарии".

Default value: None
resource_cmk_uri
str

Универсальный код ресурса (URI) ключа, управляемого клиентом, для шифрования неактивных данных. Формат URI: https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Например, https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b. Инструкции по созданию ключа и получению его URI см. в разделе https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal.

Default value: None
hbi_workspace

Указывает, содержит ли рабочая область данные о высокой степени влияния на бизнес (HBI), т. е. конфиденциальную бизнес-информацию. Этот флаг можно задать только во время создания рабочей области. Его значение нельзя изменить после создания рабочей области. Значение по умолчанию равно False.

Если задано значение True, будут выполнены дальнейшие действия по шифрованию и, в зависимости от компонента пакета SDK, показаны исправленные данные телеметрии, собранные внутри системы. Дополнительные сведения см. в статье Шифрование данных.

Если для этого флага задано значение True, процесс устранение неполадок может осложниться. Это может произойти по той причине, что некоторые телеметрические данные не отправляются в корпорацию Майкрософт. Соответственно, у нее меньше сведений о частоте успешных выполнений и типах проблем, и она не всегда может реагировать с упреждением, если для этого флага задано значение True. Если значение True не является обязательным, рекомендуется использовать для этого флага значение по умолчанию False.

Default value: False
default_cpu_compute_target

(НЕ РЕКОМЕНДУЕТСЯ.) Конфигурация, которая будет использоваться для создания вычислительных ресурсов ЦП. Параметр по умолчанию имеет значение {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Если задано значение None (Нет), то вычисление не будет создано.

Default value: None
default_gpu_compute_target

(НЕ РЕКОМЕНДУЕТСЯ.) Конфигурация, которая будет использоваться для создания вычислительных ресурсов GPU. Параметр по умолчанию имеет значение {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Если задано значение None (Нет), то вычисление не будет создано.

Default value: None
private_endpoint_config

Конфигурация частной конечной точки для создания частной конечной точки в рабочей области Azure ML.

Default value: None
private_endpoint_auto_approval

Логический флаг, определяющий, как следует утверждать создание частной конечной точки из Центра Приватного канала Azure: автоматически или вручную. В случае утверждения вручную пользователи могут просмотреть ожидающий запрос на портале Приватного канала, чтобы его утвердить или отклонить.

Default value: True
exist_ok

Указывает, будет ли этот метод эффективен, если рабочая область уже существует. Если задано значение False, этот метод завершится ошибкой, если рабочая область существует. Если задано значение True, этот метод возвратит существующую рабочую область, если она существует.

Default value: False
show_output

Указывает, будет ли этот метод выводить ход выполнения поэтапно.

Default value: True
user_assigned_identity_for_cmk_encryption
str

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

Default value: None
system_datastores_auth_mode
str

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

Default value: accessKey
v1_legacy_mode

Запрет использования службы API версии 2 в общедоступной Resource Manager Azure

Default value: 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)

delete

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

delete(delete_dependent_resources=False, no_wait=False)

Параметры

Имя Описание
delete_dependent_resources

Указывает, нужно ли удалять ресурсы, связанные с рабочей областью, а именно реестр контейнеров, учетную запись хранения, хранилище ключей и Application Insights. Значение по умолчанию — False. Установите значение True, чтобы удалить эти ресурсы.

Default value: False
no_wait

Указывает, нужно ли ждать, когда закончится удаление рабочей области.

Default value: False

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

Тип Описание

В случае успешного выполнения выдается None (Нет); в противном случае генерируется ошибка.

delete_connection

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

delete_connection(name)

Параметры

Имя Описание
name
Обязательно
str

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

delete_private_endpoint_connection

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

delete_private_endpoint_connection(private_endpoint_connection_name)

Параметры

Имя Описание
private_endpoint_connection_name
Обязательно
str

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

diagnose_workspace

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

diagnose_workspace(diagnose_parameters)

Параметры

Имя Описание
diagnose_parameters
Обязательно
<xref:_restclient.models.DiagnoseWorkspaceParameters>

Параметр диагностики работоспособности рабочей области

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

Тип Описание
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]

Экземпляр AzureOperationPoller, который возвращает DiagnoseResponseResult

from_config

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

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

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

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

Параметры

Имя Описание
path
str

Путь к файлу конфигурации или начальному каталогу для поиска. По умолчанию для этого параметра задается начало поиска в текущем каталоге.

Default value: None
auth

Объект проверки подлинности. Дополнительные сведения см. по адресу https://aka.ms/aml-notebook-auth. Если задано значение None (Нет), будут использоваться учетные данные Azure CLI по умолчанию или API запросит учетные данные.

Default value: None
_logger

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

Default value: None
_file_name
str

Позволяет переопределять имя искомого файла конфигурации, если путь является путем к каталогу.

Default value: None

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

Тип Описание

Объект рабочей области для существующей рабочей области Azure ML.

get

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

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

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

Параметры

Имя Описание
name
Обязательно
str

Имя рабочей области, которое нужно получить.

auth

Объект проверки подлинности. Дополнительные сведения см. по ссылке https://aka.ms/aml-notebook-auth. Если задано значение None (Нет), будут использоваться учетные данные Azure CLI по умолчанию, или API запросит учетные данные.

Default value: None
subscription_id
str

Идентификатор подписки, который следует использовать. Параметр является обязательным, если пользователю доступно несколько подписок.

Default value: None
resource_group
str

Группа ресурсов, которую следует использовать. Если задано значение None (Нет), метод будет искать все группы ресурсов в подписке.

Default value: None
location
str

Расположение рабочей области.

Default value: None
cloud
str

Имя целевого облака. Возможные значения: AzureCloud, AzureChinaCloud или AzureUSGovernment. Если облако не указано, используется AzureCloud.

Default value: AzureCloud
id
str

Идентификатор рабочей области.

Default value: None

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

Тип Описание

Объект рабочей области.

get_connection

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

get_connection(name)

Параметры

Имя Описание
name
Обязательно
str

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

get_default_compute_target

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

get_default_compute_target(type)

Параметры

Имя Описание
type
Обязательно
str

Тип вычисления. Возможные значения: CPU или GPU.

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

Тип Описание

Целевой объект вычислений по умолчанию для заданного типа вычисления.

get_default_datastore

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

get_default_datastore()

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

Тип Описание

Хранилище данных по умолчанию.

get_default_keyvault

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

get_default_keyvault()

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

Тип Описание

Объект KeyVault, связанный с рабочей областью.

get_details

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

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.

get_mlflow_tracking_uri

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

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

get_mlflow_tracking_uri(_with_auth=False)

Параметры

Имя Описание
_with_auth

(НЕ РЕКОМЕНДУЕТСЯ) Добавляет сведения о проверке подлинности в URI отслеживания.

Default value: False

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

Тип Описание
str

URI отслеживания, совместимый с MLflow.

Комментарии

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


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

get_run

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

get_run(run_id)

Параметры

Имя Описание
run_id
Обязательно

Идентификатор запуска.

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

Тип Описание
Run

Отправленный запуск.

list

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

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

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

Параметры

Имя Описание
subscription_id
Обязательно
str

Идентификатор подписки, для которой требуется список рабочих областей.

auth

Объект проверки подлинности. Дополнительные сведения см. по ссылке https://aka.ms/aml-notebook-auth. Если задано значение None (Нет), будут использоваться учетные данные Azure CLI по умолчанию, или API запросит учетные данные.

Default value: None
resource_group
str

Группа ресурсов для фильтрации возвращенных рабочих областей. Если задано значение None (Нет), метод выведет список всех рабочих областей в указанной подписке.

Default value: None

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

Тип Описание

Словарь, где ключ — это имя рабочей области, а значение — список объектов рабочей области.

list_connections

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

list_connections(category=None, target=None)

Параметры

Имя Описание
type
Обязательно
str

Тип подключения, по которому будет выполняться фильтрация

target
str

Целевой объект подключения, по которому будет выполняться фильтрация

Default value: None
category
Default value: None

list_keys

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

list_keys()

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

Тип Описание

set_connection

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

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

Параметры

Имя Описание
name
Обязательно
str

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

category
Обязательно
str

Категория этого подключения

target
Обязательно
str

целевой объект, к которому осуществляется это подключение

authType
Обязательно
str

тип авторизации этого подключения

value
Обязательно
str

строка сериализации в формате JSON для сведений о подключении

set_default_datastore

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

set_default_datastore(name)

Параметры

Имя Описание
name
Обязательно
str

Имя Datastore, которое нужно задать по умолчанию.

setup

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

static setup()

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

Тип Описание

Объект рабочей области.

sync_keys

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

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

sync_keys(no_wait=False)

Параметры

Имя Описание
no_wait

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

Default value: False

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

Тип Описание

В случае успешного выполнения выдается None (Нет); в противном случае генерируется ошибка.

update

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

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)

Параметры

Имя Описание
friendly_name
str

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

Default value: None
description
str

Описание рабочей области.

Default value: None
tags

Теги для связывания с рабочей областью.

Default value: None
image_build_compute
str

Имя вычисления для сборки образа.

Default value: None
service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>

Параметры ресурсов, управляемых службой.

Default value: None
primary_user_assigned_identity
str

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

Default value: None
allow_public_access_when_behind_vnet

Разрешение общего доступа к рабочей области приватного канала.

Default value: None
v1_legacy_mode

Запрет использования службы API версии 2 в общедоступной Resource Manager Azure

Default value: None

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

Тип Описание

Словарь обновленных сведений.

update_dependencies

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

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

update_dependencies(container_registry=None, force=False)

Параметры

Имя Описание
container_registry
str

Идентификатор ARM для реестра контейнеров.

Default value: None
force

При принудительном обновлении зависимых ресурсов без запроса подтверждения.

Default value: False

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

Тип Описание

write_config

Записывает свойства 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)

Параметры

Имя Описание
path
str

Заданное пользователем расположение для записи файла config.json. Параметр по умолчанию имеет значение .azureml/ в текущем рабочем каталоге.

Default value: None
file_name
str

Имя, которое нужно использовать для файла конфигурации. Параметр по умолчанию имеет значение config.json.

Default value: None

Атрибуты

compute_targets

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

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

Тип Описание

Словарь с ключом в качестве имени целевого объекта вычислений и значением в качестве объекта ComputeTarget.

datasets

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

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

Тип Описание

Словарь с ключом в качестве имени набора данных и значением в качестве объекта Dataset.

datastores

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

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

Тип Описание

Словарь с ключом в качестве имени хранилища данных и значением в качестве объекта Datastore.

discovery_url

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

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

Тип Описание
str

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

environments

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

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

Тип Описание

Словарь с ключом в качестве имени среды и значением в качестве объекта Environment.

experiments

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

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

Тип Описание

Словарь с ключом в качестве имени эксперимента и значением в качестве объекта Experiment.

images

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

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

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

Тип Описание

Словарь с ключом в качестве имени образа и значением в качестве объекта Image.

Исключения

Тип Описание

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

linked_services

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

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

Тип Описание

Словарь, где ключом является имя связанной службы, а значением — объект LinkedService.

location

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

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

Тип Описание
str

Расположение этой рабочей области.

models

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

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

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

Тип Описание

Словарь модели с ключом в качестве имени модели и значением в качестве объекта Model.

Исключения

Тип Описание

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

name

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

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

Тип Описание
str

Имя рабочей области.

private_endpoints

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

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

Тип Описание

Словарь объектов PrivateEndPoint, связанных с рабочей областью. Ключ — это имя частной конечной точки.

resource_group

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

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

Тип Описание
str

Имя группы ресурсов.

service_context

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

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

Тип Описание
<xref:azureml._restclient.service_context.ServiceContext>

Возвращает объект ServiceContext.

sku

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

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

Тип Описание
str

Номер SKU этой рабочей области.

subscription_id

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

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

Тип Описание
str

Идентификатор подписки.

tags

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

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

Тип Описание

Теги этой рабочей области.

webservices

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

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

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

Тип Описание

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

Исключения

Тип Описание

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

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'