AksWebservice Sınıf

  • Başvuru

Azure Kubernetes Service'da web hizmeti uç noktası olarak dağıtılan makine öğrenmesi modelini temsil eder.

Dağıtılan hizmet model, betik ve ilişkili dosyalardan oluşturulur. Sonuçta elde edilen web hizmeti, REST API'ye sahip yük dengeli bir HTTP uç noktasıdır. Bu API'ye veri gönderebilir ve model tarafından döndürülen tahmini alabilirsiniz.

AksWebservice tek bir uç noktaya tek bir hizmet dağıtır. Bir uç noktaya birden çok hizmet dağıtmak için sınıfını AksEndpoint kullanın.

Daha fazla bilgi için bkz. Modeli Azure Kubernetes Service kümesine 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
AksWebservice

Oluşturucu

AksWebservice(workspace, name)

Parametreler

Name Description
workspace
Gerekli
Workspace

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

Alınacak Web hizmeti nesnesinin adı.

Açıklamalar

Önerilen dağıtım düzeni, yöntemiyle deploy_configuration bir dağıtım yapılandırma nesnesi oluşturmak ve ardından aşağıda gösterildiği gibi sınıfın Model yöntemiyle deploy kullanmaktır.


   # 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

Modeli web hizmeti olarak dağıtmanın çeşitli yolları vardır; örneğin:

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

  • deploy_from_imageyöntemi.Webservice

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

  • deploy Webservicemodeli 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 AksWebservice 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
enable_app_insights
bool

Web hizmeti için AppInsights günlüğünün etkinleştirilip etkinleştirilmediği.
autoscaler
AutoScaler

Web hizmeti için Otomatik Ölçeklendirici nesnesi.
compute_name
str

Webhizmetinin dağıtılacağı ComputeTarget'in adı.
container_resource_requirements
ContainerResourceRequirements

Web hizmeti için kapsayıcı kaynak gereksinimleri.
liveness_probe_requirements
LivenessProbeRequirements

Web hizmeti için canlılık yoklaması gereksinimleri.
data_collection
DataCollection

Web hizmeti için DataCollection nesnesi.
max_concurrent_requests_per_container
int

Web hizmeti için kapsayıcı başına en fazla eşzamanlı istek sayısı.
max_request_wait_time
int

Web hizmeti için milisaniye cinsinden maksimum istek bekleme süresi.
num_replicas
int

Web hizmeti için çoğaltma sayısı. Her çoğaltma bir AKS pod'una karşılık gelir.
scoring_timeout_ms
int

Web hizmeti için milisaniye cinsinden puanlama zaman aşımı.
azureml.core.webservice.AksWebservice.scoring_uri
str

Web hizmeti için puanlama uç noktası
is_default
bool

Web hizmeti üst AksEndpoint için varsayılan sürümse.
traffic_percentile
int

Üst AksEndpoint'te Web hizmetine yönlendirecek trafiğin yüzdesi.
version_type
VersionType

Üst AksEndpoint'teki Web hizmeti için sürüm türü.
token_auth_enabled
bool

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

Web hizmetini oluşturmak için kullanılan Ortam nesnesi.
azureml.core.webservice.AksWebservice.models
list[Model]

Webservice'e dağıtılan Modellerin listesi.
deployment_status
str

Web hizmeti dağıtım durumu.
namespace
str

Web hizmeti AKS ad alanı.
azureml.core.webservice.AksWebservice.swagger_uri
str

Web hizmeti için swagger uç noktası.

Yöntemler

add_properties

Bu Web hizmeti özellikleri sözlüğüne anahtar değer çiftleri ekleyin.
add_tags

Bu Web hizmeti etiketleri sözlüğüne anahtar değer çiftleri ekleyin.

bir WebserviceExceptionoluşturur.
deploy_configuration

AKS işlem hedefine dağıtmak için bir yapılandırma nesnesi oluşturun.
get_access_token

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

KALDIRIL -MIŞ. Bunun yerine yöntemini kullanın get_access_token .

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

Belirtilen anahtarları bu Web hizmetindeki etiket sözlüğünden kaldırın.
run

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

Bu Web hizmetini JSON serileştirilmiş sözlüğe dönüştürün.
update

Sağlanan özelliklerle Web hizmetini güncelleştirin.

Hiçbiri olarak bırakılan değerler bu Web hizmetindeki değişmeden kalır.

add_properties

Bu Web hizmeti özellikleri sözlüğüne anahtar değer çiftleri ekleyin.

add_properties(properties)

Parametreler

Name Description
properties
Gerekli
dict[str, str]

Eklenecek özelliklerin sözlüğü.

add_tags

Bu Web hizmeti etiketleri sözlüğüne anahtar değer çiftleri ekleyin.

bir WebserviceExceptionoluşturur.

add_tags(tags)

Parametreler

Name Description
tags
Gerekli
dict[str, str]

Eklenecek etiketlerin sözlüğü.

Özel durumlar

Tür Description
WebserviceException

deploy_configuration

AKS işlem hedefine dağıtmak için bir yapılandırma nesnesi oluşturun.

static deploy_configuration(autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, primary_key=None, secondary_key=None, tags=None, properties=None, description=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, compute_target_name=None, cpu_cores_limit=None, memory_gb_limit=None, blobfuse_enabled=None)

Parametreler

Name Description
autoscale_enabled
bool

Bu Web hizmeti için otomatik ölçeklendirmenin etkinleştirilip etkinleştirilmeyileceği. num_replicas Yok ise varsayılan olarak True olur.

Default value: None
autoscale_min_replicas
int

Bu Web hizmetini otomatik olarak ölçeklerken kullanılacak en az kapsayıcı sayısı. Varsayılan değer 1'tir.

Default value: None
autoscale_max_replicas
int

Bu Web hizmetini otomatik ölçeklendirme sırasında kullanılacak kapsayıcı sayısı üst sınırı. Varsayılan değer 10'dır.

Default value: None
autoscale_refresh_seconds
int

Otomatik ölçeklendiricinin bu Web hizmetini ölçeklendirmeye çalışma sıklıkları. Varsayılan değer 1'tir.

Default value: None
autoscale_target_utilization
int

Otomatik ölçeklendiricinin bu Web hizmeti için korumayı denemesi gereken hedef kullanım (100'ün yüzdesinde). Varsayılan değer 70'tir.

Default value: None
collect_model_data
bool

Bu Web hizmeti için model veri toplamanın etkinleştirilip etkinleştirilmeyileceği. Varsayılan değer False'tur.

Default value: None
auth_enabled
bool

Bu Web hizmeti için anahtar kimlik doğrulamasının etkinleştirilip etkinleştirilmeyileceği. Varsayılan değer True'dır.

Default value: None
cpu_cores
float

Bu Web hizmeti için ayrılacak cpu çekirdeği sayısı. Ondalık olabilir. Varsayılan olarak 0.1'i kullanır. Azure Kubernetes Service'daki sınıra değil pod çekirdeği isteğine karşılık gelir.

Default value: None
memory_gb
float

Bu Web hizmeti için ayrılacak bellek miktarı (GB cinsinden). Ondalık olabilir. Varsayılan değer 0,5'tir. Azure Kubernetes Service'daki sınıra değil pod bellek isteğine karşılık gelir.

Default value: None
enable_app_insights
bool

Bu Web hizmeti için Application Insights günlüğünün etkinleştirilip etkinleştirilmeyileceği. Varsayılan değer False'tur.

Default value: None
scoring_timeout_ms
int

Bu Web hizmetine yapılan puanlama çağrıları için zorlanması gereken zaman aşımı. Varsayılan değer 60000'tir.

Default value: None
replica_max_concurrent_requests
int

Bu Web hizmeti için izin verilen çoğaltma başına en fazla eşzamanlı istek sayısı. Varsayılan değer 1'tir. Microsoft Teknik Destek veya Azure Machine Learning ekibinin bir üyesi tarafından belirtilmediği sürece bu ayarı varsayılan değer olan 1'den değiştirmeyin.

Default value: None
max_request_wait_time
int

Bir isteğin 503 hatası döndürmeden önce kuyrukta kalacağı (milisaniye cinsinden) maksimum süre. Varsayılan değer 500'dır.

Default value: None
num_replicas
int

Bu Web hizmeti için ayrılacak kapsayıcı sayısı. Varsayılan değildir, bu parametre ayarlanmadıysa otomatik ölçeklendirici varsayılan olarak etkinleştirilir.

Default value: None
primary_key
str

Bu Web hizmeti için kullanılacak birincil kimlik doğrulama anahtarı.

Default value: None
secondary_key
str

Bu Web hizmeti için kullanılacak ikincil kimlik doğrulama anahtarı.

Default value: None
tags
dict[str, str]

Bu Web hizmetini vermek için anahtar değer etiketleri sözlüğü.

Default value: None
properties
dict[str, str]

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

Default value: None
description
str

Bu Web hizmetini vermek için bir açıklama.

Default value: None
gpu_cores
int

Bu Web hizmeti için ayrılacak GPU çekirdeği sayısı. Varsayılan değer 0'dır.

Default value: None
period_seconds
int

Canlılık araştırmasını gerçekleştirme sıklığı (saniye cinsinden). Varsayılan olarak 10 saniyedir. En düşük değer 1'dir.

Default value: None
initial_delay_seconds
int

Canlılık yoklamaları başlatılmadan önce kapsayıcı başlatıldıktan sonraki saniye sayısı. Varsayılan değer 310'dır.

Default value: None
timeout_seconds
int

Canlılık araştırmasının zaman aşımına uğradıktan sonra geçmesi gereken saniye sayısı. Varsayılan değer 2 saniyedir. En düşük değer 1'dir.

Default value: None
success_threshold
int

Canlılık araştırması için ardışık en düşük başarılar başarısız olduktan sonra başarılı olarak kabul edilir. Varsayılan değer 1'tir. En düşük değer 1'dir.

Default value: None
failure_threshold
int

Bir Pod başlatıldığında ve canlılık yoklaması başarısız olduğunda Kubernetes vazgeçmeden önce failureThreshold sürelerini dener. Varsayılan değer 3'tir. En düşük değer 1'dir.

Default value: None
namespace
str

Bu Web hizmetinin dağıtılacağı Kubernetes ad alanı: en fazla 63 küçük harf alfasayısal ('a'-'z', '0'-'9') ve kısa çizgi ('-') karakter. İlk ve son karakterler kısa çizgi olamaz.

Default value: None
token_auth_enabled
bool

Bu Web hizmeti için Belirteç kimlik doğrulamasının etkinleştirilip etkinleştirilmeyileceği. Bu etkinleştirilirse, kullanıcılar Azure Active Directory kimlik bilgilerini kullanarak bir erişim belirteci getirerek bu Web hizmeti'ne erişebilir. Varsayılan değer False'tur.

Default value: None
compute_target_name
str

Dağıtılacak işlem hedefinin adı

Default value: None
cpu_cores_limit
float

Bu Web hizmetini kullanmasına izin verilen en fazla cpu çekirdeği sayısı. Ondalık olabilir.

Default value: None
memory_gb_limit
float

Bu Web hizmetini kullanmasına izin verilen maksimum bellek miktarı (GB cinsinden). Ondalık olabilir.

Default value: None
blobfuse_enabled
bool

Bu Web hizmeti için model indirme için blobfuse'un etkinleştirilip etkinleştirilmeyileceği. Varsayılan değer True'dır

Default value: None

Döndürülenler

Tür Description
AksServiceDeploymentConfiguration

AksWebservice dağıtırken kullanılacak yapılandırma nesnesi.

Özel durumlar

Tür Description
WebserviceException

get_access_token

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

get_access_token()

Döndürülenler

Tür Description
AksServiceAccessToken

Bu Web hizmeti için kimlik doğrulama belirtecini açıklayan bir nesne.

Özel durumlar

Tür Description
WebserviceException

get_token

KALDIRIL -MIŞ. Bunun yerine yöntemini kullanın get_access_token .

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

get_token()

Döndürülenler

Tür Description
str, datetime

Bu Web hizmeti için kimlik doğrulama belirteci ve ne zaman yenilenmesi gerekir.

Özel durumlar

Tür Description
WebserviceException

remove_tags

Belirtilen anahtarları bu Web hizmetindeki etiket sözlüğünden kaldırın.

remove_tags(tags)

Parametreler

Name Description
tags
Gerekli
list[str]

Kaldırılacak anahtarların listesi

run

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

run(input_data)

Parametreler

Name Description
input_data
Gerekli
<xref:varies>

Ile Web hizmetini çağırmak için giriş

Döndürülenler

Tür Description
dict

Web hizmetini çağırmanın sonucu

Özel durumlar

Tür Description
WebserviceException

serialize

Bu Web hizmetini JSON serileştirilmiş sözlüğe dönüştürün.

serialize()

Döndürülenler

Tür Description
dict

Bu Web hizmetini JSON gösterimi.

update

Sağlanan özelliklerle Web hizmetini güncelleştirin.

Hiçbiri olarak bırakılan değerler bu Web hizmetindeki değişmeden kalır.

update(image=None, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, tags=None, properties=None, description=None, models=None, inference_config=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, cpu_cores_limit=None, memory_gb_limit=None, **kwargs)

Parametreler

Name Description
image
Image

Webhizmetine dağıtılacak yeni görüntü

Default value: None
autoscale_enabled
bool

Bu Web hizmetini otomatik ölçeklendirmeyi etkinleştir veya devre dışı bırak

Default value: None
autoscale_min_replicas
int

Bu Web hizmetini otomatik olarak ölçeklerken kullanılacak en az kapsayıcı sayısı

Default value: None
autoscale_max_replicas
int

Bu Web hizmetini otomatik ölçeklerken kullanılacak kapsayıcı sayısı üst sınırı

Default value: None
autoscale_refresh_seconds
int

Otomatik ölçeklendiricinin bu Web hizmetini ölçeklendirmeyi ne sıklıkta denemesi gerekir?

Default value: None
autoscale_target_utilization
int

Otomatik ölçeklendiricinin bu Web hizmeti için korumayı denemesi gereken hedef kullanım (yüzde 100'de)

Default value: None
collect_model_data
bool

Bu Web hizmeti için model veri toplamayı etkinleştirme veya devre dışı bırakma

Default value: None
auth_enabled
bool

Bu Web hizmeti için kimlik doğrulamasının etkinleştirilip etkinleştirilmeyileceği

Default value: None
cpu_cores
float

Bu Web hizmeti için ayrılacak cpu çekirdeği sayısı. Ondalık olabilir

Default value: None
memory_gb
float

Bu Web hizmeti için ayrılacak bellek miktarı (GB cinsinden). Ondalık olabilir

Default value: None
enable_app_insights
bool

Bu Web hizmeti için Application Insights günlüğünün etkinleştirilip etkinleştirilmeyileceği

Default value: None
scoring_timeout_ms
int

Bu Web hizmetine yapılan puanlama çağrıları için zorunlu kılınacak zaman aşımı

Default value: None
replica_max_concurrent_requests
int

Bu Web hizmeti için izin verilen çoğaltma başına en fazla eşzamanlı istek sayısı.

Default value: None
max_request_wait_time
int

Bir isteğin 503 hatası döndürmeden önce kuyrukta (milisaniye cinsinden) kalacağı en uzun süre

Default value: None
num_replicas
int

Bu Web hizmeti için ayrılacak kapsayıcı sayısı

Default value: None
tags
dict[str, str]

Bu Web hizmetini vermek için anahtar değer etiketleri sözlüğü. Mevcut etiketlerin yerini alır.

Default value: None
properties
dict[str, str]

Var olan özellikler sözlüğüne eklenecek anahtar değeri özellikleri sözlüğü

Default value: None
description
str

Bu Web hizmetini vermek için bir açıklama

Default value: None
models
list[Model]

Güncelleştirilmiş hizmetle paketlenecek Model nesnelerinin listesi

Default value: None
inference_config
InferenceConfig

Gerekli model dağıtım özelliklerini sağlamak için kullanılan inferenceConfig nesnesi.

Default value: None
gpu_cores
int

Bu Web hizmeti için ayrılacak gpu çekirdeği sayısı

Default value: None
period_seconds
int

Canlılık araştırmasını gerçekleştirme sıklığını (saniye olarak). Varsayılan olarak 10 saniyedir. En düşük değer 1'dir.

Default value: None
initial_delay_seconds
int

Canlılık yoklamaları başlatılmadan önce kapsayıcı başlatıldıktan sonraki saniye sayısı.

Default value: None
timeout_seconds
int

Canlılık yoklamasının zaman aşımına uğradıktan sonraki saniye sayısı. Varsayılan değer 1 saniyedir. En düşük değer 1'dir.

Default value: None
success_threshold
int

Canlılık araştırmasının başarısız olduktan sonra başarılı olarak kabul edilmesi için en düşük ardışık başarılar. Varsayılan olarak 1'e ayarlanır. En düşük değer 1'dir.

Default value: None
failure_threshold
int

Pod başlatıldığında ve canlılık yoklaması başarısız olduğunda Kubernetes, vazgeçmeden önce failureThreshold sürelerini dener. Varsayılan değer 3'tir. En düşük değer 1'dir.

Default value: None
namespace
str

Bu Web hizmetinin dağıtılacağı Kubernetes ad alanı: en fazla 63 küçük alfasayısal ('a'-'z', '0'-'9') ve kısa çizgi ('-') karakterleri. İlk ve son karakterler kısa çizgi olamaz.

Default value: None
token_auth_enabled
bool

Bu Web hizmeti için Belirteç kimlik doğrulamasının etkinleştirilip etkinleştirilmeyileceği. Bu etkinleştirilirse, kullanıcılar Azure Active Directory kimlik bilgilerini kullanarak erişim belirtecini getirerek bu Web hizmeti'ne erişebilir. Varsayılan değer False'tur

Default value: None
cpu_cores_limit
float

Bu Web hizmetini kullanmasına izin verilen en fazla cpu çekirdeği sayısı. Ondalık olabilir.

Default value: None
memory_gb_limit
float

Bu Web hizmetini kullanmasına izin verilen maksimum bellek miktarı (GB cinsinden). Ondalık olabilir.

Default value: None
kwargs
Gerekli
<xref:varies>

AKS web hizmetinin Kubernetes çevrimiçi uç noktasına ve dağıtımına geçirilmesini desteklemek için parametreleri dahil edin. is_migration=Doğru| False, compute_target=.

Özel durumlar

Tür Description
WebserviceException