Workspace Класс

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

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

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

Наследование
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)

Параметры

subscription_id
<xref:str>

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

resource_group
<xref:str>

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

workspace_name
<xref:str>

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

auth
ServicePrincipalAuthentication или InteractiveLoginAuthentication или мсиаусентикатион

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

_location
<xref:str>

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

_disable_service_check
<xref:bool>

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

_workspace_id
<xref:str>

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

sku
<xref:str>

Параметр имеется для обеспечения обратной совместимости и игнорируется. Дополнительные сведения см. в разделе машинное обучение Azure SKU.

Комментарии

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


   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

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

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) отслеживания Млфлов для рабочей области.

Млфлов ( https://mlflow.org/ ) — это платформа с открытым исходным кодом для отслеживания экспериментов машинного обучения и управления моделями. API-интерфейсы ведения журнала Млфлов можно использовать с Машинное обучение 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.jsв".

Метод предоставляет простой способ повторного использования одной и той же рабочей области в нескольких записных книжках и проектах 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
PrivateEndPointConfig

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

private_endpoint_auto_approval
<xref:bool>
значение по умолчанию: True

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

location
string
значение по умолчанию: None

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

show_output
<xref:bool>
значение по умолчанию: True

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

tags
<xref:dict>
значение по умолчанию: None

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

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

Созданный объект Приватиндпоинт.

Возвращаемый тип

create

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

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

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

Параметры

name
<xref:str>

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

auth
ServicePrincipalAuthentication или InteractiveLoginAuthentication
значение по умолчанию: None

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

subscription_id
<xref:str>
значение по умолчанию: None

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

resource_group
<xref:str>
значение по умолчанию: None

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

location
<xref:str>
значение по умолчанию: None

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

create_resource_group
<xref:bool>
значение по умолчанию: True

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

sku
<xref:str>
значение по умолчанию: basic

Параметр имеется для обеспечения обратной совместимости и игнорируется. Дополнительные сведения см. в разделе машинное обучение Azure SKU.

tags
<xref:dict>
значение по умолчанию: None

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

friendly_name
<xref:str>
значение по умолчанию: None

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

storage_account
<xref:str>
значение по умолчанию: None

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

key_vault
<xref:str>
значение по умолчанию: None

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

app_insights
<xref:str>
значение по умолчанию: None

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

container_registry
<xref:str>
значение по умолчанию: None

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

adb_workspace
<xref:str>
значение по умолчанию: None

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

primary_user_assigned_identity
<xref:str>
значение по умолчанию: None

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

cmk_keyvault
<xref:str>
значение по умолчанию: None

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

resource_cmk_uri
<xref:str>
значение по умолчанию: None

Универсальный код ресурса (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 см. в разделе.

hbi_workspace
<xref:bool>
значение по умолчанию: False

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

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

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

default_cpu_compute_target
AmlComputeProvisioningConfiguration
значение по умолчанию: None

НЕ рекомендуется Конфигурация, которая будет использоваться для создания вычислительных ресурсов ЦП. Параметр по умолчанию имеет значение {min_nodes = 0, max_nodes = 2, vm_size = "STANDARD_DS2_V2", vm_priority = "выделенный"} Если нет, то вычисление не будет создано.

default_gpu_compute_target
AmlComputeProvisioningConfiguration
значение по умолчанию: None

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

private_endpoint_config
PrivateEndPointConfig
значение по умолчанию: None

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

private_endpoint_auto_approval
<xref:bool>
значение по умолчанию: True

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

exist_ok
<xref:bool>
значение по умолчанию: False

Указывает, проходит ли этот метод, если Рабочая область уже существует. Если задано значение false, этот метод завершается ошибкой, если Рабочая область существует. Если значение — true, этот метод возвращает существующую рабочую область, если она существует.

show_output
<xref:bool>
значение по умолчанию: True

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

user_assigned_identity_for_cmk_encryption
<xref:str>
значение по умолчанию: None

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

system_datastores_auth_mode
<xref:str>
значение по умолчанию: accessKey

Определяет, следует ли использовать учетные данные для системных хранилищ данных рабочей области "воркспацеблобсторе" и "воркспацефилесторе". Значение по умолчанию — "accessKey". в этом случае Рабочая область создаст системные хранилища данных с учетными данными. Если задано значение "Identity", Рабочая область создаст системные хранилища данных без учетных записей.

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

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

Возвращаемый тип

Исключения

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

Комментарии

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


   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,
                         sku='enterprise')

delete

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

delete(delete_dependent_resources=False, no_wait=False)

Параметры

delete_dependent_resources
<xref:bool>
значение по умолчанию: False

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

no_wait
<xref:bool>
значение по умолчанию: False

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

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

Нет, если успешно. в противном случае выдает ошибку.

Возвращаемый тип

<xref:None>

delete_connection

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

delete_connection(name)

Параметры

name
<xref:str>

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

delete_private_endpoint_connection

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

delete_private_endpoint_connection(private_endpoint_connection_name)

Параметры

private_endpoint_connection_name
<xref:str>

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

from_config

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

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

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

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

Параметры

path
<xref:str>
значение по умолчанию: None

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

auth
ServicePrincipalAuthentication или InteractiveLoginAuthentication
значение по умолчанию: None

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

_logger
<xref:logging.Logger>
значение по умолчанию: None

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

_file_name
<xref:str>
значение по умолчанию: None

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

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

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

Возвращаемый тип

get

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

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

get(name, auth=None, subscription_id=None, resource_group=None)

Параметры

name
<xref:str>

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

auth
ServicePrincipalAuthentication или InteractiveLoginAuthentication
значение по умолчанию: None

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

subscription_id
<xref:str>
значение по умолчанию: None

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

resource_group
<xref:str>
значение по умолчанию: None

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

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

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

Возвращаемый тип

get_connection

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

get_connection(name)

Параметры

name
<xref:str>

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

get_default_compute_target

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

get_default_compute_target(type)

Параметры

type
<xref:str>

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

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

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

Возвращаемый тип

get_default_datastore

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

get_default_datastore()

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

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

Возвращаемый тип

get_default_keyvault

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

get_default_keyvault()

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

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

Возвращаемый тип

get_details

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

get_details()

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, <xref:str>]

Комментарии

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

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

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

  • Location— регион рабочей области.

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

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

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

  • Описание: сейчас не используется.

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

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

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

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

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

  • идентитипринЦипалид:

  • идентититенантид

  • identityType

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

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

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

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

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

  • системдатасторесаусмоде: определяет, следует ли использовать учетные данные для системных хранилищ данных рабочей области "воркспацеблобсторе" и "воркспацефилесторе". Значение по умолчанию — "accessKey". в этом случае Рабочая область создаст системные хранилища данных с учетными данными. Если задано значение "Identity", Рабочая область создаст системные хранилища данных без учетных записей.

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

get_mlflow_tracking_uri

Получите универсальный код ресурса (URI) отслеживания Млфлов для рабочей области.

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

get_mlflow_tracking_uri(_with_auth=False)

Параметры

_with_auth
<xref:bool>
значение по умолчанию: False

НЕ рекомендуется Добавьте сведения о проверке подлинности в URI отслеживания.

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

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

Возвращаемый тип

<xref:str>

Комментарии

Используйте следующий пример, чтобы настроить отслеживание Млфлов для отправки данных в рабочую область машинного обучения 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
string

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

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

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

Возвращаемый тип

Run

list

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

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

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

Параметры

subscription_id
<xref:str>

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

auth
ServicePrincipalAuthentication или InteractiveLoginAuthentication
значение по умолчанию: None

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

resource_group
<xref:str>
значение по умолчанию: None

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

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

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

Возвращаемый тип

<xref:dict>

list_connections

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

list_connections(category=None, target=None)

Параметры

type
<xref:str>
значение по умолчанию: None

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

target
<xref:str>
значение по умолчанию: None

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

list_keys

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

list_keys()

Возвращаемый тип

<xref:object>

set_connection

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

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

Параметры

name
<xref:str>

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

category
<xref:str>

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

target
<xref:str>

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

authType
<xref:str>

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

value
<xref:str>

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

set_default_datastore

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

set_default_datastore(name)

Параметры

name
<xref:str>

Имя объекта, Datastore устанавливаемое по умолчанию.

setup

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

setup()

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

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

Возвращаемый тип

sync_keys

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

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

sync_keys(no_wait=False)

Параметры

no_wait
<xref:bool>
значение по умолчанию: False

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

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

Нет, если успешно. в противном случае выдает ошибку.

Возвращаемый тип

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

Параметры

friendly_name
<xref:str>
значение по умолчанию: None

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

description
<xref:str>
значение по умолчанию: None

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

tags
<xref:dict>
значение по умолчанию: None

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

image_build_compute
<xref:str>
значение по умолчанию: None

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

service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
значение по умолчанию: None

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

primary_user_assigned_identity
<xref:str>
значение по умолчанию: None

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

allow_public_access_when_behind_vnet
<xref:bool>
значение по умолчанию: None

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, <xref:str>]

update_dependencies

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

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

update_dependencies(container_registry=None, force=False)

Параметры

container_registry
<xref:str>
значение по умолчанию: None

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

force
<xref:bool>
значение по умолчанию: False

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

write_config

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

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

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

write_config(path=None, file_name=None)

Параметры

path
<xref:str>
значение по умолчанию: None

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

file_name
<xref:str>
значение по умолчанию: None

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

Атрибуты

compute_targets

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, ComputeTarget]

datasets

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, Dataset]

datastores

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, Datastore]

discovery_url

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

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

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

Возвращаемый тип

<xref:str>

environments

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, Среда]

experiments

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, Experiment]

images

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

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, Image]

Исключения

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

linked_services

Перечислите все связанные службы в рабочей области.

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, LinkedService]

location

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

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

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

Возвращаемый тип

<xref:str>

models

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

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, Model]

Исключения

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

name

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

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

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

Возвращаемый тип

<xref:str>

private_endpoints

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, PrivateEndPoint]

resource_group

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

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

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

Возвращаемый тип

<xref:str>

service_context

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

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

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

Возвращаемый тип

<xref:azureml._restclient.service_context.ServiceContext>

sku

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

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

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

Возвращаемый тип

<xref:str>

subscription_id

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

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

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

Возвращаемый тип

<xref:str>

tags

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

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

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

Возвращаемый тип

<xref:dict>

webservices

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

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

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

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

Возвращаемый тип

<xref:dict>[<xref:str>, Webservice]

Исключения

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

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'