Webservice Kelas

Referensi

Menentukan fungsionalitas dasar untuk menyebarkan model sebagai titik akhir layanan web di Azure Machine Learning.

Konstruktor layanan web digunakan untuk mengambil representasi cloud dari objek Layanan web yang diasosiasikan dengan Ruang kerja yang disediakan. Mengembalikan instans kelas turunan yang sesuai dengan jenis tertentu dari objek Layanan web yang diambil. Kelas Layanan web memungkinkan untuk menyebarkan model pembelajaran mesin dari objek Model atau Image.

Untuk informasi selengkapnya tentang bekerja dengan Layanan Web, lihat Model penyebaran dengan Azure Machine Learning.

Warisan: ABC

Webservice

Konstruktor

Webservice(workspace, name)

Parameter

workspace: Workspace

Diperlukan

Objek ruang kerja yang berisi objek Layanan Web yang akan diambil.

name: str

Diperlukan

Nama objek Layanan Web yang akan diambil.

Keterangan

Sampel berikut menunjukkan pola penyebaran yang direkomendasikan ketika Anda pertama kali membuat objek konfigurasi dengan metode deploy_configuration kelas turunan Layanan Web (dalam hal ini AksWebservice) kemudian menggunakan konfigurasi dengan metode deploy kelas Model.


   # Set the web service configuration (using default here)
   aks_config = AksWebservice.deploy_configuration()

   # # Enable token auth and disable (key) auth on the webservice
   # aks_config = AksWebservice.deploy_configuration(token_auth_enabled=True, auth_enabled=False)

Sampel lengkap tersedia dari https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/production-deploy-to-aks/production-deploy-to-aks.ipynb

Sampel berikut menunjukkan cara menemukan AciWebservice yang ada di ruang kerja dan menghapusnya jika ada sehingga nama dapat digunakan kembali.


   from azureml.core.model import InferenceConfig
   from azureml.core.webservice import AciWebservice


   service_name = 'my-custom-env-service'

   inference_config = InferenceConfig(entry_script='score.py', environment=environment)
   aci_config = AciWebservice.deploy_configuration(cpu_cores=1, memory_gb=1)

   service = Model.deploy(workspace=ws,
                          name=service_name,
                          models=[model],
                          inference_config=inference_config,
                          deployment_config=aci_config,
                          overwrite=True)
   service.wait_for_deployment(show_output=True)

Sampel lengkap tersedia dari https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-cloud/model-register-and-deploy.ipynb

Ada sejumlah cara untuk menyebarkan model sebagai layanan web, termasuk:

Metode deploy dari Model untuk model yang sudah terdaftar di ruang kerja.
Metode deploy_from_image dari Webservice untuk gambar yang sudah dibuat dari model.
Metode deploy_from_model dari Webservice untuk model yang sudah terdaftar di ruang kerja. Metode ini akan membuat gambar.
Metode deploy dari Webservice, yang akan mendaftarkan model dan membuat gambar.

Untuk informasi tentang bekerja dengan layanan web, lihat

Bagian Variabel mencantumkan atribut representasi lokal objek Layanan Web cloud. Variabel ini harus dianggap sebagai baca-saja. Mengubah nilainya tidak akan tercermin dalam objek cloud yang sesuai.

Variabel

auth_enabled: bool

Apakah Layanan Web telah mengaktifkan autentikasi atau tidak.

compute_type: str

Jenis komputasi apa yang menjadi tempat Layanan Web disebarkan.

created_time: datetime

Saat Layanan Web dibuat.

azureml.core.Webservice.description

Deskripsi objek Layanan Web.

azureml.core.Webservice.tags

Kamus tag untuk objek Layanan Web.

azureml.core.Webservice.name

Nama Layanan Web.

azureml.core.Webservice.properties

Kamus properti nilai kunci untuk Layanan Web. Properti ini tidak dapat diubah setelah penyebaran, namun pasangan nilai kunci baru bisa ditambahkan.

created_by: str

Pengguna yang membuat Layanan Web.

error: str

Jika Layanan Web gagal disebarkan, ini akan berisi pesan kesalahan tentang penyebab kegagalan.

azureml.core.Webservice.state

Status Layanan Web saat ini.

updated_time: datetime

Terakhir kali Layanan Web diperbarui.

azureml.core.Webservice.workspace

Ruang Kerja Azure Machine Learning yang berisi Layanan Web ini.

token_auth_enabled: bool

Apakah Layanan Web mengaktifkan autentikasi token atau tidak.

Metode

check_for_existing_webservice	Periksa layanan web yang ada.
delete	Hapus Layanan Web ini dari ruang kerja terkait. Panggilan fungsi ini tidak asinkron. Panggilan berjalan hingga sumber daya dihapus. WebserviceException diajukan jika ada masalah saat menghapus model dari Layanan Manajemen Model.
deploy	Sebarkan Layanan Web dari nol atau beberapa objek Model. Fungsi ini akan mendaftarkan file model yang disediakan dan membuat gambar dalam proses, semuanya terkait dengan Workspace yang ditentukan. Gunakan fungsi ini saat Anda memiliki direktori model untuk disebarkan yang belum terdaftar sebelumnya. Layanan Web yang dihasilkan adalah titik akhir real time yang dapat digunakan untuk permintaan inferensi. Untuk informasi selengkapnya, lihat Menggunakan model yang disebarkan sebagai layanan web.
deploy_from_image	Sebarkan Layanan Web dari objek Image. Gunakan fungsi ini jika Anda sudah memiliki objek Gambar yang dibuat untuk model. Layanan Web yang dihasilkan adalah titik akhir real time yang dapat digunakan untuk permintaan inferensi. Untuk informasi selengkapnya, lihat Menggunakan model yang disebarkan sebagai layanan web.
deploy_from_model	Sebarkan Layanan Web dari nol atau beberapa objek Model. Fungsi ini mirip dengan deploy, tetapi tidak mendaftarkan model. Gunakan fungsi ini jika Anda memiliki objek model yang sudah terdaftar. Ini akan membuat gambar dalam prosesnya, terkait dengan Ruang Kerja yang ditentukan. Layanan Web yang dihasilkan adalah titik akhir real time yang dapat digunakan untuk permintaan inferensi. Untuk informasi selengkapnya, lihat Menggunakan model yang disebarkan sebagai layanan web.
deploy_local_from_model	Membuat dan menyebarkan LocalWebservice untuk pengujian. Mengharuskan Docker diinstal dan dikonfigurasi.
deserialize	Mengonversi objek JSON respons Layanan Manajemen Model menjadi objek Layanan Web. Akan gagal jika ruang kerja yang disediakan bukan ruang kerja tempat Layanan Web terdaftar.
get_keys	Ambil kunci autentikasi untuk Layanan Web ini.
get_logs	Ambil log untuk Layanan Web ini.
get_token	Ambil token autentikasi untuk Layanan Web ini, yang dicakup ke pengguna saat ini.
list	Cantumkan Layanan Web yang terkait dengan Workspace yang sesuai. Hasil yang dikembalikan dapat difilter menggunakan parameter.
regen_key	Regenerasi salah satu kunci Layanan Web, baik kunci 'Primary' atau 'Secondary'. WebserviceException diajukan jika `key` tidak ditentukan atau bukan 'Primary' atau 'Secondary'.
run	Panggil Layanan Web ini dengan input yang disediakan. Metode abstrak ini diterapkan oleh kelas turunan dari Webservice.
serialize	Konversi objek Layanan Web ini menjadi kamus serial JSON. Gunakan deserialize untuk mengonversi kembali menjadi objek Layanan Web.
update	Perbarui parameter Layanan Web. Ini adalah metode abstrak yang diterapkan oleh kelas turunan dari Webservice. Parameter yang mungkin diperbarui bervariasi berdasarkan jenis turunan Layanan Web. Misalnya, untuk layanan web Azure Container Instances, lihat update untuk parameter tertentu.
update_deployment_state	Refresh status objek dalam memori saat ini. Lakukan pembaruan d tempat pada properti objek berdasarkan status objek cloud yang sesuai saat ini. Utamanya berguna untuk polling manual status pembuatan.
wait_for_deployment	Lakukan polling secara otomatis pada penyebaran Layanan Web yang sedang berjalan. Tunggu hingga Layanan Web mencapai status terminal. Akan menampilkan WebserviceException jika mencapai keadaan terminal yang tidak berhasil atau melebihi batas waktu yang disediakan.

check_for_existing_webservice

Periksa layanan web yang ada.

static check_for_existing_webservice(workspace, name, overwrite=False, request_func=None, check_func=None)

Parameter

workspace: Workspace

Diperlukan

name: str

Diperlukan

overwrite: bool

nilai default: False

request_func: <xref:function>

nilai default: None

berfungsi untuk meminta layanan guna memeriksa apakah nama layanan tersedia

check_func: <xref:function>

nilai default: None

berfungsi untuk memeriksa konten respons request_func

Pengecualian

WebserviceException

delete

Hapus Layanan Web ini dari ruang kerja terkait.

Panggilan fungsi ini tidak asinkron. Panggilan berjalan hingga sumber daya dihapus. WebserviceException diajukan jika ada masalah saat menghapus model dari Layanan Manajemen Model.

delete()

Pengecualian

WebserviceException

deploy

Sebarkan Layanan Web dari nol atau beberapa objek Model.

Fungsi ini akan mendaftarkan file model yang disediakan dan membuat gambar dalam proses, semuanya terkait dengan Workspace yang ditentukan. Gunakan fungsi ini saat Anda memiliki direktori model untuk disebarkan yang belum terdaftar sebelumnya.

Layanan Web yang dihasilkan adalah titik akhir real time yang dapat digunakan untuk permintaan inferensi. Untuk informasi selengkapnya, lihat Menggunakan model yang disebarkan sebagai layanan web.

static deploy(workspace, name, model_paths, image_config, deployment_config=None, deployment_target=None, overwrite=False)

Parameter

workspace: Workspace

Diperlukan

Objek Ruang Kerja yang akan dikaitkan dengan Layanan Web.

name: str

Diperlukan

Nama yang diberikan untuk layanan yang disebarkan. Harus unik bagi ruang kerja, hanya terdiri dari huruf kecil, angka, atau tanda hubung, dimulai dengan huruf, dan panjangnya antara 3 sampai 32 karakter.

model_paths: list[str]

Diperlukan

Daftar jalur pada disk untuk membuat model file atau folder. Bisa berupa daftar kosong.

image_config: ImageConfig

Diperlukan

Objek ImageConfig yang digunakan untuk menentukan properti Gambar yang diperlukan.

deployment_config: WebserviceDeploymentConfiguration

nilai default: None

WebserviceDeploymentConfiguration yang digunakan untuk mengonfigurasi layanan web. Jika tidak disediakan, objek konfigurasi kosong akan digunakan berdasarkan target yang diinginkan.

deployment_target: ComputeTarget

nilai default: None

ComputeTarget menjadi tempat Layanan Web akan disebarkan. Karena Azure Container Instances tidak memiliki ComputeTarget terkait, biarkan parameter ini sebagai Tidak Ada untuk disebarkan ke Azure Container Instances.

overwrite: bool

nilai default: False

Timpa layanan yang sudah ada jika layanan dengan nama sudah ada.

Mengembalikan

Objek Layanan Web yang sesuai dengan layanan web yang disebarkan.

Tipe hasil

Webservice

Pengecualian

WebserviceException

deploy_from_image

Sebarkan Layanan Web dari objek Image.

Gunakan fungsi ini jika Anda sudah memiliki objek Gambar yang dibuat untuk model.

Layanan Web yang dihasilkan adalah titik akhir real time yang dapat digunakan untuk permintaan inferensi. Untuk informasi selengkapnya, lihat Menggunakan model yang disebarkan sebagai layanan web.

static deploy_from_image(workspace, name, image, deployment_config=None, deployment_target=None, overwrite=False)

Parameter

workspace: Workspace

Diperlukan

Objek Ruang Kerja yang akan dikaitkan dengan Layanan Web.

name: str

Diperlukan

image: Image

Diperlukan

Objek Image yang akan disebarkan.

deployment_config: WebserviceDeploymentConfiguration

nilai default: None

WebserviceDeploymentConfiguration yang digunakan untuk mengonfigurasi layanan web. Jika tidak disediakan, objek konfigurasi kosong akan digunakan berdasarkan target yang diinginkan.

deployment_target: ComputeTarget

nilai default: None

overwrite: bool

nilai default: False

Timpa layanan yang sudah ada jika layanan dengan nama sudah ada.

Mengembalikan

Objek Layanan Web yang sesuai dengan layanan web yang disebarkan.

Tipe hasil

Webservice

Pengecualian

WebserviceException

deploy_from_model

Sebarkan Layanan Web dari nol atau beberapa objek Model.

Fungsi ini mirip dengan deploy, tetapi tidak mendaftarkan model. Gunakan fungsi ini jika Anda memiliki objek model yang sudah terdaftar. Ini akan membuat gambar dalam prosesnya, terkait dengan Ruang Kerja yang ditentukan.

Layanan Web yang dihasilkan adalah titik akhir real time yang dapat digunakan untuk permintaan inferensi. Untuk informasi selengkapnya, lihat Menggunakan model yang disebarkan sebagai layanan web.

static deploy_from_model(workspace, name, models, image_config, deployment_config=None, deployment_target=None, overwrite=False)

Parameter

workspace: Workspace

Diperlukan

Objek Ruang Kerja yang akan dikaitkan dengan Layanan Web.

name: str

Diperlukan

models: list[Model]

Diperlukan

Daftar objek model. Bisa berupa daftar kosong.

image_config: ImageConfig

Diperlukan

Objek ImageConfig yang digunakan untuk menentukan properti Gambar yang diperlukan.

deployment_config: WebserviceDeploymentConfiguration

nilai default: None

WebserviceDeploymentConfiguration yang digunakan untuk mengonfigurasi layanan web. Jika tidak disediakan, objek konfigurasi kosong akan digunakan berdasarkan target yang diinginkan.

deployment_target: ComputeTarget

nilai default: None

ComputeTarget menjadi tempat Layanan Web akan disebarkan. Karena ACI tidak memiliki ComputeTarget terkait, biarkan parameter ini sebagai Tidak Ada untuk disebarkan ke ACI.

overwrite: bool

nilai default: False

Timpa layanan yang sudah ada jika layanan dengan nama sudah ada.

Mengembalikan

Objek Layanan Web yang sesuai dengan layanan web yang disebarkan.

Tipe hasil

Webservice

Pengecualian

WebserviceException

deploy_local_from_model

Membuat dan menyebarkan LocalWebservice untuk pengujian.

Mengharuskan Docker diinstal dan dikonfigurasi.

static deploy_local_from_model(workspace, name, models, image_config, deployment_config=None, wait=False)

Parameter

workspace: Workspace

Diperlukan

Objek Ruang Kerja yang akan dikaitkan dengan Layanan Web.

name: str

Diperlukan

Nama yang diberikan untuk layanan yang disebarkan. Harus bersifat unik di komputer lokal.

models: list[Model]

Diperlukan

Daftar objek model. Bisa berupa daftar kosong.

image_config: ImageConfig

Diperlukan

Objek ImageConfig yang digunakan untuk menentukan properti gambar layanan yang diperlukan.

deployment_config: LocalWebserviceDeploymentConfiguration

nilai default: None

LocalWebserviceDeploymentConfiguration yang digunakan untuk mengonfigurasi layanan web. Jika tidak disediakan, objek konfigurasi kosong akan digunakan.

wait: bool

nilai default: False

Apakah akan menunggu kontainer Docker LocalWebservice melaporkan sebagai sehat. Menampilkan pengecualian jika kontainer mengalami crash. Defaultnya adalah False.

Tipe hasil

LocalWebservice

Pengecualian

WebserviceException

deserialize

Mengonversi objek JSON respons Layanan Manajemen Model menjadi objek Layanan Web.

Akan gagal jika ruang kerja yang disediakan bukan ruang kerja tempat Layanan Web terdaftar.

deserialize(workspace, webservice_payload)

Parameter

cls

Diperlukan

Menunjukkan bahwa ini adalah metode kelas.

workspace: Workspace

Diperlukan

Objek ruang kerja yang didaftarkan oleh Layanan Web.

webservice_payload: dict

Diperlukan

Objek JSON yang akan dikonversi menjadi objek Layanan Web.

Mengembalikan

Representasi Layanan Web dari objek JSON yang disediakan.

Tipe hasil

Webservice

Pengecualian

WebserviceException

get_keys

Ambil kunci autentikasi untuk Layanan Web ini.

get_keys()

Mengembalikan

Kunci autentikasi untuk Layanan Web ini.

Tipe hasil

(str, str)

Pengecualian

WebserviceException

get_logs

Ambil log untuk Layanan Web ini.

get_logs(num_lines=5000, init=False)

Parameter

num_lines: int

nilai default: 5000

Jumlah maksimum garis log yang akan diambil.

init: bool

nilai default: False

Mendapatkan log kontainer init

Mengembalikan

Log untuk Layanan Web ini.

Tipe hasil

str

Pengecualian

WebserviceException

get_token

Ambil token autentikasi untuk Layanan Web ini, yang dicakup ke pengguna saat ini.

get_token()

Mengembalikan

Token untuk Layanan Web ini dan ketika harus di-refresh setelahnya.

Tipe hasil

str, datetime

Pengecualian

WebserviceException

list

Cantumkan Layanan Web yang terkait dengan Workspace yang sesuai.

Hasil yang dikembalikan dapat difilter menggunakan parameter.

static list(workspace, compute_type=None, image_name=None, image_id=None, model_name=None, model_id=None, tags=None, properties=None, image_digest=None)

Parameter

workspace: Workspace

Diperlukan

Objek Ruang Kerja untuk mencantumkan Layanan Web.

compute_type: str

nilai default: None

Filter untuk mencantumkan hanya jenis Layanan Web tertentu. Pilihannya adalah 'ACI', 'AKS'.

image_name: str

nilai default: None

Filter daftar untuk hanya menyertakan Layanan Web yang disebarkan dengan nama gambar tertentu.

image_id: str

nilai default: None

Filter daftar untuk hanya menyertakan Layanan Web yang disebarkan dengan ID gambar tertentu.

model_name: str

nilai default: None

Filter daftar untuk hanya menyertakan Layanan Web yang disebarkan dengan nama model tertentu.

model_id: str

nilai default: None

Filter daftar untuk hanya menyertakan Layanan Web yang disebarkan dengan ID model tertentu.

tags: list

nilai default: None

Filter berdasarkan daftar yang disediakan, baik berdasarkan 'key' atau '[key, value]'. Contoh ['key', ['key2', 'key2 value']]

properties: list

nilai default: None

Filter berdasarkan daftar yang disediakan, baik berdasarkan 'key' atau '[key, value]'. Contoh ['key', ['key2', 'key2 value']]

image_digest: str

nilai default: None

Filter daftar untuk hanya menyertakan Layanan Web yang disebarkan dengan digest gambar tertentu.

Mengembalikan

Daftar Layanan Web yang difilter di Ruang Kerja yang disediakan.

Tipe hasil

list[Webservice]

Pengecualian

WebserviceException

regen_key

Regenerasi salah satu kunci Layanan Web, baik kunci 'Primary' atau 'Secondary'.

WebserviceException diajukan jika key tidak ditentukan atau bukan 'Primary' atau 'Secondary'.

regen_key(key, set_key=None)

Parameter

key: str

Diperlukan

Kunci yang harus diregenerasi. Pilihannya adalah 'Primary' atau 'Secondary'.

set_key: str

nilai default: None

Nilai yang ditentukan pengguna yang memungkinkan spesifikasi manual dari nilai kunci

Pengecualian

WebserviceException

run

Panggil Layanan Web ini dengan input yang disediakan.

Metode abstrak ini diterapkan oleh kelas turunan dari Webservice.

abstract run(input)

Parameter

input: <xref:varies>

Diperlukan

Data input untuk memanggil Layanan Web. Ini adalah data yang diharapkan model pembelajaran mesin Anda sebagai input untuk menjalankan prediksi.

Mengembalikan

Hasil dari memanggil Layanan Web. Ini akan menampilkan prediksi yang dijalankan dari model pembelajaran mesin Anda.

Tipe hasil

dict

Pengecualian

WebserviceException

serialize

Konversi objek Layanan Web ini menjadi kamus serial JSON.

Gunakan deserialize untuk mengonversi kembali menjadi objek Layanan Web.

serialize()

Mengembalikan

Representasi JSON dari Layanan Web ini.

Tipe hasil

dict

Pengecualian

WebserviceException

update

Perbarui parameter Layanan Web.

Ini adalah metode abstrak yang diterapkan oleh kelas turunan dari Webservice. Parameter yang mungkin diperbarui bervariasi berdasarkan jenis turunan Layanan Web. Misalnya, untuk layanan web Azure Container Instances, lihat update untuk parameter tertentu.

abstract update(*args)

Parameter

args: <xref:varies>

Diperlukan

Nilai yang akan diperbarui.

Pengecualian

WebserviceException

update_deployment_state

Refresh status objek dalam memori saat ini.

Lakukan pembaruan d tempat pada properti objek berdasarkan status objek cloud yang sesuai saat ini. Utamanya berguna untuk polling manual status pembuatan.

update_deployment_state()

Pengecualian

WebserviceException

wait_for_deployment

Lakukan polling secara otomatis pada penyebaran Layanan Web yang sedang berjalan.

Tunggu hingga Layanan Web mencapai status terminal. Akan menampilkan WebserviceException jika mencapai keadaan terminal yang tidak berhasil atau melebihi batas waktu yang disediakan.

wait_for_deployment(show_output=False, timeout_sec=None)

Parameter

show_output: bool

nilai default: False

Menunjukkan apakah akan mencetak lebih banyak output verbose.

timeout_sec: float

nilai default: None

Ajukan pengecualian jika penyebaran melebihi batas waktu yang ditentukan.

Pengecualian

WebserviceException

Webservice Kelas

Konstruktor

Parameter

Keterangan

Variabel

Metode

check_for_existing_webservice

Parameter

Pengecualian

delete

Pengecualian

deploy

Parameter

Mengembalikan

Tipe hasil

Pengecualian

deploy_from_image

Parameter

Mengembalikan

Tipe hasil

Pengecualian

deploy_from_model

Parameter

Mengembalikan

Tipe hasil

Pengecualian

deploy_local_from_model

Parameter

Tipe hasil

Pengecualian

deserialize

Parameter

Mengembalikan

Tipe hasil

Pengecualian

get_keys

Mengembalikan

Tipe hasil

Pengecualian

get_logs

Parameter

Mengembalikan

Tipe hasil

Pengecualian

get_token

Mengembalikan

Tipe hasil

Pengecualian

list

Parameter

Mengembalikan

Tipe hasil

Pengecualian

regen_key

Parameter

Pengecualian

run

Parameter

Mengembalikan

Tipe hasil

Pengecualian

serialize

Mengembalikan

Tipe hasil

Pengecualian

update

Parameter

Pengecualian

update_deployment_state

Pengecualian

wait_for_deployment

Parameter

Pengecualian

Saran dan Komentar