Delen via

AksWebservice Klas

Vertegenwoordigt een machine learning-model dat is geïmplementeerd als een webservice-eindpunt in Azure Kubernetes Service.

Er wordt een geïmplementeerde service gemaakt op basis van een model, script en bijbehorende bestanden. De resulterende webservice is een http-eindpunt met gelijke taakverdeling met een REST API. U kunt gegevens naar deze API verzenden en de voorspelling ontvangen die door het model wordt geretourneerd.

AksWebservice implementeert één service naar één eindpunt. Als u meerdere services naar één eindpunt wilt implementeren, gebruikt u de AksEndpoint klasse.

Zie Een model implementeren in een Azure Kubernetes Service-cluster voor meer informatie.

Initialiseer het webservice-exemplaar.

De webserviceconstructor haalt een cloudweergave op van een webserviceobject dat is gekoppeld aan de opgegeven werkruimte. Er wordt een exemplaar van een onderliggende klasse geretourneerd dat overeenkomt met het specifieke type van het opgehaalde webserviceobject.

Constructor

AksWebservice(workspace, name)

Parameters

Name Description
workspace
Vereist
Workspace

Het werkruimteobject met het webserviceobject dat moet worden opgehaald.
name
Vereist
str

De naam van het webserviceobject dat moet worden opgehaald.

Opmerkingen

Het aanbevolen implementatiepatroon is om een implementatieconfiguratieobject te maken met de deploy_configuration methode en dit vervolgens te gebruiken met de deploy methode van de Model klasse, zoals hieronder wordt weergegeven.


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

Er zijn een aantal manieren om een model als webservice te implementeren, waaronder:

  • deploy methode van de Model voor modellen die al zijn geregistreerd in de werkruimte.

  • deploy_from_image methode van Webservice.

  • deploy_from_model methode voor Webservice modellen die al zijn geregistreerd in de werkruimte. Met deze methode maakt u een installatiekopieën.

  • deploy methode van de Webservice, waarmee een model wordt geregistreerd en een installatiekopieën wordt gemaakt.

Zie voor meer informatie over het werken met webservices

De sectie Variabelen bevat kenmerken van een lokale weergave van het cloud-AksWebservice-object. Deze variabelen moeten als alleen-lezen worden beschouwd. Het wijzigen van de waarden wordt niet weergegeven in het bijbehorende cloudobject.

Variabelen

Name Description
enable_app_insights
bool

Of Logboekregistratie van AppInsights al dan niet is ingeschakeld voor de webservice.
autoscaler
AutoScaler

Het object Automatische schaalaanpassing voor de webservice.
compute_name
str

De naam van de ComputeTarget waarop de webservice is geïmplementeerd.
container_resource_requirements
ContainerResourceRequirements

De vereisten voor containerresources voor de webservice.
liveness_probe_requirements
LivenessProbeRequirements

De vereisten voor de livenesstest voor de webservice.
data_collection
DataCollection

Het DataCollection-object voor de webservice.
max_concurrent_requests_per_container
int

Het maximum aantal gelijktijdige aanvragen per container voor de webservice.
max_request_wait_time
int

De maximale wachttijd voor de aanvraag voor de webservice, in milliseconden.
num_replicas
int

Het aantal replica's voor de webservice. Elke replica komt overeen met een AKS-pod.
scoring_timeout_ms
int

De scoretime-out voor de webservice, in milliseconden.
azureml.core.webservice.AksWebservice.scoring_uri
str

Het score-eindpunt voor de webservice
is_default
bool

Als de webservice de standaardversie is voor het bovenliggende AksEndpoint.
traffic_percentile
int

Welk percentage verkeer moet worden doorgestuurd naar de webservice in het bovenliggende AksEndpoint.
version_type
VersionType

Het versietype voor de webservice in het bovenliggende AksEndpoint.
token_auth_enabled
bool

Of tokenverificatie al dan niet is ingeschakeld voor de webservice.
environment
Environment

Het omgevingsobject dat is gebruikt om de webservice te maken.
azureml.core.webservice.AksWebservice.models
list[Model]

Een lijst met modellen die zijn geïmplementeerd in de webservice.
deployment_status
str

De implementatiestatus van de webservice.
namespace
str

De AKS-naamruimte van de webservice.
azureml.core.webservice.AksWebservice.swagger_uri
str

Het swagger-eindpunt voor de webservice.

Methoden

add_properties

Voeg sleutel-waardeparen toe aan de eigenschappenwoordenlijst van deze webservice.
add_tags

Voeg sleutel-waardeparen toe aan de tagswoordenlijst van deze webservice.

Verhoogt een WebserviceException.
deploy_configuration

Maak een configuratieobject voor implementatie naar een AKS-rekendoel.
get_access_token

Verificatietoken ophalen voor deze webservice.
get_token

VEROUDERD. Gebruik get_access_token in plaats daarvan de methode.

Verificatietoken ophalen voor deze webservice.
remove_tags

Verwijder de opgegeven sleutels uit de woordenlijst van deze webservice met tags.
run

Roep deze webservice aan met de opgegeven invoer.
serialize

Converteer deze webservice naar een geserialiseerde JSON-woordenlijst.
update

Werk de webservice bij met opgegeven eigenschappen.

De waarden blijven ongewijzigd in deze webservice.

add_properties

Voeg sleutel-waardeparen toe aan de eigenschappenwoordenlijst van deze webservice.

add_properties(properties)

Parameters

Name Description
properties
Vereist
dict[str, str]

De woordenlijst met eigenschappen die u wilt toevoegen.

add_tags

Voeg sleutel-waardeparen toe aan de tagswoordenlijst van deze webservice.

Verhoogt een WebserviceException.

add_tags(tags)

Parameters

Name Description
tags
Vereist
dict[str, str]

De woordenlijst met tags die u wilt toevoegen.

Uitzonderingen

Type Description
WebserviceException

deploy_configuration

Maak een configuratieobject voor implementatie naar een AKS-rekendoel.

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)

Parameters

Name Description
autoscale_enabled
bool

Hiermee wordt aangegeven of automatisch schalen voor deze webservice al dan niet moet worden ingeschakeld. De standaardwaarde is Waar als num_replicas geen is.

Default value: None
autoscale_min_replicas
int

Het minimale aantal containers dat moet worden gebruikt bij het automatisch schalen van deze webservice. De standaardwaarde is 1.

Default value: None
autoscale_max_replicas
int

Het maximum aantal containers dat moet worden gebruikt bij het automatisch schalen van deze webservice. De standaardwaarde is 10.

Default value: None
autoscale_refresh_seconds
int

Hoe vaak de automatische schaalaanpassing moet proberen deze webservice te schalen. De standaardwaarde is 1.

Default value: None
autoscale_target_utilization
int

Het doelgebruik (in procent van de 100) moet de automatische schaalaanpassing proberen te onderhouden voor deze webservice. De standaardwaarde is 70.

Default value: None
collect_model_data
bool

Het al dan niet inschakelen van modelgegevensverzameling voor deze webservice. De standaardwaarde is False.

Default value: None
auth_enabled
bool

Hiermee wordt aangegeven of sleutelverificatie voor deze webservice al dan niet moet worden ingeschakeld. De standaardwaarde is Waar.

Default value: None
cpu_cores
float

Het aantal cpu-kernen dat moet worden toegewezen voor deze webservice. Kan een decimaal getal zijn. De standaardwaarde is 0.1. Komt overeen met de pod-kernaanvraag, niet de limiet, in Azure Kubernetes Service.

Default value: None
memory_gb
float

De hoeveelheid geheugen (in GB) die moet worden toegewezen voor deze webservice. Kan een decimaal getal zijn. De standaardwaarde is 0,5. Komt overeen met de aanvraag voor podgeheugen, niet de limiet, in Azure Kubernetes Service.

Default value: None
enable_app_insights
bool

Of u Application Insights-logboekregistratie voor deze webservice al dan niet wilt inschakelen. De standaardwaarde is False.

Default value: None
scoring_timeout_ms
int

Een time-out voor het afdwingen van score-aanroepen naar deze webservice. De standaardwaarde is 60000.

Default value: None
replica_max_concurrent_requests
int

Het aantal maximaal gelijktijdige aanvragen per replica dat deze webservice toestaat. De standaardwaarde is 1. Wijzig deze instelling niet van de standaardwaarde 1, tenzij dit wordt aangegeven door de technische ondersteuning van Microsoft of een lid van het Azure Machine Learning-team.

Default value: None
max_request_wait_time
int

De maximale tijdsduur die een aanvraag in de wachtrij blijft (in milliseconden) voordat een 503-fout wordt geretourneerd. De standaardwaarde is 500.

Default value: None
num_replicas
int

Het aantal containers dat moet worden toegewezen voor deze webservice. Geen standaardwaarde, als deze parameter niet is ingesteld, is de automatische schaalaanpassing standaard ingeschakeld.

Default value: None
primary_key
str

Een primaire verificatiesleutel die moet worden gebruikt voor deze webservice.

Default value: None
secondary_key
str

Een secundaire verificatiesleutel die moet worden gebruikt voor deze webservice.

Default value: None
tags
dict[str, str]

Woordenlijst met sleutelwaardetags om deze webservice te geven.

Default value: None
properties
dict[str, str]

Woordenlijst met sleutelwaarde-eigenschappen om deze webservice te geven. Deze eigenschappen kunnen niet worden gewijzigd na de implementatie, maar nieuwe sleutelwaardeparen kunnen worden toegevoegd.

Default value: None
description
str

Een beschrijving om deze webservice te geven.

Default value: None
gpu_cores
int

Het aantal GPU-kernen dat moet worden toegewezen voor deze webservice. De standaardwaarde is 0.

Default value: None
period_seconds
int

Hoe vaak (in seconden) de activiteitstest moet worden uitgevoerd. De standaardwaarde is 10 seconden. Minimumwaarde is 1.

Default value: None
initial_delay_seconds
int

Het aantal seconden nadat de container is gestart voordat liveness-tests worden gestart. De standaardwaarde is 310.

Default value: None
timeout_seconds
int

Het aantal seconden waarna er een time-out optreedt voor de livenesstest. De standaardwaarde is 2 seconde. Minimumwaarde is 1.

Default value: None
success_threshold
int

De minimale opeenvolgende successen voor de liveness-test worden beschouwd als geslaagd nadat deze is mislukt. De standaardwaarde is 1. Minimumwaarde is 1.

Default value: None
failure_threshold
int

Wanneer een pod wordt gestart en de activiteitstest mislukt, probeert Kubernetes failureThreshold keer voordat hij stopt. Standaardwaarde is 3. Minimumwaarde is 1.

Default value: None
namespace
str

De Kubernetes-naamruimte waarin deze webservice moet worden geïmplementeerd: maximaal 63 alfanumerieke tekens ('a'-'z', '0'-'9') en afbreekstreepjes ('-'). De eerste en laatste tekens mogen geen afbreekstreepjes zijn.

Default value: None
token_auth_enabled
bool

Hiermee wordt aangegeven of tokenverificatie voor deze webservice al dan niet moet worden ingeschakeld. Als dit is ingeschakeld, hebben gebruikers toegang tot deze webservice door een toegangstoken op te halen met behulp van hun Azure Active Directory-referenties. De standaardwaarde is False.

Default value: None
compute_target_name
str

De naam van het rekendoel dat moet worden geïmplementeerd in

Default value: None
cpu_cores_limit
float

Het maximum aantal cpu-kernen dat deze webservice mag gebruiken. Kan een decimaal getal zijn.

Default value: None
memory_gb_limit
float

De maximale hoeveelheid geheugen (in GB) die deze webservice mag gebruiken. Kan een decimaal getal zijn.

Default value: None
blobfuse_enabled
bool

Of u blobfuse wel of niet wilt inschakelen voor het downloaden van modellen voor deze webservice. Standaard ingesteld op Waar

Default value: None

Retouren

Type Description
AksServiceDeploymentConfiguration

Een configuratieobject dat moet worden gebruikt bij het implementeren van een AksWebservice.

Uitzonderingen

Type Description
WebserviceException

get_access_token

Verificatietoken ophalen voor deze webservice.

get_access_token()

Retouren

Type Description
AksServiceAccessToken

Een object met een beschrijving van het verificatietoken voor deze webservice.

Uitzonderingen

Type Description
WebserviceException

get_token

VEROUDERD. Gebruik get_access_token in plaats daarvan de methode.

Verificatietoken ophalen voor deze webservice.

get_token()

Retouren

Type Description
str, datetime

Het verificatietoken voor deze webservice en wanneer u het moet vernieuwen.

Uitzonderingen

Type Description
WebserviceException

remove_tags

Verwijder de opgegeven sleutels uit de woordenlijst van deze webservice met tags.

remove_tags(tags)

Parameters

Name Description
tags
Vereist
list[str]

De lijst met sleutels die u wilt verwijderen

run

Roep deze webservice aan met de opgegeven invoer.

run(input_data)

Parameters

Name Description
input_data
Vereist
<xref:varies>

De invoer voor het aanroepen van de webservice met

Retouren

Type Description
dict

Het resultaat van het aanroepen van de webservice

Uitzonderingen

Type Description
WebserviceException

serialize

Converteer deze webservice naar een geserialiseerde JSON-woordenlijst.

serialize()

Retouren

Type Description
dict

De JSON-weergave van deze webservice.

update

Werk de webservice bij met opgegeven eigenschappen.

De waarden blijven ongewijzigd in deze webservice.

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)

Parameters

Name Description
image
Image

Een nieuwe installatiekopieën die in de webservice moeten worden geïmplementeerd

Default value: None
autoscale_enabled
bool

Automatische schaalaanpassing van deze webservice in- of uitschakelen

Default value: None
autoscale_min_replicas
int

Het minimale aantal containers dat moet worden gebruikt bij het automatisch schalen van deze webservice

Default value: None
autoscale_max_replicas
int

Het maximum aantal containers dat moet worden gebruikt bij het automatisch schalen van deze webservice

Default value: None
autoscale_refresh_seconds
int

Hoe vaak de automatische schaalaanpassing moet proberen om deze webservice te schalen

Default value: None
autoscale_target_utilization
int

Het doelgebruik (in procent van de 100) moet de automatische schaalaanpassing proberen te onderhouden voor deze webservice

Default value: None
collect_model_data
bool

Modelgegevensverzameling in- of uitschakelen voor deze webservice

Default value: None
auth_enabled
bool

Auth inschakelen voor deze webservice

Default value: None
cpu_cores
float

Het aantal cpu-kernen dat moet worden toegewezen voor deze webservice. Kan een decimaal getal zijn

Default value: None
memory_gb
float

De hoeveelheid geheugen (in GB) die moet worden toegewezen voor deze webservice. Kan een decimaal getal zijn

Default value: None
enable_app_insights
bool

Of u Application Insights-logboekregistratie voor deze webservice al dan niet wilt inschakelen

Default value: None
scoring_timeout_ms
int

Een time-out voor het afdwingen van score-aanroepen naar deze webservice

Default value: None
replica_max_concurrent_requests
int

Het aantal maximaal gelijktijdige aanvragen per replica dat deze webservice toestaat.

Default value: None
max_request_wait_time
int

De maximale hoeveelheid tijd die een aanvraag in de wachtrij blijft (in milliseconden) voordat er een 503-fout wordt geretourneerd

Default value: None
num_replicas
int

Het aantal containers dat moet worden toegewezen voor deze webservice

Default value: None
tags
dict[str, str]

Woordenlijst met sleutelwaardetags om deze webservice te geven. Vervangt bestaande tags.

Default value: None
properties
dict[str, str]

Woordenlijst met sleutelwaarde-eigenschappen die moeten worden toegevoegd aan de bestaande woordenlijst met eigenschappen

Default value: None
description
str

Een beschrijving om deze webservice te geven

Default value: None
models
list[Model]

Een lijst met modelobjecten die moeten worden verpakt met de bijgewerkte service

Default value: None
inference_config
InferenceConfig

Een InferenceConfig-object dat wordt gebruikt om de vereiste modelimplementatie-eigenschappen op te geven.

Default value: None
gpu_cores
int

Het aantal GPU-kernen dat moet worden toegewezen voor deze webservice

Default value: None
period_seconds
int

Hoe vaak (in seconden) de activiteitstest moet worden uitgevoerd. De standaardwaarde is 10 seconden. Minimumwaarde is 1.

Default value: None
initial_delay_seconds
int

Aantal seconden nadat de container is gestart voordat de liveness-tests worden gestart.

Default value: None
timeout_seconds
int

Aantal seconden waarna er een time-out optreedt voor de livenesstest. De standaardwaarde is 1 seconde. Minimumwaarde is 1.

Default value: None
success_threshold
int

De minimale opeenvolgende successen voor de activiteitstest voordat de test succesvol of mislukt is. De standaardwaarde is 1. Minimumwaarde is 1.

Default value: None
failure_threshold
int

Wanneer een pod wordt gestart en de activiteitstest mislukt, probeert Kubernetes failureThreshold keer voordat hij stopt. Standaardwaarde is 3. Minimumwaarde is 1.

Default value: None
namespace
str

De Kubernetes-naamruimte waarin deze webservice moet worden geïmplementeerd: maximaal 63 alfanumerieke tekens ('a'-'z', '0'-'9') en afbreekstreepjes ('-'). De eerste en laatste tekens mogen geen afbreekstreepjes zijn.

Default value: None
token_auth_enabled
bool

Hiermee wordt aangegeven of tokenverificatie voor deze webservice al dan niet moet worden ingeschakeld. Als dit is ingeschakeld, hebben gebruikers toegang tot deze webservice door het toegangstoken op te halen met behulp van hun Azure Active Directory-referenties. Standaard ingesteld op False.

Default value: None
cpu_cores_limit
float

Het maximum aantal cpu-kernen dat deze webservice mag gebruiken. Kan een decimaal getal zijn.

Default value: None
memory_gb_limit
float

De maximale hoeveelheid geheugen (in GB) die deze webservice mag gebruiken. Kan een decimaal getal zijn.

Default value: None
kwargs
Vereist
<xref:varies>

params opnemen ter ondersteuning van het migreren van de AKS-webservice naar het online-eindpunt en de implementatie van Kubernetes. is_migration=Waar|False, compute_target=<compute target with AzureML extension installed to hostd migrated Kubernetes online endpoint and deployment>.

Uitzonderingen

Type Description
WebserviceException