MLClient Sınıf

Başvuru

Azure ML hizmetleriyle etkileşime geçmek için bir istemci sınıfı.

Çalışma alanları, işler, modeller gibi Azure ML kaynaklarını yönetmek için bu istemciyi kullanın.

Devralma: builtins.object

MLClient

Oluşturucu

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)

Parametreler

credential: TokenCredential

Gerekli

Kimlik doğrulaması için kullanılacak kimlik bilgisi.

subscription_id: Optional[str]

varsayılan değer: None

Azure abonelik kimliği. Yalnızca kayıt defteri varlıkları için isteğe bağlıdır. Varsayılan değer Yok'tır.

resource_group_name: Optional[str]

varsayılan değer: None

Azure kaynak grubu. Yalnızca kayıt defteri varlıkları için isteğe bağlıdır. Varsayılan değer Yok'tır.

workspace_name: Optional[str]

varsayılan değer: None

İstemcide kullanılacak çalışma alanı. Yalnızca çalışma alanına bağımlı olmayan işlemler için isteğe bağlıdır. Varsayılan değer Yok'tır.

registry_name: Optional[str]

varsayılan değer: None

İstemcide kullanılacak kayıt defteri. Yalnızca çalışma alanına bağımlı olmayan işlemler için isteğe bağlıdır. Varsayılan değer Yok'tır.

show_progress: Optional[bool]

Uzun süre çalışan işlemler için ilerleme çubuklarının görüntülenip görüntülenmeyeceğini belirtir (örneğin, müşteriler bu SDK'yi etkileşimli bir kurulumda kullanmazlarsa bunu False olarak ayarlamayı göz önünde bulundurabilir). Varsayılan değer True'dır.

enable_telemetry: Optional[bool]

Telemetrinin etkinleştirilip etkinleştirilmeymeyeceğini belirtir. bir Jupyter Notebook değilse False olarak geçersiz kılınacaktır. Jupyter Notebook ise varsayılan değer True olur.

cloud: Optional[str]

Kullanılacak bulut adı. Varsayılan olarak "AzureCloud" kullanılır.

Örnekler

Bağımsız etki alanlarını (yani AZURE_PUBLIC_CLOUD dışındaki herhangi bir bulutu) kullanırken, kwargs'da bulut adını geçirmeniz ve DefaultAzureCredential ile bir yetkili kullanmanız gerekir.


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

Yöntemler

begin_create_or_update

Azure ML kaynağını zaman uyumsuz olarak oluşturur veya güncelleştirir.

create_or_update

Azure ML kaynağını oluşturur veya güncelleştirir.

from_config

Dosya yapılandırması kullanarak var olan bir Azure Machine Learning Çalışma Alanı'ndan bir istemci döndürür.

Bu yöntem, aynı çalışma alanını birden çok Python not defteri veya projesinde yeniden kullanmanın basit bir yolunu sağlar. Çalışma alanının Azure Resource Manager (ARM) özelliklerini şu biçimi kullanarak bir JSON yapılandırma dosyasına kaydedebilirsiniz:


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

Ardından, çalışma alanı ARM özelliklerini yeniden yazmadan aynı çalışma alanını farklı Python not defterlerine veya projelerine yüklemek için bu yöntemi kullanabilirsiniz.

begin_create_or_update

Azure ML kaynağını zaman uyumsuz olarak oluşturur veya güncelleştirir.

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

Parametreler

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

Gerekli

Oluşturulacak veya güncelleştirilecek kaynak.

Döndürülenler

Oluşturma/güncelleştirme işleminden sonra kaynak.

Dönüş türü

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

create_or_update

Azure ML kaynağını oluşturur veya güncelleştirir.

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

Parametreler

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

Gerekli

Oluşturulacak veya güncelleştirilecek kaynak.

Döndürülenler

Oluşturulan veya güncelleştirilen kaynak.

Dönüş türü

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

from_config

Dosya yapılandırması kullanarak var olan bir Azure Machine Learning Çalışma Alanı'ndan bir istemci döndürür.


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

Ardından, çalışma alanı ARM özelliklerini yeniden yazmadan aynı çalışma alanını farklı Python not defterlerine veya projelerine yüklemek için bu yöntemi kullanabilirsiniz.

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

Parametreler

credential: TokenCredential

Gerekli

Çalışma alanının kimlik bilgisi nesnesi.

path: Optional[Union[PathLike, str]]

içindeki yapılandırma dosyasını aramak için yapılandırma dosyasının veya başlangıç dizininin yolu. Varsayılan değer Yok'tır ve geçerli dizinin kullanılacağını belirtir.

file_name: Optional[str]

Yol bir dizin yolu olduğunda aranacak yapılandırma dosyası adı. Varsayılan olarak "config.json" kullanılır.

cloud: Optional[str]

Kullanılacak bulut adı. Varsayılan olarak "AzureCloud" kullanılır.

Döndürülenler

Mevcut bir Azure ML Çalışma Alanı için istemci.

Dönüş türü

MLClient

Özel durumlar

ValidationException

"config.json" ise veya geçersiz kılınırsa file_name dizinde bulunamaz. Ayrıntılar hata iletisinde sağlanacaktır.

Örnekler

"src" dizinindeki "config.json" adlı bir dosyadan MLClient oluşturma.


   from azure.ai.ml import MLClient

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

Geçerli dizindeki "team_workspace_configuration.json" adlı bir dosyadan MLClient oluşturma.


   from azure.ai.ml import MLClient

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

Daha fazla bilgi için aka.ms/azuremlexperimental.

Özellik kümesiyle ilgili işlemler koleksiyonu.

Döndürülenler

FeatureSet işlemleri

Dönüş türü

FeatureSetOperations

feature_store_entities

Daha fazla bilgi için aka.ms/azuremlexperimental.

Özellik deposu varlığıyla ilgili işlemler koleksiyonu.

Döndürülenler

FeatureStoreEntity işlemleri

Dönüş türü

FeatureStoreEntityOperations

feature_stores

registries

workspace_hubs

R

R = ~R

T

T = ~T