AksEndpoint Klas

Notitie

Dit is een experimentele klasse en kan op elk gewenst moment worden gewijzigd. Zie https://aka.ms/azuremlexperimental voor meer informatie.

Vertegenwoordigt een verzameling webserviceversies achter hetzelfde eindpunt dat wordt uitgevoerd op Azure Kubernetes Service.

Terwijl een AksWebservice één service implementeert met één score-eindpunt, kunt u met de klasse AksEndpoint meerdere webserviceversies achter hetzelfde score-eindpunt implementeren. Elke webserviceversie kan worden geconfigureerd voor een percentage van het verkeer, zodat u modellen op een gecontroleerde manier kunt implementeren, bijvoorbeeld voor A/B-testen. Het AksEndpoint staat implementatie toe vanuit een modelobject dat vergelijkbaar is met AksWebservice.

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 die overeenkomt met het specifieke type van het opgehaalde webserviceobject.

Overname

AksWebservice

AksEndpoint

Constructor

AksEndpoint(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.

Variabelen

Name	Description
versions	dict[str, AksWebservice] Een woordenlijst van versienaam naar versieobject. Bevat alle versies die zijn geïmplementeerd als onderdeel van dit eindpunt.

Methoden

create_version	Voeg een nieuwe versie toe aan een eindpunt met de opgegeven eigenschappen.
delete_version	Een versie in een eindpunt verwijderen.
deploy_configuration	Maak een configuratieobject voor implementatie naar een AKS-rekendoel.
serialize	Converteer deze webservice naar een geserialiseerde JSON-woordenlijst.
update	Werk het eindpunt bij met de opgegeven eigenschappen. Waarden die worden overgelaten als Geen, blijven ongewijzigd in dit eindpunt
update_version	Werk een bestaande versie bij in een eindpunt met de opgegeven eigenschappen. Waarden die als Geen zijn opgegeven, blijven ongewijzigd in deze versie.

create_version

Voeg een nieuwe versie toe aan een eindpunt met de opgegeven eigenschappen.

create_version(version_name, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, cpu_cores=None, memory_gb=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, traffic_percentile=None, is_default=None, is_control_version_type=None, cpu_cores_limit=None, memory_gb_limit=None)

Parameters

Name	Description
version_name Vereist	str De naam van de versie die in een eindpunt moet worden toegevoegd.
autoscale_enabled	bool Of automatisch schalen al dan niet moet worden ingeschakeld voor deze versie in een eindpunt. 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 versie in een eindpunt. Standaard ingesteld op 1 Default value: None
autoscale_max_replicas	int Het maximum aantal containers dat moet worden gebruikt bij het automatisch schalen van deze versie in een eindpunt. De standaardwaarde is 10 Default value: None
autoscale_refresh_seconds	int Hoe vaak de automatische schaalaanpassing moet proberen deze versie in een eindpunt te schalen. Standaard ingesteld op 1 Default value: None
autoscale_target_utilization	int Het doelgebruik (in procenten van 100) dat de automatische schaalaanpassing moet proberen te onderhouden voor deze versie in een eindpunt. Standaard ingesteld op 70 Default value: None
collect_model_data	bool Of het verzamelen van modelgegevens voor deze versie in een eindpunt al dan niet moet worden ingeschakeld. Standaard ingesteld op False. Default value: None
cpu_cores	float Het aantal CPU-kernen dat moet worden toegewezen voor deze versie in een eindpunt. Kan een decimaal getal zijn. Standaard ingesteld op 0.1 Default value: None
memory_gb	float De hoeveelheid geheugen (in GB) die moet worden toegewezen voor deze versie in een eindpunt. Kan een decimaal getal zijn. De standaardwaarde is 0,5 Default value: None
scoring_timeout_ms	int Een time-out die moet worden afgedwongen voor het scoren van aanroepen naar deze versie in een eindpunt. De standaardwaarde is 60000. Default value: None
replica_max_concurrent_requests	int Het aantal maximale gelijktijdige aanvragen per replica dat deze versie in een eindpunt toestaat. Standaardwaarde is 1. Wijzig deze instelling niet van de standaardwaarde 1, tenzij u hiervoor instructies krijgt van de technische ondersteuning van Microsoft of een lid van het Azure Machine Learning-team. Default value: None
max_request_wait_time	int De maximale hoeveelheid tijd die een aanvraag in de wachtrij blijft (in milliseconden) voordat een fout van 503 wordt geretourneerd. De standaardwaarde is 500. Default value: None
num_replicas	int Het aantal containers dat moet worden toegewezen voor deze versie in een eindpunt. Geen standaardwaarde, als deze parameter niet is ingesteld, is automatische schaalaanpassing standaard ingeschakeld. Default value: None
tags	dict[str, str] Woordenlijst met sleutelwaardetags voor dit eindpunt. Default value: None
properties	dict[str, str] Woordenlijst met sleutelwaarde-eigenschappen voor dit eindpunt. Deze eigenschappen kunnen niet worden gewijzigd na de implementatie, maar er kunnen wel nieuwe sleutelwaardeparen worden toegevoegd. Default value: None
description	str Een beschrijving om dit eindpunt 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 eigenschappen voor modelimplementatie te bieden. Default value: None
gpu_cores	int Het aantal GPU-kernen dat moet worden toegewezen voor deze versie in een eindpunt. 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 de activiteitstests worden gestart. De standaardwaarde is 310. Default value: None
timeout_seconds	int Het aantal seconden waarna er een time-out optreedt voor de activiteitstest. De standaardinstelling is 2 seconden. Minimumwaarde is 1. Default value: None
success_threshold	int De minimale opeenvolgende successen voor de liveness-test om als geslaagd te worden beschouwd nadat deze is mislukt. 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
traffic_percentile	float De hoeveelheid verkeer die de versie in een eindpunt afneemt. Default value: None
is_default	bool Of u deze versie al dan niet als standaardversie in een eindpunt wilt instellen. Standaard ingesteld op False. Default value: None
is_control_version_type	bool Of deze versie al dan niet als besturingselementversie in een eindpunt moet worden opgegeven. 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

Uitzonderingen

Type	Description
WebserviceException

delete_version

Een versie in een eindpunt verwijderen.

delete_version(version_name)

Parameters

Name	Description
version_name Vereist	str De naam van de versie in een eindpunt dat moet worden verwijderd.

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, version_name=None, traffic_percentile=None, compute_target_name=None, cpu_cores_limit=None, memory_gb_limit=None)

Parameters

Name	Description
autoscale_enabled	bool Of automatisch schalen al dan niet moet worden ingeschakeld voor deze versie in een eindpunt. 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 versie in een eindpunt. Standaardwaarde is 1. Default value: None
autoscale_max_replicas	int Het maximum aantal containers dat moet worden gebruikt bij het automatisch schalen van deze versie in een eindpunt. De standaardwaarde is 10. Default value: None
autoscale_refresh_seconds	int Hoe vaak de automatische schaalaanpassing moet proberen deze versie in een eindpunt te schalen. Standaardwaarde is 1. Default value: None
autoscale_target_utilization	int Het doelgebruik (in procent van 100) dat de automatische schaalaanpassing moet proberen te onderhouden voor deze versie in een eindpunt. De standaardwaarde is 70. Default value: None
collect_model_data	bool Of het verzamelen van modelgegevens voor deze versie in een eindpunt al dan niet moet worden ingeschakeld. Standaard ingesteld op False. Default value: None
auth_enabled	bool Of sleutelverificatie voor deze versie in een eindpunt moet worden ingeschakeld. De standaardwaarde is Waar. Default value: None
cpu_cores	float Het aantal CPU-kernen dat moet worden toegewezen voor deze versie in een eindpunt. Kan een decimaal getal zijn. Standaard ingesteld op 0.1 Default value: None
memory_gb	float De hoeveelheid geheugen (in GB) die moet worden toegewezen voor deze versie in een eindpunt. Kan een decimaal getal zijn. De standaardwaarde is 0,5 Default value: None
enable_app_insights	bool Of u ApplicationInsights-logboekregistratie wilt inschakelen voor deze versie in een eindpunt. Standaard ingesteld op False. Default value: None
scoring_timeout_ms	int Een time-out voor het afdwingen van score-aanroepen naar deze versie in een eindpunt. Standaard ingesteld op 60000 Default value: None
replica_max_concurrent_requests	int Het aantal maximale gelijktijdige aanvragen per replica dat deze versie in een eindpunt toestaat. Standaardwaarde is 1. Wijzig deze instelling niet van de standaardwaarde 1, tenzij u hiervoor instructies krijgt van de technische ondersteuning van Microsoft of een lid van het Azure Machine Learning-team. Default value: None
max_request_wait_time	int De maximale hoeveelheid tijd die een aanvraag in de wachtrij blijft (in milliseconden) voordat een fout van 503 wordt geretourneerd. De standaardwaarde is 500. Default value: None
num_replicas	int Het aantal containers dat moet worden toegewezen voor deze versie in een eindpunt. Geen standaardwaarde, als deze parameter niet is ingesteld, is automatische schaalaanpassing standaard ingeschakeld. Default value: None
primary_key	str Een primaire verificatiesleutel die moet worden gebruikt voor dit eindpunt. Default value: None
secondary_key	str Een secundaire verificatiesleutel die moet worden gebruikt voor dit eindpunt. Default value: None
tags	dict[str, str] Woordenlijst met sleutelwaardetags voor dit eindpunt. Default value: None
properties	dict[str, str] Woordenlijst met sleutelwaarde-eigenschappen voor dit eindpunt. Deze eigenschappen kunnen niet worden gewijzigd na de implementatie, maar er kunnen wel nieuwe sleutelwaardeparen worden toegevoegd Default value: None
description	str Een beschrijving om dit eindpunt te geven. Default value: None
gpu_cores	int Het aantal GPU-kernen dat moet worden toegewezen voor deze versie in een eindpunt. 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 Aantal seconden nadat de container is gestart voordat de activiteitstests worden gestart. De standaardwaarde is 310. Default value: None
timeout_seconds	int Het aantal seconden waarna er een time-out optreedt voor de liveness-test. De standaardwaarde is 2 seconden. Minimumwaarde is 1. Default value: None
success_threshold	int De minimale opeenvolgende successen voor de activiteitstest voordat de test succesvol of mislukt is. Standaardwaarde is 1. Minimumwaarde is 1. Default value: None
failure_threshold	int Wanneer een pod wordt gestart en de activiteitstest mislukt, probeert failureThreshold Kubernetes het op tijd voordat het opgeeft. Standaardwaarde is 3. Minimumwaarde is 1. Default value: None
namespace	str De Kubernetes-naamruimte waarin dit eindpunt moet worden geïmplementeerd: maximaal 63 kleine alfanumerieke tekens ('a'-'z', '0'-'9') en afbreekstreepjes ('-'). De eerste en laatste tekens kunnen geen afbreekstreepjes zijn. Default value: None
token_auth_enabled	bool Of tokenverificatie voor dit eindpunt al dan niet moet worden ingeschakeld. Als dit is ingeschakeld, hebben gebruikers toegang tot dit eindpunt door het toegangstoken op te halen met behulp van hun Azure Active Directory-referenties. Standaard ingesteld op False. Default value: None
version_name	str De naam van de versie in een eindpunt. Default value: None
traffic_percentile	float de hoeveelheid verkeer dat de versie in een eindpunt afneemt. Default value: None
compute_target_name	str De naam van het rekendoel voor implementatie 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

Retouren

Type	Description
AksEndpointDeploymentConfiguration

Uitzonderingen

Type	Description
WebserviceException

serialize

Converteer deze webservice naar een geserialiseerde JSON-woordenlijst.

serialize()

Retouren

Type	Description
dict	De JSON-weergave van deze webservice.

Uitzonderingen

Type	Description
WebserviceException

update

Werk het eindpunt bij met de opgegeven eigenschappen.

Waarden die worden overgelaten als Geen, blijven ongewijzigd in dit eindpunt

update(auth_enabled=None, token_auth_enabled=None, enable_app_insights=None, description=None, tags=None, properties=None)

Parameters

Name	Description
auth_enabled	bool Of sleutelverificatie voor deze versie in een eindpunt moet worden ingeschakeld. De standaardwaarde is Waar. Default value: None
token_auth_enabled	bool Of tokenverificatie voor dit eindpunt al dan niet moet worden ingeschakeld. Als dit is ingeschakeld, hebben gebruikers toegang tot dit eindpunt door het toegangstoken op te halen met behulp van hun Azure Active Directory-referenties. Standaard ingesteld op False. Default value: None
enable_app_insights	bool Of u Application Insights-logboekregistratie wilt inschakelen voor deze versie in een eindpunt. Standaard ingesteld op False. Default value: None
description	str Een beschrijving om dit eindpunt te geven. Default value: None
tags	dict[str, str] Woordenlijst met sleutelwaardetags voor dit eindpunt. Default value: None
properties	dict[str, str] Woordenlijst met sleutelwaarde-eigenschappen voor dit eindpunt. Deze eigenschappen kunnen niet worden gewijzigd na de implementatie, maar er kunnen wel nieuwe sleutelwaardeparen worden toegevoegd. Default value: None

Uitzonderingen

Type	Description
WebserviceException

update_version

Werk een bestaande versie bij in een eindpunt met de opgegeven eigenschappen.

Waarden die als Geen zijn opgegeven, blijven ongewijzigd in deze versie.

update_version(version_name, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, cpu_cores=None, memory_gb=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, traffic_percentile=None, is_default=None, is_control_version_type=None, cpu_cores_limit=None, memory_gb_limit=None)

Parameters

Name	Description
version_name Vereist	str De naam van de versie in een eindpunt.
autoscale_enabled	bool Of automatisch schalen voor deze versie in een eindpunt 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 versie in een eindpunt. Standaardwaarde is 1. Default value: None
autoscale_max_replicas	int Het maximum aantal containers dat moet worden gebruikt bij het automatisch schalen van deze versie in een eindpunt. De standaardwaarde is 10. Default value: None
autoscale_refresh_seconds	int Hoe vaak de automatische schaalaanpassing moet proberen deze versie in een eindpunt te schalen. Standaard ingesteld op 1 Default value: None
autoscale_target_utilization	int Het doelgebruik (in procent van 100) dat de automatische schaalaanpassing moet proberen te onderhouden voor deze versie in een eindpunt. De standaardwaarde is 70. Default value: None
collect_model_data	bool Of het verzamelen van modelgegevens voor deze versie in een eindpunt al dan niet moet worden ingeschakeld. Standaard ingesteld op False. Default value: None
cpu_cores	float Het aantal CPU-kernen dat moet worden toegewezen voor deze versie in een eindpunt. Kan een decimaal getal zijn. Standaard ingesteld op 0.1 Default value: None
memory_gb	float De hoeveelheid geheugen (in GB) die moet worden toegewezen voor deze versie in een eindpunt. Kan een decimaal getal zijn. De standaardwaarde is 0,5 Default value: None
scoring_timeout_ms	int Een time-out om af te dwingen voor score-aanroepen naar deze versie in een eindpunt. De standaardwaarde is 60000. Default value: None
replica_max_concurrent_requests	int Het aantal maximale gelijktijdige aanvragen per replica dat deze versie in een eindpunt toestaat. Standaardwaarde is 1. Wijzig deze instelling niet van de standaardwaarde 1, tenzij u hiervoor instructies krijgt van de technische ondersteuning van Microsoft of een lid van het Azure Machine Learning-team. Default value: None
max_request_wait_time	int De maximale hoeveelheid tijd die een aanvraag in de wachtrij blijft (in milliseconden) voordat een fout van 503 wordt geretourneerd. De standaardwaarde is 500. Default value: None
num_replicas	int Het aantal containers dat moet worden toegewezen voor deze versie in een eindpunt. Geen standaardwaarde, als deze parameter niet is ingesteld, is automatische schaalaanpassing standaard ingeschakeld. Default value: None
tags	dict[str, str] Woordenlijst met sleutelwaardetags voor dit eindpunt. Default value: None
properties	dict[str, str] Woordenlijst met sleutelwaarde-eigenschappen voor dit eindpunt. Deze eigenschappen kunnen niet worden gewijzigd na de implementatie, maar er kunnen wel nieuwe sleutelwaardeparen worden toegevoegd. Default value: None
description	str Een beschrijving om dit eindpunt 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 te bieden. Default value: None
gpu_cores	int Het aantal GPU-kernen dat moet worden toegewezen voor deze versie in een eindpunt. 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 de activiteitstests worden gestart. De standaardwaarde is 310. Default value: None
timeout_seconds	int Het aantal seconden waarna er een time-out optreedt voor de liveness-test. De standaardwaarde is 2 seconden. Minimumwaarde is 1. Default value: None
success_threshold	int De minimale opeenvolgende successen voor de liveness-test om als geslaagd te worden beschouwd nadat deze is mislukt. 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
traffic_percentile	float De hoeveelheid verkeer die de versie in een eindpunt afneemt. Default value: None
is_default	bool Of u deze versie al dan niet als standaardversie in een eindpunt wilt instellen. Standaard ingesteld op False. Default value: None
is_control_version_type	bool Of u deze versie al dan niet als besturingselementversie in een eindpunt wilt maken. 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

Uitzonderingen

Type	Description
WebserviceException