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


Workspace Класс

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

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

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

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

Конструктор

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. Если нет, будут использоваться учетные данные 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. Если нет, будут использоваться учетные данные 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

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

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

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. Если нет, будут использоваться учетные данные 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. Хранилище будет использоваться рабочей областью для сохранения выходных данных, кода, журналов и т. д. Если нет, будет создана новая учетная запись хранения.

Default value: None
key_vault
str

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

Default value: None
app_insights
str

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

Default value: None
container_registry
str

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

Default value: None
adb_workspace
str

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

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'. Ознакомьтесь с https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal инструкциями по созданию ключа и получении URI.

Default value: None
hbi_workspace

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

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

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

Default value: False
default_cpu_compute_target

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

Default value: None
default_gpu_compute_target

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

Default value: None
private_endpoint_config

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

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 в общедоступной службе Azure Resource Manager

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. Предполагается, что группа ресурсов, учетная запись хранения, хранилище ключей, App 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

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

Default value: False
no_wait

Дождитесь завершения удаления рабочей области.

Default value: False

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

Тип Описание

Нет в случае успешного выполнения; в противном случае вызывает ошибку.

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. Если нет, будут использоваться учетные данные Azure CLI по умолчанию или API будет запрашивать учетные данные.

Default value: None
_logger

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

Default value: None
_file_name
str

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

Default value: None

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

Тип Описание

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

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статье . Если нет, будут использоваться учетные данные Azure CLI по умолчанию или API будет запрашивать учетные данные.

Default value: None
subscription_id
str

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

Default value: None
resource_group
str

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

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

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

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

Тип Описание

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

get_default_datastore

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

get_default_datastore()

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

Тип Описание

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

get_default_keyvault

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

get_default_keyvault()

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

Тип Описание

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

get_details

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

get_details()

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

Тип Описание

Сведения о рабочей области в формате словаря.

Комментарии

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

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

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

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

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

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

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

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

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

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

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

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

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

  • identityPrincipalId:

  • identityTenantId

  • identityType

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

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

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

  • 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:


   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статье . Если нет, будут использоваться учетные данные Azure CLI по умолчанию или API будет запрашивать учетные данные.

Default value: None
resource_group
str

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

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

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

Тип Описание

Нет в случае успешного выполнения; в противном случае вызывает ошибку.

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 в общедоступной службе Azure Resource Manager

Default value: None

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

Тип Описание

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

update_dependencies

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

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

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'