ExplanationClient Kelas

Menentukan klien yang mengunggah dan mengunduh penjelasan.

Buat klien yang digunakan untuk berinteraksi dengan penjelasan dan menjalankan riwayat.

Warisan

builtins.object

ExplanationClient

Konstruktor

ExplanationClient(service_context, experiment_name, run_id, _run=None, datastore_name=None)

Parameter

Nama	Deskripsi
service_context Diperlukan	<xref:ServiceContext> Pemegang untuk informasi layanan.
run_id Diperlukan	str GUID yang mewakili eksekusi.
_run	Run Sebuah eksekusi. Jika diteruskan, argumen lain akan diabaikan. nilai default: None
service_context Diperlukan	<xref:ServiceContext> Pemegang untuk informasi layanan.
run_id Diperlukan	str GUID yang mewakili eksekusi.
_run Diperlukan	Run Sebuah eksekusi. Jika diteruskan, run_id akan diabaikan.
datastore_name	str Nama datastore yang digunakan untuk pengunggahan (default ke penyimpanan ruang kerja) nilai default: None
experiment_name Diperlukan

Metode

download_model_explanation	Unduh penjelasan model yang telah disimpan di riwayat eksekusi.
from_run	Buat klien dengan metode pabrik eksekusi tertentu.
from_run_id	Buat klien dengan metode pabrik ID eksekusi tertentu.
list_model_explanations	Kembalikan kamus metadata untuk semua penjelasan model yang tersedia.
upload_model_explanation	Unggah informasi penjelasan model untuk menjalankan riwayat.

download_model_explanation

Unduh penjelasan model yang telah disimpan di riwayat eksekusi.

download_model_explanation(explanation_id=None, top_k=None, comment=None, raw=None, engineered=None)

Parameter

Nama	Deskripsi
explanation_id	str Jika ditentukan, coba unduh aset dari eksekusi dengan ID penjelasan tertentu. Jika tidak ditentukan, mengembalikan penjelasan yang baru saja diunggah. nilai default: None
top_k	int Jika ditentukan, batasi data yang dipesan yang dikembalikan ke fitur dan nilai yang paling penting. Jika ini masalahnya, global_importance_values dan per_class_values akan berisi k nilai teratas yang diurutkan alih-alih daftar lengkap nilai yang tidak diurutkan seperti biasanya. nilai default: None
comment	str String yang digunakan untuk memfilter penjelasan berdasarkan string yang diunggah. Membutuhkan kecocokan yang tepat. Jika beberapa penjelasan membagikan string ini, yang terbaru akan dikembalikan. nilai default: None
raw	bool atau None Jika True atau False, penjelasan akan disaring berdasarkan mentah atau tidaknya. Jika tidak ada yang ditentukan, filter ini tidak akan diterapkan. nilai default: None
engineered	bool atau None Jika True atau False, penjelasan akan difilter berdasarkan rekayasa atau tidaknya. Jika tidak ada yang ditentukan, filter ini tidak akan diterapkan. nilai default: None

Mengembalikan

Jenis	Deskripsi
<xref:interpret_community.explanation.explanation.BaseExplanation>	Penjelasannya seperti yang diunggah untuk menjalankan riwayat

from_run

Buat klien dengan metode pabrik eksekusi tertentu.

from_run(run, datastore_name=None)

Parameter

Nama	Deskripsi
cls Diperlukan	ExplanationClient Kelas ExplanationClient.
run Diperlukan	Run Penjelasan eksekusi akan dilampirkan.
datastore_name	str Nama datastore yang digunakan untuk pengunggahan (default ke penyimpanan ruang kerja) nilai default: None

Mengembalikan

Jenis	Deskripsi
ExplanationClient	Sebuah instans dari ExplanationClient.

from_run_id

Buat klien dengan metode pabrik ID eksekusi tertentu.

from_run_id(workspace, experiment_name, run_id, datastore_name=None)

Parameter

Nama	Deskripsi
cls Diperlukan	ExplanationClient Kelas ExplanationClient.
workspace Diperlukan	Workspace Objek yang mewakili ruang kerja.
experiment_name Diperlukan	str Nama eksperimen.
run_id Diperlukan	str GUID yang mewakili eksekusi.
datastore_name	str Nama datastore yang digunakan untuk pengunggahan (default ke penyimpanan ruang kerja) nilai default: None

Mengembalikan

Jenis	Deskripsi
ExplanationClient	Sebuah instans dari ExplanationClient.

list_model_explanations

Kembalikan kamus metadata untuk semua penjelasan model yang tersedia.

list_model_explanations(comment=None, raw=None, engineered=None)

Parameter

Nama	Deskripsi
comment	str String yang digunakan untuk memfilter penjelasan berdasarkan string yang diunggah. Membutuhkan kecocokan yang tepat. nilai default: None
raw	bool atau None Jika True atau False, penjelasan akan disaring berdasarkan mentah atau tidaknya. Jika tidak ada yang ditentukan, filter ini tidak akan diterapkan. nilai default: None
engineered	bool atau None Jika True atau False, penjelasan akan difilter berdasarkan rekayasa atau tidaknya. Jika tidak ada yang ditentukan, filter ini tidak akan diterapkan. nilai default: None

Mengembalikan

Jenis	Deskripsi
dict	Kamus metadata penjelasan seperti id, jenis data, metode penjelasan, jenis model, dan waktu unggah, diurutkan berdasarkan waktu unggah

upload_model_explanation

Unggah informasi penjelasan model untuk menjalankan riwayat.

upload_model_explanation(explanation, max_num_blocks=None, block_size=None, top_k=None, comment=None, init_dataset_id=None, eval_dataset_id=None, ys_pred_dataset_id=None, ys_pred_proba_dataset_id=None, upload_datasets=False, model_id=None, true_ys=None, visualization_points=5000) -> None

Parameter

Nama	Deskripsi
explanation Diperlukan	<xref:interpret_community.explanation.explanation.BaseExplanation> Informasi penjelasan untuk disimpan.
max_num_blocks	int Jumlah maksimum blok untuk disimpan. nilai default: None
block_size	int Ukuran setiap blok untuk ringkasan yang disimpan dalam penyimpanan artefak. nilai default: None
top_k	int Sejumlah fitur penting yang tersimpan dalam penjelasannya. Jika ditentukan, hanya nama dan nilai yang sesuai dengan fitur terpenting K teratas yang akan dikembalikan/disimpan. Jika ini masalahnya, global_importance_values dan per_class_values akan berisi k nilai teratas yang diurutkan alih-alih daftar lengkap nilai yang tidak diurutkan seperti biasanya. nilai default: None
comment	str String opsional untuk mengidentifikasi penjelasan. String ditampilkan saat mencantumkan penjelasan, yang memungkinkan identifikasi penjelasan yang diunggah. nilai default: None
init_dataset_id	str ID himpunan data inisialisasi (latar belakang) di layanan Dataset, jika tersedia. Digunakan untuk menautkan penjelasan ke Dataset. nilai default: None
eval_dataset_id	str ID himpunan data evaluasi di layanan Dataset, jika tersedia. Digunakan untuk menautkan penjelasan ke Dataset. nilai default: None
ys_pred_dataset_id	str ID himpunan data nilai yang diprediksi di layanan Dataset, jika tersedia. nilai default: None
ys_pred_proba_dataset_id	str ID himpunan data nilai probabilitas yang diprediksi di layanan Dataset, jika tersedia. nilai default: None
upload_datasets	bool Jika diatur ke True dan tidak ada ID himpunan data yang diteruskan, himpunan data evaluasi akan diunggah ke penyimpanan Azure sebagai objek Dataset. Ini akan memungkinkan penjelasan ditautkan ke Dataset dalam tampilan web. nilai default: False
model_id	str ID model MMS. nilai default: None
true_ys	list | <xref:pandas.Dataframe> | ndarray Label yang benar untuk contoh evaluasi. nilai default: None
visualization_points	int atau list[int] Jika diatur ke bilangan bulat, ini adalah batas atas pada jumlah titik yang akan tersedia untuk visualisasi di antarmuka pengguna web. Jika diatur ke daftar bilangan bulat, bilangan bulat ini akan digunakan sebagai indeks untuk memilih sampel titik (data asli dan penjelasannya) untuk divisualisasikan di antarmuka pengguna web. Jika tidak berencana untuk melihat penjelasan di antarmuka pengguna web, parameter ini dapat diatur ke 0 dan tidak ada komputasi atau penyimpanan tambahan yang akan dilakukan. Batas atas untuk bilangan bulat atau panjang daftar saat ini adalah 20000 (dua puluh ribu). Jika bilangan bulat yang lebih besar atau daftar yang lebih panjang diteruskan, fungsi akan gagal. Tujuannya adalah untuk membatasi jumlah data yang masuk ke antarmuka pengguna web karena alasan performa. Dengan evaluasi lebih lanjut, batas ini dapat dinaikkan. nilai default: 5000

Atribut

run

Dapatkan objek yang berjalan dari klien penjelasan.

Mengembalikan

Jenis	Deskripsi
Run	Objek yang berjalan.