Sdílet prostřednictvím


AksWebservice Třída

Představuje model strojového učení nasazený jako koncový bod webové služby ve službě Azure Kubernetes Service.

Nasazená služba se vytvoří z modelu, skriptu a přidružených souborů. Výsledná webová služba je koncový bod HTTP s vyrovnáváním zatížení s rozhraním REST API. Do tohoto rozhraní API můžete odesílat data a přijímat predikce vrácené modelem.

AksWebservice nasadí jednu službu do jednoho koncového bodu. Pokud chcete nasadit více služeb do jednoho koncového AksEndpoint bodu, použijte třídu.

Další informace najdete v tématu Nasazení modelu do clusteru Azure Kubernetes Service.

Inicializuje instanci webové služby.

Konstruktor webservice načte cloudovou reprezentaci objektu webové služby přidruženého k poskytnutému pracovnímu prostoru. Vrátí instanci podřízené třídy odpovídající určitému typu načteného objektu webservice.

Konstruktor

AksWebservice(workspace, name)

Parametry

Name Description
workspace
Vyžadováno

Objekt pracovního prostoru obsahující objekt webové služby, který se má načíst.

name
Vyžadováno
str

Název objektu webové služby, který se má načíst.

Poznámky

Doporučeným vzorem nasazení je vytvoření objektu konfigurace nasazení s deploy_configuration metodou a jeho následné použití s deploy metodou Model třídy, jak je znázorněno níže.


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

Model můžete nasadit jako webovou službu několika způsoby, včetně následujících:

  • deploy metodu Model pro modely, které jsou již zaregistrovány v pracovním prostoru.

  • deploy_from_image metodou Webservice.

  • deploy_from_model Webservice metoda pro modely, které jsou již registrovány v pracovním prostoru. Tato metoda vytvoří image.

  • deploy Webservice, který zaregistruje model a vytvoří image.

Informace o práci s webovými službami najdete v tématu

Oddíl Variables uvádí atributy místní reprezentace cloudového objektu AksWebservice. Tyto proměnné by se měly považovat za jen pro čtení. Změna jejich hodnot se neprojeví v odpovídajícím cloudovém objektu.

Proměnné

Name Description
enable_app_insights

Bez ohledu na to, jestli je pro webovou službu povolené protokolování Služby AppInsights.

autoscaler

Objekt automatického škálování pro webovou službu.

compute_name
str

Název ComputeTargetu, do kterého je webová služba nasazena.

container_resource_requirements

Požadavky na prostředky kontejneru pro webovou službu.

liveness_probe_requirements

Požadavky sondy aktivity pro webovou službu.

data_collection

Objekt DataCollection pro webservice.

max_concurrent_requests_per_container
int

Maximální počet souběžných požadavků na kontejner pro webovou službu.

max_request_wait_time
int

Maximální doba čekání na požadavek pro webovou službu v milisekundách.

num_replicas
int

Počet replik pro webovou službu. Každá replika odpovídá podu AKS.

scoring_timeout_ms
int

Časový limit bodování pro webovou službu v milisekundách

azureml.core.webservice.AksWebservice.scoring_uri
str

Bodovací koncový bod pro webovou službu

is_default

Pokud je webová služba výchozí verzí nadřazeného bodu AksEndpoint.

traffic_percentile
int

Jaké procento provozu pro směrování do webové služby v nadřazené AksEndpoint.

version_type

Typ verze pro webovou službu v nadřazené AksEndpoint.

token_auth_enabled

Určuje, jestli je pro webovou službu povolené ověřování tokenů nebo ne.

environment

Objekt Prostředí, který byl použit k vytvoření webové služby.

azureml.core.webservice.AksWebservice.models

Seznam modelů nasazených do webové služby

deployment_status
str

Stav nasazení webové služby.

namespace
str

Obor názvů AKS webové služby.

azureml.core.webservice.AksWebservice.swagger_uri
str

Koncový bod swaggeru pro webovou službu.

Metody

add_properties

Přidejte páry klíč-hodnota do slovníku vlastností této webové služby.

add_tags

Přidejte páry klíč-hodnota do slovníku značek této webové služby.

Vyvolá .WebserviceException

deploy_configuration

Vytvořte objekt konfigurace pro nasazení do cílového výpočetního objektu AKS.

get_access_token

Načtěte ověřovací token pro tuto webovou službu.

get_token

ZAVRHOVANÝ. Místo toho použijte get_access_token metodu.

Načtěte ověřovací token pro tuto webovou službu.

remove_tags

Odeberte zadané klíče ze slovníku značek této webové služby.

run

Zavolejte tuto webovou službu se zadaným vstupem.

serialize

Převeďte tuto webovou službu na serializovaný slovník JSON.

update

Aktualizujte webovou službu se zadanými vlastnostmi.

Hodnoty ponechané jako Žádné zůstanou v této webové službě beze změny.

add_properties

Přidejte páry klíč-hodnota do slovníku vlastností této webové služby.

add_properties(properties)

Parametry

Name Description
properties
Vyžadováno

Slovník vlastností, které chcete přidat.

add_tags

Přidejte páry klíč-hodnota do slovníku značek této webové služby.

Vyvolá .WebserviceException

add_tags(tags)

Parametry

Name Description
tags
Vyžadováno

Slovník značek, které chcete přidat.

Výjimky

Typ Description

deploy_configuration

Vytvořte objekt konfigurace pro nasazení do cílového výpočetního objektu AKS.

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)

Parametry

Name Description
autoscale_enabled

Jestli chcete pro tuto webovou službu povolit automatické škálování, nebo ne. Pokud num_replicas není žádná, výchozí hodnota je True.

Default value: None
autoscale_min_replicas
int

Minimální počet kontejnerů, které se mají použít při automatickém škálování této webové služby. Výchozí hodnota je 1.

Default value: None
autoscale_max_replicas
int

Maximální počet kontejnerů, které se mají použít při automatickém škálování této webové služby. Výchozí nastavení je 10.

Default value: None
autoscale_refresh_seconds
int

Jak často se má automatické škálování pokusit tuto webovou službu škálovat. Výchozí hodnota je 1.

Default value: None
autoscale_target_utilization
int

Cílové využití (v procentech z 100) by se automatické škálování mělo pokoušet udržovat pro tuto webovou službu. Výchozí hodnota je 70.

Default value: None
collect_model_data

Jestli chcete povolit shromažďování dat modelu pro tuto webovou službu, nebo ne. Výchozí nastavení je 'False'.

Default value: None
auth_enabled

Zda má být pro tuto webovou službu povolené ověřování klíčů, nebo ne. Výchozí hodnota je True.

Default value: None
cpu_cores

Počet jader procesoru, která se mají přidělit pro tuto webovou službu. Může to být desetinné číslo. Výchozí hodnota je 0.1. Odpovídá základnímu požadavku podu, nikoli limitu, ve službě Azure Kubernetes Service.

Default value: None
memory_gb

Velikost paměti (v GB) pro přidělení této webové služby. Může to být desetinné číslo. Výchozí hodnota je 0,5. Odpovídá požadavku na paměť podu, nikoli limitu ve službě Azure Kubernetes Service.

Default value: None
enable_app_insights

Bez ohledu na to, jestli chcete pro tuto webovou službu povolit protokolování Application Insights. Výchozí nastavení je 'False'.

Default value: None
scoring_timeout_ms
int

Vypršení časového limitu pro volání bodování této webové služby. Výchozí hodnota je 60000.

Default value: None
replica_max_concurrent_requests
int

Počet maximálních souběžných požadavků na repliku, které umožní tuto webovou službu. Výchozí hodnota je 1. Toto nastavení neměňte z výchozí hodnoty 1, pokud nemáte pokyn technické podpory Microsoftu nebo člena týmu Azure Machine Learning.

Default value: None
max_request_wait_time
int

Maximální doba, po kterou požadavek zůstane ve frontě (v milisekundách) před vrácením chyby 503. Výchozí hodnota je 500.

Default value: None
num_replicas
int

Počet kontejnerů, které se mají přidělit pro tuto webovou službu. Bez výchozího nastavení, pokud tento parametr není nastavený, je automatické škálování ve výchozím nastavení povolené.

Default value: None
primary_key
str

Primární ověřovací klíč, který se má použít pro tuto webovou službu.

Default value: None
secondary_key
str

Sekundární ověřovací klíč, který se má použít pro tuto webovou službu.

Default value: None
tags

Slovník značek klíč-hodnota pro poskytnutí této webové služby

Default value: None
properties

Slovník vlastností klíč-hodnota pro poskytnutí této webové služby. Tyto vlastnosti nelze po nasazení změnit, ale je možné přidat nové páry klíč-hodnota.

Default value: None
description
str

Popis této webové služby.

Default value: None
gpu_cores
int

Počet jader GPU, která se mají přidělit pro tuto webovou službu. Výchozí nastavení je 0.

Default value: None
period_seconds
int

Jak často (v sekundách) se má provést sonda aktivity. Výchozí hodnota je 10 sekund. Minimální hodnota je 1.

Default value: None
initial_delay_seconds
int

Počet sekund po spuštění kontejneru před zahájením sondy aktivity Výchozí hodnota je 310.

Default value: None
timeout_seconds
int

Počet sekund, po kterých vyprší časový limit sondy živé aktivity. Výchozí hodnota je 2 sekundy. Minimální hodnota je 1.

Default value: None
success_threshold
int

Minimální počet po sobě jdoucích úspěchů sondy aktivity, které se mají považovat za úspěšné po selhání. Výchozí hodnota je 1. Minimální hodnota je 1.

Default value: None
failure_threshold
int

Když se pod spustí a sonda aktivity selže, Kubernetes zkusí před ukončením neúspěšné doby. Výchozí hodnota je 3. Minimální hodnota je 1.

Default value: None
namespace
str

Obor názvů Kubernetes, ve kterém chcete nasadit tuto webovou službu: až 63 malých alfanumerických znaků ('a'-'z', '0'-'9') a pomlček (-'). První a poslední znaky nesmí být pomlčky.

Default value: None
token_auth_enabled

Bez ohledu na to, jestli chcete povolit ověřování tokenů pro tuto webovou službu. Pokud je tato možnost povolená, můžou uživatelé získat přístup k této webové službě načtením přístupového tokenu pomocí svých přihlašovacích údajů Azure Active Directory. Výchozí nastavení je 'False'.

Default value: None
compute_target_name
str

Název cílového výpočetního objektu, do které se má nasadit

Default value: None
cpu_cores_limit

Maximální počet jader procesoru, které tato webová služba může používat. Může to být desetinné číslo.

Default value: None
memory_gb_limit

Maximální velikost paměti (v GB), kterou tato webová služba může používat. Může to být desetinné číslo.

Default value: None
blobfuse_enabled

Jestli chcete povolit objekt blobfuse pro stahování modelu pro tuto webovou službu, nebo ne. Výchozí hodnota je True

Default value: None

Návraty

Typ Description

Objekt konfigurace, který se má použít při nasazování služby AksWebservice.

Výjimky

Typ Description

get_access_token

Načtěte ověřovací token pro tuto webovou službu.

get_access_token()

Návraty

Typ Description

Objekt popisující ověřovací token pro tuto webovou službu.

Výjimky

Typ Description

get_token

ZAVRHOVANÝ. Místo toho použijte get_access_token metodu.

Načtěte ověřovací token pro tuto webovou službu.

get_token()

Návraty

Typ Description

Ověřovací token pro tuto webovou službu a čas jeho aktualizace.

Výjimky

Typ Description

remove_tags

Odeberte zadané klíče ze slovníku značek této webové služby.

remove_tags(tags)

Parametry

Name Description
tags
Vyžadováno

Seznam klíčů, které se mají odebrat

run

Zavolejte tuto webovou službu se zadaným vstupem.

run(input_data)

Parametry

Name Description
input_data
Vyžadováno
<xref:varies>

Vstup pro volání webové služby

Návraty

Typ Description

Výsledek volání webové služby

Výjimky

Typ Description

serialize

Převeďte tuto webovou službu na serializovaný slovník JSON.

serialize()

Návraty

Typ Description

Reprezentace této webové služby ve formátu JSON.

update

Aktualizujte webovou službu se zadanými vlastnostmi.

Hodnoty ponechané jako Žádné zůstanou v této webové službě beze změny.

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)

Parametry

Name Description
image

Nová image pro nasazení do webové služby

Default value: None
autoscale_enabled

Povolení nebo zakázání automatického škálování této webové služby

Default value: None
autoscale_min_replicas
int

Minimální počet kontejnerů, které se mají použít při automatickém škálování této webové služby

Default value: None
autoscale_max_replicas
int

Maximální počet kontejnerů, které se mají použít při automatickém škálování této webové služby

Default value: None
autoscale_refresh_seconds
int

Jak často se má automatické škálování pokusit škálovat tuto webovou službu

Default value: None
autoscale_target_utilization
int

Cílové využití (v procentech z 100) by se automatické škálování mělo pokusit o údržbu pro tuto webovou službu.

Default value: None
collect_model_data

Povolení nebo zakázání shromažďování dat modelu pro tuto webovou službu

Default value: None
auth_enabled

Zda povolit ověřování pro tuto webovou službu nebo ne

Default value: None
cpu_cores

Počet jader procesoru, která se mají přidělit pro tuto webovou službu. Může to být desetinné číslo.

Default value: None
memory_gb

Velikost paměti (v GB) pro přidělení této webové služby. Může to být desetinné číslo.

Default value: None
enable_app_insights

Zda povolit protokolování Application Insights pro tuto webovou službu

Default value: None
scoring_timeout_ms
int

Vypršení časového limitu pro vyhodnocování volání této webové služby

Default value: None
replica_max_concurrent_requests
int

Počet maximálních souběžných požadavků na repliku, které umožní tuto webovou službu.

Default value: None
max_request_wait_time
int

Maximální doba, po kterou požadavek zůstane ve frontě (v milisekundách) před vrácením chyby 503

Default value: None
num_replicas
int

Počet kontejnerů, které se mají přidělit pro tuto webovou službu

Default value: None
tags

Slovník značek klíč-hodnota pro poskytnutí této webové služby Nahradí existující značky.

Default value: None
properties

Slovník vlastností klíč-hodnota pro přidání do existujícího slovníku vlastností

Default value: None
description
str

Popis pro tuto webovou službu

Default value: None
models

Seznam objektů modelu, které se mají zabalit s aktualizovanou službou

Default value: None
inference_config

Objekt InferenceConfig použitý k poskytnutí požadovaných vlastností nasazení modelu.

Default value: None
gpu_cores
int

Počet jader gpu, která se mají přidělit pro tuto webovou službu

Default value: None
period_seconds
int

Jak často (v sekundách) se má provést sonda aktivity. Výchozí hodnota je 10 sekund. Minimální hodnota je 1.

Default value: None
initial_delay_seconds
int

Počet sekund po spuštění kontejneru před inicializováním sondy aktivity

Default value: None
timeout_seconds
int

Počet sekund, po kterých vyprší časový limit sondy aktivity Výchozí hodnota je 1 sekunda. Minimální hodnota je 1.

Default value: None
success_threshold
int

Minimální počet po sobě jdoucích úspěchů pro sondu aktivity, které se mají považovat za úspěšné po selhání. Výchozí hodnota je 1. Minimální hodnota je 1.

Default value: None
failure_threshold
int

Když se pod spustí a sonda aktivity selže, Kubernetes zkusí před ukončením neúspěšné doby. Výchozí hodnota je 3. Minimální hodnota je 1.

Default value: None
namespace
str

Obor názvů Kubernetes, ve kterém chcete nasadit tuto webovou službu: až 63 malých alfanumerických znaků ('a'-'z', '0'-'9') a pomlček (-'). První a poslední znaky nesmí být pomlčky.

Default value: None
token_auth_enabled

Bez ohledu na to, jestli chcete povolit ověřování tokenů pro tuto webovou službu. Pokud je tato možnost povolená, uživatelé mají přístup k této webové službě načtením přístupového tokenu pomocí svých přihlašovacích údajů Azure Active Directory. Výchozí hodnota je False

Default value: None
cpu_cores_limit

Maximální počet jader procesoru, které tato webová služba může používat. Může to být desetinné číslo.

Default value: None
memory_gb_limit

Maximální velikost paměti (v GB), kterou tato webová služba může používat. Může to být desetinné číslo.

Default value: None
kwargs
Vyžadováno
<xref:varies>

zahrnout parametry pro podporu migrace webové služby AKS do online koncového bodu a nasazení Kubernetes. is_migration=True|False, compute_target=<compute target with AzureML extension installed to hostd migrated Kubernetes online endpoint and deployment>.

Výjimky

Typ Description