MLClient 클래스

참조

Azure ML 서비스와 상호 작용하는 클라이언트 클래스입니다.

이 클라이언트를 사용하여 작업 영역, 작업, 모델 등과 같은 Azure ML 리소스를 관리합니다.

상속: 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 구독 ID입니다. 레지스트리 자산에 대해서만 선택 사항입니다. 기본값은 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로 재정의됩니다. Jupyter Notebook 있는 경우 기본값은 True입니다.

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 ML 리소스를 비동기적으로 만들거나 업데이트합니다.

create_or_update

Azure ML 리소스를 만들거나 업데이트합니다.

from_config

파일 구성을 사용하여 기존 Azure Machine Learning 작업 영역에서 클라이언트를 반환합니다.

이 메서드는 여러 Python Notebook 또는 프로젝트에서 동일한 작업 영역을 다시 사용하는 간단한 방법을 제공합니다. 다음 형식을 사용하여 작업 영역의 ARM(Azure Resource Manager) 속성을 JSON 구성 파일에 저장할 수 있습니다.


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

그런 다음 이 메서드를 사용하여 작업 영역 ARM 속성을 다시 지정하지 않고도 다른 Python Notebook 또는 프로젝트에 동일한 작업 영역을 로드할 수 있습니다.

begin_create_or_update

Azure ML 리소스를 비동기적으로 만들거나 업데이트합니다.

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 ML 리소스를 만들거나 업데이트합니다.

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

매개 변수

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

필수

만들거나 업데이트할 리소스입니다.

반환

생성되거나 업데이트된 리소스입니다.

반환 형식

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

from_config

파일 구성을 사용하여 기존 Azure Machine Learning 작업 영역에서 클라이언트를 반환합니다.


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

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 ML 작업 영역에 대한 클라이언트입니다.

반환 형식

MLClient

예외

ValidationException

"config.json"이거나 재정의된 경우 file_name 디렉터리에서 찾을 수 없는 경우 발생합니다. 자세한 내용은 오류 메시지에 제공됩니다.

예제

디렉터리 "src"의 "config.json"이라는 파일에서 MLClient를 만듭니다.


   from azure.ai.ml import MLClient

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

현재 디렉터리의 "team_workspace_configuration.json"이라는 파일에서 MLClient를 만듭니다.


   from azure.ai.ml import MLClient

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

자세한 내용은 aka.ms/azuremlexperimental.

기능 집합 관련 작업의 컬렉션입니다.

반환

FeatureSet 작업

반환 형식

FeatureSetOperations

feature_store_entities

자세한 내용은 aka.ms/azuremlexperimental.

기능 저장소 엔터티 관련 작업의 컬렉션입니다.

반환

FeatureStoreEntity 작업

반환 형식

FeatureStoreEntityOperations

feature_stores

registries

workspace_hubs

R

R = ~R

T

T = ~T

다음을 통해 공유

MLClient 클래스

생성자

매개 변수

예제

메서드

begin_create_or_update

매개 변수

반환

반환 형식

create_or_update

매개 변수

반환

반환 형식

from_config

매개 변수

반환

반환 형식

예외

예제

특성

batch_deployments

반환

반환 형식

batch_endpoints

반환

반환 형식

components

반환

반환 형식

compute

반환

반환 형식

connections

반환

반환 형식

data

반환

반환 형식

datastores

반환

반환 형식

environments

반환

반환 형식

feature_sets

반환

반환 형식

feature_store_entities

반환

반환 형식

feature_stores

반환

반환 형식

jobs

반환

반환 형식

models

반환

반환 형식

online_deployments

반환

반환 형식

online_endpoints

반환

반환 형식

registries

반환

반환 형식

resource_group_name

반환

반환 형식

schedules

반환

반환 형식

subscription_id

반환

반환 형식

workspace_hubs

반환