Bagikan melalui

LocalWebservice Kelas

  • Referensi

Mewakili model pembelajaran mesin yang disebarkan sebagai titik akhir layanan web lokal.

Menyebarkan layanan web secara lokal berguna untuk skenario penelusuran kesalahan dan pengujian.

Konstruktor layanan web lokal.

Konstruktor LocalWebservice digunakan untuk mengambil representasi lokal objek LocalWebservice yang terkait dengan ruang kerja yang disediakan.

Warisan
Webservice
LocalWebservice

Konstruktor

LocalWebservice(*args, **kwargs)

Parameter

Nama Deskripsi
workspace
Diperlukan
Workspace

Objek ruang kerja berisi objek Model apa pun yang akan diambil.
name
Diperlukan
str

Nama objek Layanan web yang akan diambil.
must_exist
Diperlukan
bool

Apakah layanan web harus sudah ada saat membuat objek dalam memori.
workspace
Diperlukan
Workspace

Objek ruang kerja berisi objek Model apa pun yang akan diambil.
name
Diperlukan
str

Nama objek LocalWebservice yang akan diambil.
must_exist
Diperlukan
bool

Apakah layanan web harus sudah ada saat membuat objek dalam memori.

Keterangan

Sampel kode berikut menunjukkan cara membuat layanan web Docker lokal. Lihat link notebook untuk detail lebih lanjut.


   from azureml.core.webservice import LocalWebservice

   # This is optional, if not provided Docker will choose a random unused port.
   deployment_config = LocalWebservice.deploy_configuration(port=6789)

   local_service = Model.deploy(ws, "test", [model], inference_config, deployment_config)

   local_service.wait_for_deployment()

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

Metode

delete

Hapus LocalWebservice ini dari komputer lokal.

Panggilan fungsi ini tidak asinkron; proses tersebut berjalan hingga layanan dihapus.
deploy_configuration

Buat objek konfigurasi untuk menyebarkan Layanan web lokal.
deploy_to_cloud

Menyebarkan Webservice berdasarkan konfigurasi LocalWebservice.
deserialize

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

Catatan

Tidak didukung untuk LocalWebservice.
get_keys

Ambil kunci autentikasi untuk layanan Web ini.

Catatan

Tidak didukung untuk LocalWebservice.
get_logs

Ambil log untuk LocalWebservice ini.
get_token

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

Catatan

Tidak didukung untuk LocalWebservice.
list

Cantumkan LocalWebservices yang terkait dengan Ruang kerja yang sesuai.

Hasil yang dikembalikan dapat difilter menggunakan parameter.
regen_key

Regenerasi salah satu kunci Layanan web.

Catatan

Tidak didukung untuk LocalWebservice.
reload

Muat ulang skrip eksekusi dan dependensi LocalWebservice.

Langkah ini memulai ulang kontainer layanan dengan salinan aset yang diperbarui, termasuk skrip eksekusi dan dependensi lokal, tetapi tidak membangun kembali gambar yang mendasarinya. Oleh karena itu, perubahan pada dependensi Conda/pip atau langkah Docker kustom tidak akan tercermin dalam LocalWebservice yang dimuat ulang. Untuk menangani perubahan tersebut, panggil metode update sebagai gantinya.
run

Hubungi LocalWebservice ini dengan input yang disediakan.
serialize

Ubah objek Layanan web ini menjadi kamus serial JSON.
update

Perbarui LocalWebservice dengan properti yang disediakan.

Nilai yang tersisa “Tidak Ada” akan tetap tidak berubah di LocalWebservice ini.
update_deployment_state

Refresh status objek dalam memori saat ini.

Lakukan pembaruan di tempat pada properti objek berdasarkan status kontainer Docker lokal saat ini.
wait_for_deployment

Polling penyebaran LocalWebservice yang sedang berjalan.

delete

Hapus LocalWebservice ini dari komputer lokal.

Panggilan fungsi ini tidak asinkron; proses tersebut berjalan hingga layanan dihapus.

delete(delete_cache=True, delete_image=False, delete_volume=True)

Parameter

Nama Deskripsi
delete_cache
Diperlukan
bool

Apakah akan menghapus file sementara yang di-cache untuk layanan tersebut. (Default: True)
delete_image
Diperlukan
bool

Apakah akan menghapus gambar Docker layanan. (Default: False)
delete_volume
Diperlukan
bool

Apakah akan menghapus volume Docker layanan. (Default: True)

Pengecualian

Jenis Deskripsi
WebserviceException

deploy_configuration

Buat objek konfigurasi untuk menyebarkan Layanan web lokal.

static deploy_configuration(port=None)

Parameter

Nama Deskripsi
port
int

Port lokal tempat mengekspos titik akhir HTTP layanan.

Nilai default: None

Mengembalikan

Jenis Deskripsi
LocalWebserviceDeploymentConfiguration

Objek konfigurasi yang akan digunakan saat menyebarkan objek Layanan Web.

Pengecualian

Jenis Deskripsi
WebserviceException

deploy_to_cloud

Menyebarkan Webservice berdasarkan konfigurasi LocalWebservice.

deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)

Parameter

Nama Deskripsi
name
str

Nama untuk memberikan layanan yang disebarkan. Harus unik untuk ruang kerja.

Nilai default: None
deployment_config
WebserviceDeploymentConfiguration

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

Nilai default: None
deployment_target
ComputeTarget

ComputeTarget tempat menyebarkan Layanan web. Karena ACI tidak memiliki ComputeTargetterkait, tinggalkan parameter ini sebagai Tidak Ada untuk disebarkan ke ACI.

Nilai default: None

Mengembalikan

Jenis Deskripsi
Webservice

Objek Layanan web yang sesuai dengan layanan web yang disebarkan.

Pengecualian

Jenis Deskripsi
WebserviceException

deserialize

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

Catatan

Tidak didukung untuk LocalWebservice.

deserialize(workspace, webservice_payload)

Parameter

Nama Deskripsi
cls
Diperlukan
workspace
Diperlukan
Workspace

Objek ruang kerja yang didaftarkan oleh Layanan Web.
webservice_payload
Diperlukan
dict

Objek JSON yang akan dikonversi menjadi objek Layanan Web.

Pengecualian

Jenis Deskripsi
azureml.exceptions.NotImplementedError

get_keys

Ambil kunci autentikasi untuk layanan Web ini.

Catatan

Tidak didukung untuk LocalWebservice.

get_keys()

Mengembalikan

Jenis Deskripsi

Kunci autentikasi untuk Layanan Web ini.

Pengecualian

Jenis Deskripsi
azureml.exceptions.NotImplementedError

get_logs

Ambil log untuk LocalWebservice ini.

get_logs(num_lines=5000, raw=False)

Parameter

Nama Deskripsi
num_lines
Diperlukan
int

Jumlah maksimum garis log yang akan diambil. (Default: 5000)
raw
Diperlukan
bool

Kembalikan output kontainer Docker mentah tanpa mencoba memformatnya. (Default: False)

Mengembalikan

Jenis Deskripsi
str

Log untuk LocalWebservice ini.

Pengecualian

Jenis Deskripsi
WebserviceException

get_token

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

Catatan

Tidak didukung untuk LocalWebservice.

get_token()

Mengembalikan

Jenis Deskripsi
str, datetime

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

Pengecualian

Jenis Deskripsi
azureml.exceptions.NotImplementedError

list

Cantumkan LocalWebservices yang terkait dengan Ruang kerja yang sesuai.

Hasil yang dikembalikan dapat difilter menggunakan parameter.

static list(workspace, model_name=None, model_id=None, all=None)

Parameter

Nama Deskripsi
workspace
Diperlukan
Workspace

Objek Ruang kerja yang terkait dengan LocalWebservices.
model_name
str

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

Nilai default: None
model_id
str

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

Nilai default: None
all
bool

Tampilkan semua layanan. Hanya layanan yang berjalan yang ditampilkan secara default.

Nilai default: None

Mengembalikan

Jenis Deskripsi
list[LocalWebservice]

Daftar LocalWebservices yang difilter berkaitan dengan Ruang kerja yang disediakan.

Pengecualian

Jenis Deskripsi
WebserviceException

regen_key

Regenerasi salah satu kunci Layanan web.

Catatan

Tidak didukung untuk LocalWebservice.

regen_key(key)

Parameter

Nama Deskripsi
key
Diperlukan
str

Kunci yang harus diregenerasi. Pilihannya adalah 'Primer' atau 'Sekunder'

Pengecualian

Jenis Deskripsi
NotImplementedError

reload

Muat ulang skrip eksekusi dan dependensi LocalWebservice.

Langkah ini memulai ulang kontainer layanan dengan salinan aset yang diperbarui, termasuk skrip eksekusi dan dependensi lokal, tetapi tidak membangun kembali gambar yang mendasarinya. Oleh karena itu, perubahan pada dependensi Conda/pip atau langkah Docker kustom tidak akan tercermin dalam LocalWebservice yang dimuat ulang. Untuk menangani perubahan tersebut, panggil metode update sebagai gantinya.

reload(wait=False)

Parameter

Nama Deskripsi
wait
Diperlukan
bool

Tunggu kontainer layanan untuk mencapai kondisi normal. (Default: False)

Pengecualian

Jenis Deskripsi
WebserviceException

run

Hubungi LocalWebservice ini dengan input yang disediakan.

run(input_data)

Parameter

Nama Deskripsi
input_data
Diperlukan
<xref:varies>

Input yang digunakan untuk memanggil LocalWebservice.

Mengembalikan

Jenis Deskripsi
<xref:varies>

Hasil dari memanggil LocalWebservice.

Pengecualian

Jenis Deskripsi
WebserviceException

serialize

Ubah objek Layanan web ini menjadi kamus serial JSON.

serialize()

Mengembalikan

Jenis Deskripsi
dict

Representasi serial dari objek Layanan web.

Pengecualian

Jenis Deskripsi
WebserviceException

update

Perbarui LocalWebservice dengan properti yang disediakan.

Nilai yang tersisa “Tidak Ada” akan tetap tidak berubah di LocalWebservice ini.

update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)

Parameter

Nama Deskripsi
models
Diperlukan
list[Model]

Daftar model baru yang terdapat di LocalWebservice.
image_config
Diperlukan
ContainerImageConfig

Opsi konfigurasi gambar untuk diterapkan ke LocalWebservice.
deployment_config
Diperlukan
LocalWebserviceDeploymentConfiguration

Opsi konfigurasi penyebaran untuk diterapkan ke LocalWebservice.
inference_config
Diperlukan
InferenceConfig

Objek InferenceConfig yang digunakan untuk menyediakan properti penyebaran model yang diperlukan.
wait
Diperlukan
bool

Tunggu kontainer layanan untuk mencapai kondisi normal. (Default: False)

Mengembalikan

Jenis Deskripsi
None

Pengecualian

Jenis Deskripsi
WebserviceException

update_deployment_state

Refresh status objek dalam memori saat ini.

Lakukan pembaruan di tempat pada properti objek berdasarkan status kontainer Docker lokal saat ini.

update_deployment_state(must_exist=False)

Parameter

Nama Deskripsi
must_exist
bool

Apakah layanan web harus sudah ada saat membuat objek dalam memori.

Nilai default: False

Pengecualian

Jenis Deskripsi
WebserviceException

wait_for_deployment

Polling penyebaran LocalWebservice yang sedang berjalan.

wait_for_deployment(show_output=False)

Parameter

Nama Deskripsi
show_output
Diperlukan
bool

Opsi untuk mencetak lebih banyak output verbose. (Default: False)

Pengecualian

Jenis Deskripsi
WebserviceException

Atribut

port

Dapatkan port layanan web lokal.

Mengembalikan

Jenis Deskripsi
int

Nomor port.

scoring_uri

Dapatkan URI penilaian layanan web lokal.

Mengembalikan

Jenis Deskripsi
str

URI Penilaian.

swagger_uri

Dapatkan layanan web lokal URI Swagger.

Mengembalikan

Jenis Deskripsi
str

URI Swagger.

NETWORK_NAME 

NETWORK_NAME = 'azureml-local'

STATE_DELETED 

STATE_DELETED = 'deleted'

STATE_DEPLOYING 

STATE_DEPLOYING = 'deploying'

STATE_FAILED 

STATE_FAILED = 'failed'

STATE_RUNNING 

STATE_RUNNING = 'running'

STATE_UNKNOWN 

STATE_UNKNOWN = 'unknown'