Webservice Sınıf

Azure Machine Learning'de modelleri web hizmeti uç noktaları olarak dağıtmak için temel işlevselliği tanımlar.

Web hizmeti oluşturucu, sağlanan Çalışma Alanı ile ilişkili bir Web hizmeti nesnesinin bulut gösterimini almak için kullanılır. Alınan Web hizmeti nesnesinin belirli türüne karşılık gelen bir alt sınıfın örneğini döndürür. Web hizmeti sınıfı, makine öğrenmesi modellerini bir Model veya Image nesnesinden dağıtmaya olanak tanır.

Web hizmetiyle çalışma hakkında daha fazla bilgi için bkz. Azure Machine Learning ile model dağıtma.

Web hizmeti örneğini başlatın.

Web hizmeti oluşturucu, sağlanan çalışma alanıyla ilişkili bir Web hizmeti nesnesinin bulut gösterimini alır. Alınan Web hizmeti nesnesinin belirli türüne karşılık gelen bir alt sınıfın örneğini döndürür.

Devralma
Webservice

Oluşturucu

Webservice(workspace, name)

Parametreler

Name Description
workspace
Gerekli

Alınacak Web hizmeti nesnesini içeren çalışma alanı nesnesi.

name
Gerekli
str

Alınacak Web hizmeti nesnesinin adı.

workspace
Gerekli

Alınacak Web hizmeti nesnesini içeren çalışma alanı nesnesi.

name
Gerekli
str

Alınacak Web hizmeti nesnesinin adı.

Açıklamalar

Aşağıdaki örnek, önce Webservice'in alt sınıfı (bu örnekteAksWebservice) yöntemiyle deploy_configuration bir yapılandırma nesnesi oluşturduğunuz ve ardından sınıfın yöntemiyle deploy yapılandırmayı kullandığınız önerilen dağıtım desenini Model gösterir.


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

Tam örnek şu kaynaktan edinilebilir: https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/production-deploy-to-aks/production-deploy-to-aks.ipynb

Aşağıdaki örnekte, çalışma alanında var olan AciWebservice bir öğeyi bulma ve varsa silme işlemi gösterilmektedir; böylece ad yeniden kullanılabilir.


   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)

Modeli web hizmeti olarak dağıtmak için aşağıdakiler dahil olmak üzere çeşitli yollar vardır:

  • deployModel çalışma alanında zaten kayıtlı olan modeller için yöntemi.

  • deploy_from_imageWebservice bir modelden önceden oluşturulmuş görüntüler için yöntemi.

  • deploy_from_modelWebservice çalışma alanında kayıtlı olan modeller için yöntemi. Bu yöntem bir görüntü oluşturur.

  • deployWebservicemodeli kaydedecek ve bir görüntü oluşturacak olan yöntemini kullanır.

Web hizmetleriyle çalışma hakkında bilgi için bkz.

Değişkenler bölümünde, bulut Web hizmeti nesnesinin yerel gösteriminin öznitelikleri listelenir. Bu değişkenler salt okunur olarak kabul edilmelidir. Değerlerinin değiştirilmesi ilgili bulut nesnesine yansıtılmaz.

Değişkenler

Name Description
auth_enabled

Web hizmeti kimlik doğrulamasının etkinleştirilip etkinleştirilmediği.

compute_type
str

Web hizmetini dağıtılan işlem türü.

created_time

Web hizmeti oluşturulduğunda.

azureml.core.Webservice.description

Web hizmeti nesnesinin açıklaması.

azureml.core.Webservice.tags

Webservice nesnesi için etiket sözlüğü.

azureml.core.Webservice.name

Web hizmeti adı.

azureml.core.Webservice.properties

Web hizmeti için anahtar değeri özellikleri sözlüğü. Bu özellikler dağıtımdan sonra değiştirilemez, ancak yeni anahtar değer çiftleri eklenebilir.

created_by
str

Web hizmetini oluşturan kullanıcı.

error
str

Web hizmeti dağıtılamadıysa, bunun neden başarısız olduğuyla ilgili hata iletisini içerir.

azureml.core.Webservice.state

Web hizmeti geçerli durumu.

updated_time

Web hizmeti en son güncelleştirildiğinde.

azureml.core.Webservice.workspace

Bu Web hizmetini içeren Azure Machine Learning Çalışma Alanı.

token_auth_enabled

Web hizmeti için belirteç kimlik doğrulamasının etkinleştirilip etkinleştirilmediği.

Yöntemler

check_for_existing_webservice

Web hizmeti olup olmadığını denetleyin.

delete

Bu Web hizmetini ilişkili çalışma alanından silin.

Bu işlev çağrısı zaman uyumsuz değil. Kaynak silinene kadar çağrı çalıştırılır. modeli WebserviceException Model Yönetim Hizmeti'nden silerken bir sorun oluşur.

deploy

Sıfırdan veya daha fazla Model nesneden Bir Web hizmeti dağıtın.

Bu işlev, sağlanan tüm model dosyalarını kaydeder ve işlemde, tümü belirtilen Workspaceile ilişkili bir görüntü oluşturur. Dağıtmak için daha önce kaydedilmemiş bir model dizininiz varsa bu işlevi kullanın.

Sonuçta elde edilen Web hizmeti, çıkarım istekleri için kullanılabilecek gerçek zamanlı bir uç noktadır. Daha fazla bilgi için bkz . Web hizmeti olarak dağıtılan bir modeli kullanma.

deploy_from_image

Bir nesneden Image Web hizmeti dağıtma.

Model için oluşturulmuş bir Image nesneniz varsa bu işlevi kullanın.

Sonuçta elde edilen Web hizmeti, çıkarım istekleri için kullanılabilecek gerçek zamanlı bir uç noktadır. Daha fazla bilgi için bkz . Web hizmeti olarak dağıtılan bir modeli kullanma.

deploy_from_model

Sıfırdan veya daha fazla Model nesneden Bir Web hizmeti dağıtın.

Bu işlev ile deploybenzerdir ancak modelleri kaydetmez. Zaten kayıtlı model nesneleriniz varsa bu işlevi kullanın. Bu işlemde, belirtilen Çalışma Alanı ile ilişkili bir görüntü oluşturur.

Sonuçta elde edilen Web hizmeti, çıkarım istekleri için kullanılabilecek gerçek zamanlı bir uç noktadır. Daha fazla bilgi için bkz . Web hizmeti olarak dağıtılan bir modeli kullanma.

deploy_local_from_model

Test için bir LocalWebservice oluşturun ve dağıtın.

Docker'ın yüklenmesini ve yapılandırılmasını gerektirir.

deserialize

Model Yönetim Hizmeti yanıt JSON nesnesini Web hizmeti nesnesine dönüştürün.

Sağlanan çalışma alanı Web hizmeti altında kayıtlı çalışma alanı değilse başarısız olur.

get_keys

Bu Web hizmeti için kimlik doğrulama anahtarlarını alın.

get_logs

Bu Web hizmeti için günlükleri alın.

get_token

Bu Web hizmeti için geçerli kullanıcı kapsamına alınmış kimlik doğrulama belirtecini alın.

list

İlgili ile ilişkili Web hizmetlerini listeleyin Workspace.

Döndürülen sonuçlar parametreler kullanılarak filtrelenebilir.

regen_key

Web hizmeti anahtarlarından birini ('Birincil' veya 'İkincil' anahtar) yeniden üretin.

WebserviceException belirtilmezse key veya 'Birincil' veya 'İkincil' değilse bir oluşturulur.

run

Sağlanan girişle bu Web hizmetini çağırın.

öğesinin alt sınıfları Webservicetarafından uygulanan soyut yöntem.

serialize

Bu Web hizmeti nesnesini JSON serileştirilmiş sözlüğüne dönüştürün.

Bir Web hizmeti nesnesine geri dönüştürmek için kullanın deserialize .

update

Web hizmeti parametrelerini güncelleştirin.

Bu, alt sınıfları tarafından uygulanan soyut bir yöntemdir Webservice. Güncelleştirilecek olası parametreler Web hizmeti alt türüne göre değişir. Örneğin, Azure Container Instances web hizmetleri için bkzupdate. belirli parametreler için.

update_deployment_state

Bellek içi nesnenin geçerli durumunu yenileyin.

İlgili bulut nesnesinin geçerli durumuna bağlı olarak nesnenin özelliklerinin yerinde güncelleştirmesini gerçekleştirin. Oluşturma durumunun el ile yoklanması için öncelikli olarak yararlıdır.

wait_for_deployment

Çalışan Web hizmeti dağıtımında otomatik olarak yoklama.

Web hizmeti'nin terminal durumuna ulaşmasını bekleyin. Başarılı olmayan bir terminal durumuna ulaşırsa veya sağlanan zaman aşımını aşarsa bir WebserviceException oluşturur.

check_for_existing_webservice

Web hizmeti olup olmadığını denetleyin.

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

Parametreler

Name Description
workspace
Gerekli
name
Gerekli
str
overwrite
varsayılan değer: False
request_func
<xref:function>

hizmet adının mevcut olup olmadığını denetlemek için hizmet isteğinde bulunma işlevi

varsayılan değer: None
check_func
<xref:function>

request_func yanıt içeriğini denetleme işlevi

varsayılan değer: None

Özel durumlar

Tür Description

delete

Bu Web hizmetini ilişkili çalışma alanından silin.

Bu işlev çağrısı zaman uyumsuz değil. Kaynak silinene kadar çağrı çalıştırılır. modeli WebserviceException Model Yönetim Hizmeti'nden silerken bir sorun oluşur.

delete()

Özel durumlar

Tür Description

deploy

Sıfırdan veya daha fazla Model nesneden Bir Web hizmeti dağıtın.

Bu işlev, sağlanan tüm model dosyalarını kaydeder ve işlemde, tümü belirtilen Workspaceile ilişkili bir görüntü oluşturur. Dağıtmak için daha önce kaydedilmemiş bir model dizininiz varsa bu işlevi kullanın.

Sonuçta elde edilen Web hizmeti, çıkarım istekleri için kullanılabilecek gerçek zamanlı bir uç noktadır. Daha fazla bilgi için bkz . Web hizmeti olarak dağıtılan bir modeli kullanma.

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

Parametreler

Name Description
workspace
Gerekli

Web hizmetini ilişkilendirmek için bir Çalışma Alanı nesnesi.

name
Gerekli
str

Dağıtılan hizmeti vermek için gereken ad. Çalışma alanına özgü olmalıdır, yalnızca küçük harflerden, sayılardan veya kısa çizgilerden oluşmalıdır, bir harfle başlamalıdır ve 3 ila 32 karakter uzunluğunda olmalıdır.

model_paths
Gerekli

Dosyaları veya klasörü modellemek için disk üzerindeki yolların listesi. Boş bir liste olabilir.

image_config
Gerekli

Gerekli Görüntü özelliklerini belirlemek için kullanılan bir ImageConfig nesnesi.

deployment_config

Web hizmetini yapılandırmak için kullanılan bir WebserviceDeploymentConfiguration. Sağlanmazsa, istenen hedefe göre boş bir yapılandırma nesnesi kullanılır.

varsayılan değer: None
deployment_target

Web hizmetini dağıtmak için A ComputeTarget . Azure Container Instances ilişkili ComputeTargetolmadığından, Azure Container Instances dağıtmak için bu parametreyi Yok olarak bırakın.

varsayılan değer: None
overwrite

Adlı hizmet zaten varsa mevcut hizmetin üzerine yazın.

varsayılan değer: False

Döndürülenler

Tür Description

Dağıtılan web hizmetiyle ilgili bir Web hizmeti nesnesi.

Özel durumlar

Tür Description

deploy_from_image

Bir nesneden Image Web hizmeti dağıtma.

Model için oluşturulmuş bir Image nesneniz varsa bu işlevi kullanın.

Sonuçta elde edilen Web hizmeti, çıkarım istekleri için kullanılabilecek gerçek zamanlı bir uç noktadır. Daha fazla bilgi için bkz . Web hizmeti olarak dağıtılan bir modeli kullanma.

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

Parametreler

Name Description
workspace
Gerekli

Web hizmetini ilişkilendirmek için bir Çalışma Alanı nesnesi.

name
Gerekli
str

Dağıtılan hizmeti vermek için gereken ad. Çalışma alanına özgü olmalıdır, yalnızca küçük harflerden, sayılardan veya kısa çizgilerden oluşmalıdır, bir harfle başlamalıdır ve 3 ila 32 karakter uzunluğunda olmalıdır.

image
Gerekli

Dağıtılacak Image nesne.

deployment_config

Web hizmetini yapılandırmak için kullanılan bir WebserviceDeploymentConfiguration. Sağlanmazsa, istenen hedefe göre boş bir yapılandırma nesnesi kullanılır.

varsayılan değer: None
deployment_target

Web hizmetini dağıtmak için A ComputeTarget . Azure Container Instances ilişkili ComputeTargetolmadığından, Azure Container Instances dağıtmak için bu parametreyi Yok olarak bırakın.

varsayılan değer: None
overwrite

Adlı hizmet zaten varsa mevcut hizmetin üzerine yazın.

varsayılan değer: False

Döndürülenler

Tür Description

Dağıtılan web hizmetiyle ilgili bir Web hizmeti nesnesi.

Özel durumlar

Tür Description

deploy_from_model

Sıfırdan veya daha fazla Model nesneden Bir Web hizmeti dağıtın.

Bu işlev ile deploybenzerdir ancak modelleri kaydetmez. Zaten kayıtlı model nesneleriniz varsa bu işlevi kullanın. Bu işlemde, belirtilen Çalışma Alanı ile ilişkili bir görüntü oluşturur.

Sonuçta elde edilen Web hizmeti, çıkarım istekleri için kullanılabilecek gerçek zamanlı bir uç noktadır. Daha fazla bilgi için bkz . Web hizmeti olarak dağıtılan bir modeli kullanma.

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

Parametreler

Name Description
workspace
Gerekli

Web hizmetini ilişkilendirmek için bir Çalışma Alanı nesnesi.

name
Gerekli
str

Dağıtılan hizmeti vermek için gereken ad. Çalışma alanına özgü olmalıdır, yalnızca küçük harflerden, sayılardan veya kısa çizgilerden oluşmalıdır, bir harfle başlamalıdır ve 3 ila 32 karakter uzunluğunda olmalıdır.

models
Gerekli

Model nesnelerinin listesi. Boş bir liste olabilir.

image_config
Gerekli

Gerekli Görüntü özelliklerini belirlemek için kullanılan bir ImageConfig nesnesi.

deployment_config

Web hizmetini yapılandırmak için kullanılan bir WebserviceDeploymentConfiguration. Sağlanmazsa, istenen hedefe göre boş bir yapılandırma nesnesi kullanılır.

varsayılan değer: None
deployment_target

Web hizmetini dağıtmak için A ComputeTarget . ACI'nin ilişkili ComputeTargetbir parametresi olmadığından, ACI'ye dağıtmak için bu parametreyi Yok olarak bırakın.

varsayılan değer: None
overwrite

Adlı hizmet zaten varsa mevcut hizmetin üzerine yazın.

varsayılan değer: False

Döndürülenler

Tür Description

Dağıtılan web hizmetiyle ilgili bir Web hizmeti nesnesi.

Özel durumlar

Tür Description

deploy_local_from_model

Test için bir LocalWebservice oluşturun ve dağıtın.

Docker'ın yüklenmesini ve yapılandırılmasını gerektirir.

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

Parametreler

Name Description
workspace
Gerekli

Web hizmetini ilişkilendirmek için bir Çalışma Alanı nesnesi.

name
Gerekli
str

Dağıtılan hizmeti vermek için gereken ad. Yerel makinede benzersiz olmalıdır.

models
Gerekli

Model nesnelerinin listesi. Boş bir liste olabilir.

image_config
Gerekli

Gerekli hizmet görüntüsü özelliklerini belirlemek için kullanılan bir ImageConfig nesnesi.

deployment_config

Web hizmetini yapılandırmak için kullanılan bir LocalWebserviceDeploymentConfiguration. Sağlanmazsa, boş bir yapılandırma nesnesi kullanılır.

varsayılan değer: None
wait

LocalWebservice'in Docker kapsayıcısının iyi durumda olarak raporlanmasının beklenip beklenmeyeceği. Kapsayıcı kilitlenirse bir özel durum oluşturur. Varsayılan değer False'tur.

varsayılan değer: False

Döndürülenler

Tür Description

Özel durumlar

Tür Description

deserialize

Model Yönetim Hizmeti yanıt JSON nesnesini Web hizmeti nesnesine dönüştürün.

Sağlanan çalışma alanı Web hizmeti altında kayıtlı çalışma alanı değilse başarısız olur.

deserialize(workspace, webservice_payload)

Parametreler

Name Description
cls
Gerekli

Bunun bir sınıf yöntemi olduğunu gösterir.

workspace
Gerekli

Web hizmeti'nin kayıtlı olduğu çalışma alanı nesnesi.

webservice_payload
Gerekli

Web hizmeti nesnesine dönüştürülecek JSON nesnesi.

Döndürülenler

Tür Description

Sağlanan JSON nesnesinin Web hizmeti gösterimi.

Özel durumlar

Tür Description

get_keys

Bu Web hizmeti için kimlik doğrulama anahtarlarını alın.

get_keys()

Döndürülenler

Tür Description
(str, str)

Bu Web hizmeti için kimlik doğrulama anahtarları.

Özel durumlar

Tür Description

get_logs

Bu Web hizmeti için günlükleri alın.

get_logs(num_lines=5000, init=False)

Parametreler

Name Description
num_lines
int

Alınacak günlük satırı sayısı üst sınırı.

varsayılan değer: 5000
init

init kapsayıcısının günlüklerini alma

varsayılan değer: False

Döndürülenler

Tür Description
str

Bu Web hizmeti için günlükler.

Özel durumlar

Tür Description

get_token

Bu Web hizmeti için geçerli kullanıcı kapsamına alınmış kimlik doğrulama belirtecini alın.

get_token()

Döndürülenler

Tür Description

Bu Web hizmeti için kimlik doğrulama belirteci ve sonrasında ne zaman yenilenmesi gerektiği.

Özel durumlar

Tür Description

list

İlgili ile ilişkili Web hizmetlerini listeleyin Workspace.

Döndürülen sonuçlar parametreler kullanılarak filtrelenebilir.

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)

Parametreler

Name Description
workspace
Gerekli

Web hizmetlerinin listel olduğu Çalışma Alanı nesnesi.

compute_type
str

Yalnızca belirli Web hizmeti türlerini listelemek için filtreleyin. Seçenekler :'ACI', 'AKS'.

varsayılan değer: None
image_name
str

Listeyi yalnızca belirli bir görüntü adıyla dağıtılan Web hizmetlerini içerecek şekilde filtreleyin.

varsayılan değer: None
image_id
str

Listeyi yalnızca belirli görüntü kimliğiyle dağıtılan Web hizmetlerini içerecek şekilde filtreleyin.

varsayılan değer: None
model_name
str

Listeyi yalnızca belirli model adıyla dağıtılan Web hizmetlerini içerecek şekilde filtreleyin.

varsayılan değer: None
model_id
str

Listeyi yalnızca belirli model kimliğiyle dağıtılan Web hizmetlerini içerecek şekilde filtreleyin.

varsayılan değer: None
tags

Sağlanan listeye göre 'key' veya '[key, value]' ölçütüne göre filtreleyin. Örn. ['key', ['key2', 'key2 value']]

varsayılan değer: None
properties

Sağlanan listeye göre 'key' veya '[key, value]' ölçütüne göre filtreleyin. Örn. ['key', ['key2', 'key2 value']]

varsayılan değer: None
image_digest
str

Listeyi yalnızca belirli görüntü özetiyle dağıtılan Web hizmetlerini içerecek şekilde filtreleyin.

varsayılan değer: None

Döndürülenler

Tür Description

Sağlanan Çalışma Alanında web hizmetlerinin filtrelenmiş listesi.

Özel durumlar

Tür Description

regen_key

Web hizmeti anahtarlarından birini ('Birincil' veya 'İkincil' anahtar) yeniden üretin.

WebserviceException belirtilmezse key veya 'Birincil' veya 'İkincil' değilse bir oluşturulur.

regen_key(key, set_key=None)

Parametreler

Name Description
key
Gerekli
str

Yeniden oluşturulacak anahtar. Seçenekler 'Birincil' veya 'İkincil' şeklindedir.

set_key
str

Anahtar değerinin el ile belirtimine izin veren kullanıcı tarafından belirtilen değer

varsayılan değer: None

Özel durumlar

Tür Description

run

Sağlanan girişle bu Web hizmetini çağırın.

öğesinin alt sınıfları Webservicetarafından uygulanan soyut yöntem.

abstract run(input)

Parametreler

Name Description
input
Gerekli
<xref:varies>

Web hizmetini çağırmak için giriş verileri. Bu, makine öğrenmesi modelinizin tahminleri çalıştırmak için giriş olarak beklediği verilerdir.

Döndürülenler

Tür Description

Web hizmetini çağırmanın sonucu. Bu, makine öğrenmesi modelinizden çalıştırılacak tahminleri döndürür.

Özel durumlar

Tür Description

serialize

Bu Web hizmeti nesnesini JSON serileştirilmiş sözlüğüne dönüştürün.

Bir Web hizmeti nesnesine geri dönüştürmek için kullanın deserialize .

serialize()

Döndürülenler

Tür Description

Bu Web hizmetini JSON gösterimi.

Özel durumlar

Tür Description

update

Web hizmeti parametrelerini güncelleştirin.

Bu, alt sınıfları tarafından uygulanan soyut bir yöntemdir Webservice. Güncelleştirilecek olası parametreler Web hizmeti alt türüne göre değişir. Örneğin, Azure Container Instances web hizmetleri için bkzupdate. belirli parametreler için.

abstract update(*args)

Parametreler

Name Description
args
Gerekli
<xref:varies>

Güncelleştirilecek değerler.

Özel durumlar

Tür Description

update_deployment_state

Bellek içi nesnenin geçerli durumunu yenileyin.

İlgili bulut nesnesinin geçerli durumuna bağlı olarak nesnenin özelliklerinin yerinde güncelleştirmesini gerçekleştirin. Oluşturma durumunun el ile yoklanması için öncelikli olarak yararlıdır.

update_deployment_state()

Özel durumlar

Tür Description

wait_for_deployment

Çalışan Web hizmeti dağıtımında otomatik olarak yoklama.

Web hizmeti'nin terminal durumuna ulaşmasını bekleyin. Başarılı olmayan bir terminal durumuna ulaşırsa veya sağlanan zaman aşımını aşarsa bir WebserviceException oluşturur.

wait_for_deployment(show_output=False, timeout_sec=None)

Parametreler

Name Description
show_output

Daha ayrıntılı çıktı yazdırılıp yazdırılmayacağını gösterir.

varsayılan değer: False
timeout_sec

Dağıtım belirtilen zaman aşımını aşarsa bir özel durum tetikleyin.

varsayılan değer: None

Özel durumlar

Tür Description