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

MLClient Класс

  • Ссылка

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

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

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

Конструктор

MLClient(credential: TokenCredential, subscription_id: str | None = None, resource_group_name: str | None = None, workspace_name: str | None = None, registry_name: str | None = None, **kwargs: Any)

Параметры

credential
TokenCredential
Обязательно

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

subscription_id
Optional[str]
значение по умолчанию: None

Идентификатор подписки Azure. Необязательный параметр только для ресурсов реестра. Значение по умолчанию — None (Нет).

resource_group_name
Optional[str]
значение по умолчанию: None

Группа ресурсов Azure. Необязательный параметр только для ресурсов реестра. Значение по умолчанию — None (Нет).

workspace_name
Optional[str]
значение по умолчанию: None

Рабочая область, используемая в клиенте. Необязательный параметр только для операций, которые не зависят от рабочей области. Значение по умолчанию — None (Нет).

registry_name
Optional[str]
значение по умолчанию: None

Реестр, используемый в клиенте. Необязательный параметр только для операций, которые не зависят от рабочей области. Значение по умолчанию — None (Нет).

show_progress
Optional[bool]

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

enable_telemetry
Optional[bool]

Указывает, следует ли включать телеметрию. В Jupyter Notebook будет переопределено значение False. По умолчанию имеет значение True, если в Jupyter Notebook.

cloud
Optional[str]

Используемое имя облака. Значение по умолчанию — "AzureCloud".

Примеры

При использовании независимых доменов (т. е. любого облака, отличного от AZURE_PUBLIC_CLOUD), необходимо передать имя облака в kwargs и использовать центр с DefaultAzureCredential.


   from azure.ai.ml import MLClient
   from azure.identity import AzureAuthorityHosts, DefaultAzureCredential

   kwargs = {"cloud": "AzureChinaCloud"}
   ml_client = MLClient(
       subscription_id=subscription_id,
       resource_group_name=resource_group,
       credential=DefaultAzureCredential(authority=AzureAuthorityHosts.AZURE_CHINA),
       **kwargs,
   )

Методы

begin_create_or_update

Асинхронно создает или обновляет ресурс Машинного обучения Azure.
create_or_update

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

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

Этот метод предоставляет простой способ повторного использования одной рабочей области в нескольких записных книжках Или проектах Python. Свойства azure Resource Manager (ARM) рабочей области можно сохранить в файле конфигурации JSON в следующем формате:


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

Затем этот метод можно использовать для загрузки одной и той же рабочей области в разные записные книжки или проекты Python без повторного создания свойств ARM рабочей области.

begin_create_or_update

Асинхронно создает или обновляет ресурс Машинного обучения Azure.

begin_create_or_update(entity: R, **kwargs) -> LROPoller[R]

Параметры

entity
Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]
Обязательно

Ресурс для создания или обновления.

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

Ресурс после операции создания или обновления.

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

LROPoller[Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]]

create_or_update

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

create_or_update(entity: T, **kwargs) -> T

Параметры

entity
Union[Job , Model, Environment, Component , Datastore]
Обязательно

Ресурс для создания или обновления.

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

Созданный или обновленный ресурс.

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

Union[Job, Model , Environment, Component, Datastore]

from_config

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

Этот метод предоставляет простой способ повторного использования одной рабочей области в нескольких записных книжках Или проектах Python. Свойства azure Resource Manager (ARM) рабочей области можно сохранить в файле конфигурации JSON в следующем формате:


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

Затем этот метод можно использовать для загрузки одной и той же рабочей области в разные записные книжки или проекты Python без повторного создания свойств ARM рабочей области.

from_config(credential: TokenCredential, *, path: PathLike | str | None = None, file_name=None, **kwargs) -> MLClient

Параметры

credential
TokenCredential
Обязательно

Объект учетных данных для рабочей области.

path
Optional[Union[PathLike, str]]

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

file_name
Optional[str]

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

cloud
Optional[str]

Используемое имя облака. Значение по умолчанию — "AzureCloud".

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

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

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

MLClient

Исключения

ValidationException

Возникает, если "config.json" или file_name, если переопределен, не найден в каталоге. Подробные сведения будут указаны в сообщении об ошибке.

Примеры

Создание MLClient из файла с именем "config.json" в каталоге "src".


   from azure.ai.ml import MLClient

   client = MLClient.from_config(credential=DefaultAzureCredential(), path="./sdk/ml/azure-ai-ml/samples/src")

Создание MLClient из файла с именем team_workspace_configuration.json в текущем каталоге.


   from azure.ai.ml import MLClient

   client = MLClient.from_config(
       credential=DefaultAzureCredential(),
       file_name="./sdk/ml/azure-ai-ml/samples/team_workspace_configuration.json",
   )

Атрибуты

batch_deployments

Коллекция операций, связанных с пакетным развертыванием.

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

Операции пакетного развертывания.

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

BatchDeploymentOperations

batch_endpoints

Коллекция операций, связанных с пакетной конечной точкой.

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

Операции пакетной конечной точки

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

BatchEndpointOperations

components

Коллекция операций, связанных с компонентами.

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

Операции с компонентами.

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

ComponentOperations

compute

Коллекция операций, связанных с вычислениями.

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

Вычислительные операции

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

ComputeOperations

connections

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

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

Операции с подключениями к рабочей области

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

WorkspaceConnectionsOperations

data

Коллекция операций, связанных с данными.

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

Операции с данными.

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

DataOperations

datastores

Коллекция операций, связанных с хранилищем данных.

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

Операции хранилища данных.

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

DatastoreOperations

environments

Коллекция операций, связанных со средой.

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

Операции со средой.

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

EnvironmentOperations

feature_sets

aka.ms/azuremlexperimental для получения дополнительных сведений.

Коллекция операций, связанных с набором компонентов.

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

Операции с набором компонентов

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

FeatureSetOperations

feature_store_entities

aka.ms/azuremlexperimental для получения дополнительных сведений.

Коллекция операций, связанных с сущностью хранилища признаков.

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

Операции FeatureStoreEntity

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

FeatureStoreEntityOperations

feature_stores

aka.ms/azuremlexperimental для получения дополнительных сведений.

Коллекция операций, связанных с хранилищем признаков.

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

Операции FeatureStore

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

FeatureStoreOperations

jobs

Коллекция операций, связанных с заданиями.

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

операции заданий;

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

JobOperations

models

Коллекция операций, связанных с моделью.

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

Операции модели

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

ModelOperations

online_deployments

Коллекция операций, связанных с сетевым развертыванием.

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

Операции развертывания в сети

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

OnlineDeploymentOperations

online_endpoints

Коллекция операций, связанных с сетевой конечной точкой.

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

Операции с сетевыми конечными точками

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

OnlineEndpointOperations

registries

aka.ms/azuremlexperimental для получения дополнительных сведений.

Коллекция операций, связанных с реестром.

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

Операции с реестром

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

RegistryOperations

resource_group_name

Получение имени группы ресурсов объекта MLClient.

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

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

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

str

schedules

Коллекция операций, связанных с расписанием.

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

Планирование операций.

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

ScheduleOperations

subscription_id

Получите идентификатор подписки объекта MLClient.

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

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

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

str

workspace_hubs

aka.ms/azuremlexperimental для получения дополнительных сведений.

Коллекция операций, связанных с концентратором рабочей области.

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

Операции концентратора

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

<xref:HubOperations>

workspace_name

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

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

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

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

Optional[str]

workspace_outbound_rules

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

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

Операции с правилами исходящего трафика рабочей области

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

WorkspaceOutboundRuleOperations

workspaces

Коллекция операций, связанных с рабочей областью.

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

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

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

WorkspaceOperations

R 

R = ~R

T 

T = ~T