Dela via


AksEndpoint Klass

Anteckning

Det här är en experimentell klass och kan ändras när som helst. Mer information finns i https://aka.ms/azuremlexperimental.

Representerar en samling webbtjänstversioner bakom samma slutpunkt som körs på Azure Kubernetes Service.

Medan en AksWebservice distribuerar en enda tjänst med en enda poängslutpunkt kan du med klassen AksEndpoint distribuera flera webbtjänstversioner bakom samma poängslutpunkt. Varje webbtjänstversion kan konfigureras för att hantera en procentandel av trafiken så att du kan distribuera modeller på ett kontrollerat sätt, till exempel för A/B-testning. AksEndpoint tillåter distribution från ett modellobjekt som liknar AksWebservice.

Initiera webbtjänstinstansen.

Webbtjänstkonstruktorn hämtar en molnrepresentation av ett webbtjänstobjekt som är associerat med den angivna arbetsytan. Den returnerar en instans av en underordnad klass som motsvarar den specifika typen av det hämtade webbtjänstobjektet.

Arv
AksEndpoint

Konstruktor

AksEndpoint(workspace, name)

Parametrar

Name Description
workspace
Obligatorisk

Arbetsyteobjektet som innehåller webbtjänstobjektet som ska hämtas.

name
Obligatorisk
str

Namnet på webbtjänstobjektet som ska hämtas.

Variabler

Name Description
versions

En ordlista med versionsnamn till versionsobjekt. Innehåller alla versioner som distribuerats som en del av den här slutpunkten.

Metoder

create_version

Lägg till en ny version i en slutpunkt med angivna egenskaper.

delete_version

Ta bort en version i en slutpunkt.

deploy_configuration

Skapa ett konfigurationsobjekt för distribution till ett AKS-beräkningsmål.

serialize

Konvertera den här webbtjänsten till en serialiserad JSON-ordlista.

update

Uppdatera slutpunkten med angivna egenskaper.

Värden kvar som Ingen förblir oförändrade i den här slutpunkten

update_version

Uppdatera en befintlig version i en slutpunkt med angivna egenskaper.

Värden kvar som Ingen förblir oförändrade i den här versionen.

create_version

Lägg till en ny version i en slutpunkt med angivna egenskaper.

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)

Parametrar

Name Description
version_name
Obligatorisk
str

Namnet på den version som ska läggas till i en slutpunkt.

autoscale_enabled

Om du vill aktivera autoskalning för den här versionen i en slutpunkt eller inte. Standardvärdet är Sant om num_replicas är Ingen.

Standardvärde: None
autoscale_min_replicas
int

Det minsta antalet containrar som ska användas vid automatisk skalning av den här versionen i en slutpunkt. Standardvärdet är 1

Standardvärde: None
autoscale_max_replicas
int

Det maximala antalet containrar som ska användas vid automatisk skalning av den här versionen i en slutpunkt. Standardvärdet är 10

Standardvärde: None
autoscale_refresh_seconds
int

Hur ofta autoskalning ska försöka skala den här versionen i en slutpunkt. Standardvärdet är 1

Standardvärde: None
autoscale_target_utilization
int

Målanvändningen (i procent av 100) som autoskalningen ska försöka underhålla för den här versionen i en slutpunkt. Standardvärdet är 70

Standardvärde: None
collect_model_data

Om du vill aktivera insamling av modelldata för den här versionen i en slutpunkt eller inte. Standardvärdet är Falskt

Standardvärde: None
cpu_cores

Antalet CPU-kärnor som ska allokeras för den här versionen i en slutpunkt. Kan vara en decimal. Standardvärdet är 0.1

Standardvärde: None
memory_gb

Mängden minne (i GB) som ska allokeras för den här versionen i en slutpunkt. Kan vara en decimal. Standardvärdet är 0,5

Standardvärde: None
scoring_timeout_ms
int

En timeout för att framtvinga poängsättning av anrop till den här versionen i en slutpunkt. Standardvärdet är 60000.

Standardvärde: None
replica_max_concurrent_requests
int

Antalet samtidiga begäranden per replik som tillåts för den här versionen i en slutpunkt. Standardvärdet är 1. Ändra inte den här inställningen från standardvärdet 1 om du inte instrueras av Microsofts tekniska support eller en medlem i Azure Machine Learning-teamet.

Standardvärde: None
max_request_wait_time
int

Den maximala tiden som en begäran finns kvar i kön (i millisekunder) innan ett 503-fel returneras. Standardvärdet är 500.

Standardvärde: None
num_replicas
int

Antalet containrar som ska allokeras för den här versionen i en slutpunkt. Inget standardvärde, om den här parametern inte har angetts är autoskalning aktiverad som standard.

Standardvärde: None
tags

Ordlista med nyckelvärdestaggar som ska ge den här slutpunkten.

Standardvärde: None
properties

Ordlista med nyckelvärdesegenskaper för att ge den här slutpunkten. Dessa egenskaper kan inte ändras efter distributionen, men nya nyckel/värde-par kan läggas till.

Standardvärde: None
description
str

En beskrivning som ger den här slutpunkten.

Standardvärde: None
models

En lista över modellobjekt som ska paketeras med den uppdaterade tjänsten.

Standardvärde: None
inference_config

Ett InferenceConfig-objekt som används för att tillhandahålla de nödvändiga modelldistributionsegenskaperna.

Standardvärde: None
gpu_cores
int

Antalet GPU-kärnor som ska allokeras för den här versionen i en slutpunkt. Standardvärdet är 0.

Standardvärde: None
period_seconds
int

Hur ofta (i sekunder) liveavsökningen ska utföras. Standardvärdet är 10 sekunder. Minimivärdet är 1.

Standardvärde: None
initial_delay_seconds
int

Antalet sekunder efter att containern har startats innan liveavsökningar initieras. Standardvärdet är 310.

Standardvärde: None
timeout_seconds
int

Antalet sekunder som liveavsökningen överskrider tidsgränsen. Standardvärdet är 2 sekunder. Minimivärdet är 1.

Standardvärde: None
success_threshold
int

Minsta antal lyckade resultat i följd för att liveavsökningen ska anses vara lyckad efter att ha misslyckats. Standardvärdet är 1. Minimivärdet är 1.

Standardvärde: None
failure_threshold
int

När en podd startar och liveavsökningen misslyckas, kommer Kubernetes att prova failureThreshold gånger innan den ger upp. Standardvärdet är 3. Minimivärdet är 1.

Standardvärde: None
traffic_percentile

Mängden trafik som versionen tar i en slutpunkt.

Standardvärde: None
is_default

Om du vill göra den här versionen till standardversion i en slutpunkt eller inte. Standardvärdet är False.

Standardvärde: None
is_control_version_type

Om du vill göra den här versionen som kontrollversion i en slutpunkt eller inte. Standardvärdet är False.

Standardvärde: None
cpu_cores_limit

Det maximala antalet processorkärnor som den här webbtjänsten tillåts använda. Kan vara en decimal.

Standardvärde: None
memory_gb_limit

Den maximala mängden minne (i GB) som den här webbtjänsten får använda. Kan vara en decimal.

Standardvärde: None

Undantag

Typ Description

delete_version

Ta bort en version i en slutpunkt.

delete_version(version_name)

Parametrar

Name Description
version_name
Obligatorisk
str

Namnet på versionen i en slutpunkt som ska tas bort.

Undantag

Typ Description

deploy_configuration

Skapa ett konfigurationsobjekt för distribution till ett AKS-beräkningsmål.

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)

Parametrar

Name Description
autoscale_enabled

Om du vill aktivera autoskalning för den här versionen i en slutpunkt eller inte. Standardvärdet är Sant om num_replicas är Ingen.

Standardvärde: None
autoscale_min_replicas
int

Det minsta antalet containrar som ska användas vid automatisk skalning av den här versionen i en slutpunkt. Standardvärdet är 1.

Standardvärde: None
autoscale_max_replicas
int

Det maximala antalet containrar som ska användas vid automatisk skalning av den här versionen i en slutpunkt. Standardvärdet är 10.

Standardvärde: None
autoscale_refresh_seconds
int

Hur ofta autoskalning ska försöka skala den här versionen i en slutpunkt. Standardvärdet är 1.

Standardvärde: None
autoscale_target_utilization
int

Målanvändningen (i procent av 100) som autoskalningen ska försöka underhålla för den här versionen i en slutpunkt. Standardvärdet är 70.

Standardvärde: None
collect_model_data

Om du vill aktivera insamling av modelldata för den här versionen i en slutpunkt eller inte. Standardvärdet är False.

Standardvärde: None
auth_enabled

Om nyckelautentisering ska aktiveras eller inte för den här versionen i en slutpunkt. Standardvärdet är True.

Standardvärde: None
cpu_cores

Antalet processorkärnor som ska allokeras för den här versionen i en slutpunkt. Kan vara en decimal. Standardvärdet är 0.1

Standardvärde: None
memory_gb

Mängden minne (i GB) som ska allokeras för den här versionen i en slutpunkt. Kan vara en decimal. Standardvärdet är 0,5

Standardvärde: None
enable_app_insights

Om du vill aktivera ApplicationInsights-loggning för den här versionen i en slutpunkt eller inte. Standardvärdet är False.

Standardvärde: None
scoring_timeout_ms
int

En timeout för att framtvinga bedömningsanrop till den här versionen i en slutpunkt. Standardvärdet är 60000

Standardvärde: None
replica_max_concurrent_requests
int

Antalet samtidiga begäranden per replik som tillåts för den här versionen i en slutpunkt. Standardvärdet är 1. Ändra inte den här inställningen från standardvärdet 1 om du inte instrueras av Microsofts tekniska support eller en medlem i Azure Machine Learning-teamet.

Standardvärde: None
max_request_wait_time
int

Den maximala tiden som en begäran finns kvar i kön (i millisekunder) innan ett 503-fel returneras. Standardvärdet är 500.

Standardvärde: None
num_replicas
int

Antalet containrar som ska allokeras för den här versionen i en slutpunkt. Inget standardvärde, om den här parametern inte har angetts är autoskalning aktiverad som standard.

Standardvärde: None
primary_key
str

En primär autentiseringsnyckel som ska användas för den här slutpunkten.

Standardvärde: None
secondary_key
str

En sekundär autentiseringsnyckel som ska användas för den här slutpunkten.

Standardvärde: None
tags

Ordlista med nyckelvärdestaggar som ska ge den här slutpunkten.

Standardvärde: None
properties

Ordlista med nyckelvärdesegenskaper för att ge den här slutpunkten. Dessa egenskaper kan inte ändras efter distributionen, men nya nyckel/värde-par kan läggas till

Standardvärde: None
description
str

En beskrivning som ger den här slutpunkten.

Standardvärde: None
gpu_cores
int

Antalet GPU-kärnor som ska allokeras för den här versionen i en slutpunkt. Standardvärdet är 0.

Standardvärde: None
period_seconds
int

Hur ofta (i sekunder) liveavsökningen ska utföras. Standardvärdet är 10 sekunder. Minimivärdet är 1.

Standardvärde: None
initial_delay_seconds
int

Antal sekunder efter att containern har startats innan liveavsökningar initieras. Standardvärdet är 310.

Standardvärde: None
timeout_seconds
int

Antal sekunder varefter liveavsökningen överskrider tidsgränsen. Standardvärdet är 2 sekunder. Minimivärdet är 1.

Standardvärde: None
success_threshold
int

Minsta antal lyckade resultat i följd för att liveavsökningen ska anses vara lyckad efter att ha misslyckats. Standardvärdet är 1. Minimivärdet är 1.

Standardvärde: None
failure_threshold
int

När en podd startar och liveavsökningen misslyckas försöker failureThreshold Kubernetes gånger innan den ger upp. Standardvärdet är 3. Minimivärdet är 1.

Standardvärde: None
namespace
str

Kubernetes-namnområdet där den här slutpunkten ska distribueras: upp till 63 alfanumeriska gemener ("a"-"z", "0"-"9") och bindestreck ("-") tecken. Det första och sista tecknen får inte vara bindestreck.

Standardvärde: None
token_auth_enabled

Om tokenautentisering ska aktiveras eller inte för den här slutpunkten. Om detta är aktiverat kan användarna komma åt den här slutpunkten genom att hämta åtkomsttoken med sina Azure Active Directory-autentiseringsuppgifter. Standardvärdet är False.

Standardvärde: None
version_name
str

Namnet på versionen i en slutpunkt.

Standardvärde: None
traffic_percentile

mängden trafik som versionen tar i en slutpunkt.

Standardvärde: None
compute_target_name
str

Namnet på beräkningsmålet som ska distribueras till

Standardvärde: None
cpu_cores_limit

Det maximala antalet processorkärnor som den här webbtjänsten tillåts använda. Kan vara en decimal.

Standardvärde: None
memory_gb_limit

Den maximala mängden minne (i GB) som den här webbtjänsten får använda. Kan vara en decimal.

Standardvärde: None

Returer

Typ Description

Undantag

Typ Description

serialize

Konvertera den här webbtjänsten till en serialiserad JSON-ordlista.

serialize()

Returer

Typ Description

JSON-representationen av den här webbtjänsten.

Undantag

Typ Description

update

Uppdatera slutpunkten med angivna egenskaper.

Värden kvar som Ingen förblir oförändrade i den här slutpunkten

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

Parametrar

Name Description
auth_enabled

Om nyckelautentisering ska aktiveras eller inte för den här versionen i en slutpunkt. Standardvärdet är True.

Standardvärde: None
token_auth_enabled

Om tokenautentisering ska aktiveras eller inte för den här slutpunkten. Om detta är aktiverat kan användarna komma åt den här slutpunkten genom att hämta åtkomsttoken med sina Azure Active Directory-autentiseringsuppgifter. Standardvärdet är False.

Standardvärde: None
enable_app_insights

Om du vill aktivera Application Insights-loggning för den här versionen i en slutpunkt eller inte. Standardvärdet är False.

Standardvärde: None
description
str

En beskrivning som ger den här slutpunkten.

Standardvärde: None
tags

Ordlista med nyckelvärdestaggar som ska ge den här slutpunkten.

Standardvärde: None
properties

Ordlista med nyckelvärdesegenskaper för att ge den här slutpunkten. Dessa egenskaper kan inte ändras efter distributionen, men nya nyckel/värde-par kan läggas till.

Standardvärde: None

Undantag

Typ Description

update_version

Uppdatera en befintlig version i en slutpunkt med angivna egenskaper.

Värden kvar som Ingen förblir oförändrade i den här versionen.

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)

Parametrar

Name Description
version_name
Obligatorisk
str

Namnet på versionen i en slutpunkt.

autoscale_enabled

Om du vill aktivera autoskalning för den här versionen i en slutpunkt eller inte. Standardvärdet är True om num_replicas är Ingen.

Standardvärde: None
autoscale_min_replicas
int

Det minsta antalet containrar som ska användas vid automatisk skalning av den här versionen i en slutpunkt. Standardvärdet är 1.

Standardvärde: None
autoscale_max_replicas
int

Det maximala antalet containrar som ska användas vid automatisk skalning av den här versionen i en slutpunkt. Standardvärdet är 10.

Standardvärde: None
autoscale_refresh_seconds
int

Hur ofta autoskalning ska försöka skala den här versionen i en slutpunkt. Standardvärdet är 1

Standardvärde: None
autoscale_target_utilization
int

Målanvändningen (i procent av 100) som autoskalningen ska försöka underhålla för den här versionen i en slutpunkt. Standardvärdet är 70.

Standardvärde: None
collect_model_data

Om du vill aktivera insamling av modelldata för den här versionen i en slutpunkt eller inte. Standardvärdet är False.

Standardvärde: None
cpu_cores

Antalet processorkärnor som ska allokeras för den här versionen i en slutpunkt. Kan vara en decimal. Standardvärdet är 0.1

Standardvärde: None
memory_gb

Mängden minne (i GB) som ska allokeras för den här versionen i en slutpunkt. Kan vara en decimal. Standardvärdet är 0,5

Standardvärde: None
scoring_timeout_ms
int

En timeout för att framtvinga poängsättning av anrop till den här versionen i en slutpunkt. Standardvärdet är 60000.

Standardvärde: None
replica_max_concurrent_requests
int

Antalet samtidiga begäranden per replik som tillåts för den här versionen i en slutpunkt. Standardvärdet är 1. Ändra inte den här inställningen från standardvärdet 1 om du inte instrueras av Microsofts tekniska support eller en medlem i Azure Machine Learning-teamet.

Standardvärde: None
max_request_wait_time
int

Den maximala tiden som en begäran finns kvar i kön (i millisekunder) innan ett 503-fel returneras. Standardvärdet är 500.

Standardvärde: None
num_replicas
int

Antalet containrar som ska allokeras för den här versionen i en slutpunkt. Inget standardvärde, om den här parametern inte har angetts är autoskalning aktiverad som standard.

Standardvärde: None
tags

Ordlista med nyckelvärdestaggar som ska ge den här slutpunkten.

Standardvärde: None
properties

Ordlista med nyckelvärdesegenskaper för att ge den här slutpunkten. Dessa egenskaper kan inte ändras efter distributionen, men nya nyckel/värde-par kan läggas till.

Standardvärde: None
description
str

En beskrivning för att ge den här slutpunkten

Standardvärde: None
models

En lista över modellobjekt som ska paketera med den uppdaterade tjänsten

Standardvärde: None
inference_config

Ett InferenceConfig-objekt som används för att tillhandahålla de nödvändiga modelldistributionsegenskaperna.

Standardvärde: None
gpu_cores
int

Antalet GPU-kärnor som ska allokeras för den här versionen i en slutpunkt. Standardvärdet är 0.

Standardvärde: None
period_seconds
int

Hur ofta (i sekunder) liveavsökningen ska utföras. Standardvärdet är 10 sekunder. Minimivärdet är 1.

Standardvärde: None
initial_delay_seconds
int

Antalet sekunder efter att containern har startats innan liveavsökningar initieras. Standardvärdet är 310.

Standardvärde: None
timeout_seconds
int

Antalet sekunder som liveavsökningen överskrider tidsgränsen. Standardvärdet är 2 sekunder. Minimivärdet är 1.

Standardvärde: None
success_threshold
int

Minsta antal lyckade resultat i följd för att liveavsökningen ska anses vara lyckad efter att ha misslyckats. Standardvärdet är 1. Minimivärdet är 1.

Standardvärde: None
failure_threshold
int

När en podd startar och liveavsökningen misslyckas, kommer Kubernetes att prova failureThreshold gånger innan den ger upp. Standardvärdet är 3. Minimivärdet är 1.

Standardvärde: None
traffic_percentile

Mängden trafik som versionen tar i en slutpunkt.

Standardvärde: None
is_default

Om du vill göra den här versionen till standardversion i en slutpunkt eller inte. Standardvärdet är False.

Standardvärde: None
is_control_version_type

Om du vill göra den här versionen som kontrollversion i en slutpunkt eller inte. Standardvärdet är False.

Standardvärde: None
cpu_cores_limit

Det maximala antalet processorkärnor som den här webbtjänsten tillåts använda. Kan vara en decimal.

Standardvärde: None
memory_gb_limit

Den maximala mängden minne (i GB) som den här webbtjänsten får använda. Kan vara en decimal.

Standardvärde: None

Undantag

Typ Description