MLClient Kelas

Kelas klien untuk berinteraksi dengan layanan Azure ML.

Gunakan klien ini untuk mengelola sumber daya Azure ML seperti ruang kerja, pekerjaan, model, dan sebagainya.

Warisan
builtins.object
MLClient

Konstruktor

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)

Parameter

credential
TokenCredential
Diperlukan

Kredensial yang digunakan untuk autentikasi.

subscription_id
Optional[str]
nilai default: None

Atur ID Langganan Azure. Opsional hanya untuk aset registri. Default ke Tidak Ada.

resource_group_name
Optional[str]
nilai default: None

Grup sumber daya Azure. Opsional hanya untuk aset registri. Default ke Tidak Ada.

workspace_name
Optional[str]
nilai default: None

Ruang kerja yang akan digunakan di klien. Opsional hanya untuk operasi yang tidak bergantung pada ruang kerja. Default ke Tidak Ada.

registry_name
Optional[str]
nilai default: None

Registri yang digunakan dalam klien. Opsional hanya untuk operasi yang tidak bergantung pada ruang kerja. Default ke Tidak Ada.

show_progress
Optional[bool]

Menentukan apakah akan menampilkan bilah kemajuan untuk operasi yang berjalan lama atau tidak (misalnya pelanggan dapat mempertimbangkan untuk mengatur ini ke False jika tidak menggunakan SDK ini dalam penyiapan interaktif). Default ke True.

enable_telemetry
Optional[bool]

Menentukan apakah akan mengaktifkan telemetri atau tidak. Akan ditimpa ke False jika tidak ada di Jupyter Notebook. Default ke True jika dalam Jupyter Notebook.

cloud
Optional[str]

Nama cloud yang akan digunakan. Default ke "AzureCloud".

Contoh

Saat menggunakan domain berdaulat (yaitu cloud apa pun selain AZURE_PUBLIC_CLOUD), Anda harus meneruskan nama cloud di kwargs dan Anda harus menggunakan otoritas dengan 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,
   )

Metode

begin_create_or_update

Membuat atau memperbarui sumber daya Azure ML secara asinkron.

create_or_update

Membuat atau memperbarui sumber daya Azure ML.

from_config

Mengembalikan klien dari Ruang Kerja Azure Machine Learning yang sudah ada menggunakan konfigurasi file.

Metode ini menyediakan cara sederhana untuk menggunakan kembali ruang kerja yang sama di beberapa buku catatan atau proyek Python. Anda dapat menyimpan properti Azure Resource Manager (ARM) ruang kerja dalam file konfigurasi JSON menggunakan format ini:


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

Kemudian, Anda dapat menggunakan metode ini untuk memuat ruang kerja yang sama di notebook atau proyek Python yang berbeda tanpa mengetik ulang properti ARM ruang kerja.

begin_create_or_update

Membuat atau memperbarui sumber daya Azure ML secara asinkron.

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

Parameter

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

Sumber daya untuk membuat atau memperbarui.

Mengembalikan

Sumber daya setelah operasi buat/perbarui.

Tipe hasil

create_or_update

Membuat atau memperbarui sumber daya Azure ML.

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

Parameter

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

Sumber daya untuk membuat atau memperbarui.

Mengembalikan

Sumber daya yang dibuat atau diperbarui.

Tipe hasil

from_config

Mengembalikan klien dari Ruang Kerja Azure Machine Learning yang sudah ada menggunakan konfigurasi file.

Metode ini menyediakan cara sederhana untuk menggunakan kembali ruang kerja yang sama di beberapa buku catatan atau proyek Python. Anda dapat menyimpan properti Azure Resource Manager (ARM) ruang kerja dalam file konfigurasi JSON menggunakan format ini:


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

Kemudian, Anda dapat menggunakan metode ini untuk memuat ruang kerja yang sama di notebook atau proyek Python yang berbeda tanpa mengetik ulang properti ARM ruang kerja.

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

Parameter

credential
TokenCredential
Diperlukan

Objek kredensial untuk ruang kerja.

path
Optional[Union[PathLike, str]]

Jalur ke file konfigurasi atau direktori awal untuk mencari file konfigurasi di dalamnya. Default ke Tidak Ada, menunjukkan direktori saat ini akan digunakan.

file_name
Optional[str]

Nama file konfigurasi yang akan dicari ketika jalur adalah jalur direktori. Default ke "config.json".

cloud
Optional[str]

Nama cloud yang akan digunakan. Default ke "AzureCloud".

Mengembalikan

Klien untuk Ruang Kerja Azure ML yang sudah ada.

Tipe hasil

Pengecualian

Dimunculkan jika "config.json", atau file_name jika ditimpa, tidak dapat ditemukan di direktori. Detail akan diberikan dalam pesan kesalahan.

Contoh

Membuat MLClient dari file bernama "config.json" di direktori "src".


   from azure.ai.ml import MLClient

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

Membuat MLClient dari file bernama "team_workspace_configuration.json" di direktori saat ini.


   from azure.ai.ml import MLClient

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

Atribut

batch_deployments

Kumpulan operasi terkait penyebaran batch.

Mengembalikan

Operasi Penyebaran Batch.

Tipe hasil

batch_endpoints

Kumpulan operasi terkait titik akhir batch.

Mengembalikan

Operasi Titik Akhir Batch

Tipe hasil

components

Kumpulan operasi terkait komponen.

Mengembalikan

Operasi komponen.

Tipe hasil

compute

Kumpulan operasi terkait komputasi.

Mengembalikan

Operasi komputasi

Tipe hasil

connections

Kumpulan operasi terkait koneksi ruang kerja.

Mengembalikan

Operasi Koneksi Ruang Kerja

Tipe hasil

data

Kumpulan operasi terkait data.

Mengembalikan

Operasi data.

Tipe hasil

datastores

Kumpulan operasi terkait datastore.

Mengembalikan

Operasi datastore.

Tipe hasil

environments

Kumpulan operasi terkait lingkungan.

Mengembalikan

Operasi lingkungan.

Tipe hasil

feature_sets

aka.ms/azuremlexperimental untuk informasi selengkapnya.

Kumpulan operasi terkait kumpulan fitur.

Mengembalikan

Operasi FeatureSet

Tipe hasil

feature_store_entities

aka.ms/azuremlexperimental untuk informasi selengkapnya.

Kumpulan operasi terkait entitas penyimpanan fitur.

Mengembalikan

Operasi FeatureStoreEntity

Tipe hasil

feature_stores

aka.ms/azuremlexperimental untuk informasi selengkapnya.

Kumpulan operasi terkait penyimpanan fitur.

Mengembalikan

Operasi FeatureStore

Tipe hasil

jobs

Kumpulan operasi terkait pekerjaan.

Mengembalikan

Operasi pekerjaan

Tipe hasil

models

Kumpulan operasi terkait model.

Mengembalikan

Operasi model

Tipe hasil

online_deployments

Kumpulan operasi terkait penyebaran online.

Mengembalikan

Operasi Penyebaran Online

Tipe hasil

online_endpoints

Kumpulan operasi terkait titik akhir online.

Mengembalikan

Operasi Titik Akhir Online

Tipe hasil

registries

aka.ms/azuremlexperimental untuk informasi selengkapnya.

Kumpulan operasi terkait registri.

Mengembalikan

Operasi registri

Tipe hasil

resource_group_name

Dapatkan nama grup sumber daya objek MLClient.

Mengembalikan

Nama grup sumber daya Azure.

Tipe hasil

str

schedules

Kumpulan operasi terkait jadwal.

Mengembalikan

Jadwalkan operasi.

Tipe hasil

subscription_id

Dapatkan ID langganan objek MLClient.

Mengembalikan

ID langganan Azure.

Tipe hasil

str

workspace_hubs

aka.ms/azuremlexperimental untuk informasi selengkapnya.

Kumpulan operasi terkait hub ruang kerja.

Mengembalikan

Operasi Hub

Tipe hasil

<xref:HubOperations>

workspace_name

Nama ruang kerja tempat operasi yang bergantung pada ruang kerja akan dijalankan.

Mengembalikan

Nama ruang kerja default.

Tipe hasil

workspace_outbound_rules

Kumpulan operasi terkait aturan keluar ruang kerja.

Mengembalikan

Operasi aturan keluar ruang kerja

Tipe hasil

workspaces

Kumpulan operasi terkait ruang kerja.

Mengembalikan

Operasi ruang kerja

Tipe hasil

R

R = ~R

T

T = ~T