AksEndpoint Classe

Nota

Si tratta di una classe sperimentale e può cambiare in qualsiasi momento. Per altre informazioni, vedere https://aka.ms/azuremlexperimental.

Rappresenta una raccolta di versioni del servizio Web dietro lo stesso endpoint in esecuzione in servizio Azure Kubernetes.

Mentre un AksWebservice oggetto distribuisce un singolo servizio con un singolo endpoint di assegnazione dei punteggi, la classe AksEndpoint consente di distribuire più versioni del servizio Web dietro lo stesso endpoint di assegnazione dei punteggi. Ogni versione del servizio Web può essere configurata per gestire una percentuale del traffico in modo da poter distribuire modelli in modo controllato, ad esempio per i test A/B. AksEndpoint consente la distribuzione da un oggetto modello simile a AksWebservice.

Inizializzare l'istanza del servizio Web.

Il costruttore webservice recupera una rappresentazione cloud di un oggetto Servizio Web associato all'area di lavoro specificata. Restituisce un'istanza di una classe figlio corrispondente al tipo specifico dell'oggetto Webservice recuperato.

Ereditarietà

AksWebservice

AksEndpoint

Costruttore

AksEndpoint(workspace, name)

Parametri

Nome	Descrizione
workspace Necessario	Workspace Oggetto workspace contenente l'oggetto Webservice da recuperare.
name Necessario	str Nome dell'oggetto Webservice da recuperare.

Variabili

Nome	Descrizione
versions	dict[str, AksWebservice] Dizionario del nome della versione per l'oggetto version. Contiene tutte le versioni distribuite come parte di questo endpoint.

Metodi

create_version	Aggiungere una nuova versione in un endpoint con le proprietà specificate.
delete_version	Eliminare una versione in un endpoint.
deploy_configuration	Creare un oggetto di configurazione per la distribuzione in una destinazione di calcolo del servizio Azure Kubernetes.
serialize	Convertire questo servizio Web in un dizionario serializzato JSON.
update	Aggiornare l'endpoint con le proprietà specificate. I valori lasciati come None rimarranno invariati in questo endpoint
update_version	Aggiornare una versione esistente in un endpoint con le proprietà specificate. I valori lasciati come None rimarranno invariati in questa versione.

create_version

Aggiungere una nuova versione in un endpoint con le proprietà specificate.

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)

Parametri

Nome	Descrizione
version_name Necessario	str Nome della versione da aggiungere in un endpoint.
autoscale_enabled	bool Indica se abilitare o meno la scalabilità automatica per questa versione in un endpoint. Il valore predefinito è True se num_replicas non è Nessuno. Valore predefinito: None
autoscale_min_replicas	int Numero minimo di contenitori da usare per la scalabilità automatica di questa versione in un endpoint. Il valore predefinito è 1 Valore predefinito: None
autoscale_max_replicas	int Numero massimo di contenitori da usare per la scalabilità automatica di questa versione in un endpoint. Il valore predefinito è 10 Valore predefinito: None
autoscale_refresh_seconds	int Frequenza con cui l'utilità di scalabilità automatica deve tentare di ridimensionare questa versione in un endpoint. Il valore predefinito è 1 Valore predefinito: None
autoscale_target_utilization	int L'utilizzo di destinazione ,in percentuale su 100, il ridimensionamento automatico deve tentare di mantenere per questa versione in un endpoint. Il valore predefinito è 70 Valore predefinito: None
collect_model_data	bool Indica se abilitare o meno la raccolta dei dati del modello per questa versione in un endpoint. Il valore predefinito è False Valore predefinito: None
cpu_cores	float Numero di core CPU da allocare per questa versione in un endpoint. Può essere un decimale. Il valore predefinito è 0.1 Valore predefinito: None
memory_gb	float Quantità di memoria (in GB) da allocare per questa versione in un endpoint. Può essere un decimale. Il valore predefinito è 0.5 Valore predefinito: None
scoring_timeout_ms	int Timeout da applicare per l'assegnazione dei punteggi alle chiamate a questa versione in un endpoint. Il valore predefinito è 60000. Valore predefinito: None
replica_max_concurrent_requests	int Numero massimo di richieste simultanee per replica che consentono questa versione in un endpoint. Assume il valore predefinito 1. Non modificare questa impostazione dal valore predefinito 1, a meno che non venga richiesto dal supporto tecnico Microsoft o da un membro del team di Azure Machine Learning. Valore predefinito: None
max_request_wait_time	int La quantità massima di tempo per cui una richiesta rimarrà nella coda (in millisecondi) prima di restituire un errore 503. Il valore predefinito è 500. Valore predefinito: None
num_replicas	int Numero di contenitori da allocare per questa versione in un endpoint. Nessun valore predefinito, se questo parametro non è impostato, l'utilità di scalabilità automatica è abilitata per impostazione predefinita. Valore predefinito: None
tags	dict[str, str] Dizionario dei tag chiave-valore da assegnare a questo endpoint. Valore predefinito: None
properties	dict[str, str] Dizionario delle proprietà chiave-valore per assegnare questo endpoint. Queste proprietà non possono essere modificate dopo la distribuzione, ma è possibile aggiungere nuove coppie chiave-valore. Valore predefinito: None
description	str Descrizione da assegnare a questo endpoint. Valore predefinito: None
models	list[Model] Elenco di oggetti Model da creare in un pacchetto con il servizio aggiornato. Valore predefinito: None
inference_config	InferenceConfig Oggetto InferenceConfig usato per fornire le proprietà di distribuzione del modello necessarie. Valore predefinito: None
gpu_cores	int Numero di core GPU da allocare per questa versione in un endpoint. Il valore predefinito è 0. Valore predefinito: None
period_seconds	int La frequenza (in secondi) con cui eseguire il probe di attività. Il valore predefinito è 10 secondi. Il valore minimo è 1. Valore predefinito: None
initial_delay_seconds	int Numero di secondi dopo l'avvio del contenitore prima dell'avvio dei probe di attività. Il valore predefinito è 310. Valore predefinito: None
timeout_seconds	int Numero di secondi dopo il quale si verifica il timeout del probe di attività. Il valore predefinito è 2 secondi. Il valore minimo è 1. Valore predefinito: None
success_threshold	int Numero minimo di successi consecutivi per il probe di attività da considerare riuscito dopo l'esito negativo. Assume il valore predefinito 1. Il valore minimo è 1. Valore predefinito: None
failure_threshold	int Quando un pod viene avviato e il probe di attività non riesce, Kubernetes continuerà a provare per il numero di volte indicato in failureThreshold prima di rinunciare. Il valore predefinito è 3. Il valore minimo è 1. Valore predefinito: None
traffic_percentile	float Quantità di traffico impiegato dalla versione in un endpoint. Valore predefinito: None
is_default	bool Indica se impostare o meno questa versione come versione predefinita in un endpoint. Il valore predefinito è False. Valore predefinito: None
is_control_version_type	bool Indica se impostare o meno questa versione come versione del controllo in un endpoint. Il valore predefinito è False. Valore predefinito: None
cpu_cores_limit	float È consentito usare il numero massimo di core cpu per questo servizio Web. Può essere un decimale. Valore predefinito: None
memory_gb_limit	float La quantità massima di memoria (in GB) che questo servizio Web può usare. Può essere un decimale. Valore predefinito: None

Eccezioni

Tipo	Descrizione
WebserviceException

delete_version

Eliminare una versione in un endpoint.

delete_version(version_name)

Parametri

Nome	Descrizione
version_name Necessario	str Nome della versione in un endpoint da eliminare.

Eccezioni

Tipo	Descrizione
WebserviceException

deploy_configuration

Creare un oggetto di configurazione per la distribuzione in una destinazione di calcolo del servizio Azure Kubernetes.

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)

Parametri

Nome	Descrizione
autoscale_enabled	bool Indica se abilitare o meno la scalabilità automatica per questa versione in un endpoint. Il valore predefinito è True se num_replicas non è Nessuno. Valore predefinito: None
autoscale_min_replicas	int Numero minimo di contenitori da usare durante la scalabilità automatica di questa versione in un endpoint. Assume il valore predefinito 1. Valore predefinito: None
autoscale_max_replicas	int Numero massimo di contenitori da usare durante la scalabilità automatica di questa versione in un endpoint. Il valore predefinito è 10. Valore predefinito: None
autoscale_refresh_seconds	int La frequenza con cui il ridimensionatore automatico deve tentare di ridimensionare questa versione in un endpoint. Assume il valore predefinito 1. Valore predefinito: None
autoscale_target_utilization	int L'utilizzo di destinazione (in percentuale superiore a 100) il ridimensionatore automatico deve tentare di mantenere per questa versione in un endpoint. Il valore predefinito è 70. Valore predefinito: None
collect_model_data	bool Indica se abilitare o meno la raccolta dati del modello per questa versione in un endpoint. Il valore predefinito è False. Valore predefinito: None
auth_enabled	bool Indica se abilitare o meno l'autenticazione della chiave per questa versione in un endpoint. Impostazione predefinita su True. Valore predefinito: None
cpu_cores	float Numero di core cpu da allocare per questa versione in un endpoint. Può essere un decimale. Impostazione predefinita a 0.1 Valore predefinito: None
memory_gb	float Quantità di memoria (in GB) da allocare per questa versione in un endpoint. Può essere un decimale. Impostazione predefinita a 0,5 Valore predefinito: None
enable_app_insights	bool Indica se abilitare o meno la registrazione di ApplicationInsights per questa versione in un endpoint. Il valore predefinito è False. Valore predefinito: None
scoring_timeout_ms	int Timeout per applicare le chiamate di assegnazione dei punteggi a questa versione in un endpoint. Impostazione predefinita a 60000 Valore predefinito: None
replica_max_concurrent_requests	int Numero di richieste simultanee massime per replica per consentire questa versione in un endpoint. Assume il valore predefinito 1. Non modificare questa impostazione dal valore predefinito di 1 a meno che non sia stato indicato dal supporto tecnico Microsoft o da un membro del team di Azure Machine Learning. Valore predefinito: None
max_request_wait_time	int La quantità massima di tempo per cui una richiesta rimarrà nella coda (in millisecondi) prima di restituire un errore 503. Il valore predefinito è 500. Valore predefinito: None
num_replicas	int Numero di contenitori da allocare per questa versione in un endpoint. Nessun valore predefinito, se questo parametro non è impostato, il ridimensionamento automatico è abilitato per impostazione predefinita. Valore predefinito: None
primary_key	str Chiave di autenticazione primaria da usare per questo endpoint. Valore predefinito: None
secondary_key	str Chiave di autenticazione secondaria da usare per questo endpoint. Valore predefinito: None
tags	dict[str, str] Dizionario dei tag chiave per assegnare questo endpoint. Valore predefinito: None
properties	dict[str, str] Dizionario delle proprietà del valore chiave da assegnare all'endpoint. Queste proprietà non possono essere modificate dopo la distribuzione, ma è possibile aggiungere nuove coppie di valori chiave Valore predefinito: None
description	str Descrizione da assegnare all'endpoint. Valore predefinito: None
gpu_cores	int Numero di core GPU da allocare per questa versione in un endpoint. Il valore predefinito è 0. Valore predefinito: None
period_seconds	int La frequenza (in secondi) con cui eseguire il probe di attività. Il valore predefinito è 10 secondi. Il valore minimo è 1. Valore predefinito: None
initial_delay_seconds	int Il numero di secondi dopo l'avvio del contenitore prima che vengano avviati i probe di attività. Il valore predefinito è 310. Valore predefinito: None
timeout_seconds	int Numero di secondi dopo il quale il probe di liveness timeout. Il valore predefinito è 2 secondi. Il valore minimo è 1. Valore predefinito: None
success_threshold	int Il numero minimo di successi consecutivi perché il probe di attività venga considerato riuscito dopo un errore. Assume il valore predefinito 1. Il valore minimo è 1. Valore predefinito: None
failure_threshold	int Quando un pod inizia e il probe di liveness ha esito negativo, Kubernetes tenterà failureThreshold i tempi prima di rinunciare. Il valore predefinito è 3. Il valore minimo è 1. Valore predefinito: None
namespace	str Spazio dei nomi Kubernetes in cui distribuire questo endpoint: fino a 63 caratteri alfanumerici minuscoli ('a'-'z', '0'-'9') e trattino ('-'). I primi e gli ultimi caratteri non possono essere trattini. Valore predefinito: None
token_auth_enabled	bool Indica se abilitare l'autenticazione del token per questo endpoint. Se questa opzione è abilitata, gli utenti possono accedere a questo endpoint recuperando il token di accesso usando le credenziali di Azure Active Directory. Il valore predefinito è False. Valore predefinito: None
version_name	str Nome della versione in un endpoint. Valore predefinito: None
traffic_percentile	float la quantità di traffico che la versione accetta in un endpoint. Valore predefinito: None
compute_target_name	str Nome della destinazione di calcolo da distribuire in Valore predefinito: None
cpu_cores_limit	float Il numero massimo di core cpu che questo servizio Web può usare. Può essere un decimale. Valore predefinito: None
memory_gb_limit	float La quantità massima di memoria (in GB) di questo servizio Web è consentita per l'uso. Può essere un decimale. Valore predefinito: None

Restituisce

Tipo	Descrizione
AksEndpointDeploymentConfiguration

Eccezioni

Tipo	Descrizione
WebserviceException

serialize

Convertire questo servizio Web in un dizionario serializzato JSON.

serialize()

Restituisce

Tipo	Descrizione
dict	Rappresentazione JSON di questo servizio Web.

Eccezioni

Tipo	Descrizione
WebserviceException

update

Aggiornare l'endpoint con le proprietà specificate.

I valori lasciati come None rimarranno invariati in questo endpoint

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

Parametri

Nome	Descrizione
auth_enabled	bool Indica se abilitare o meno l'autenticazione della chiave per questa versione in un endpoint. Impostazione predefinita su True. Valore predefinito: None
token_auth_enabled	bool Indica se abilitare l'autenticazione del token per questo endpoint. Se questa opzione è abilitata, gli utenti possono accedere a questo endpoint recuperando il token di accesso usando le credenziali di Azure Active Directory. Il valore predefinito è False. Valore predefinito: None
enable_app_insights	bool Indica se abilitare o meno la registrazione di Application Insights per questa versione in un endpoint. Il valore predefinito è False. Valore predefinito: None
description	str Descrizione da assegnare all'endpoint. Valore predefinito: None
tags	dict[str, str] Dizionario dei tag chiave per assegnare questo endpoint. Valore predefinito: None
properties	dict[str, str] Dizionario delle proprietà del valore chiave da assegnare all'endpoint. Queste proprietà non possono essere modificate dopo la distribuzione, ma è possibile aggiungere nuove coppie di valori chiave. Valore predefinito: None

Eccezioni

Tipo	Descrizione
WebserviceException

update_version

Aggiornare una versione esistente in un endpoint con le proprietà specificate.

I valori lasciati come None rimarranno invariati in questa versione.

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)

Parametri

Nome	Descrizione
version_name Necessario	str Nome della versione in un endpoint.
autoscale_enabled	bool Indica se abilitare la scalabilità automatica per questa versione in un endpoint. Il valore predefinito è True se num_replicas è Nessuna. Valore predefinito: None
autoscale_min_replicas	int Numero minimo di contenitori da usare durante la scalabilità automatica di questa versione in un endpoint. Assume il valore predefinito 1. Valore predefinito: None
autoscale_max_replicas	int Numero massimo di contenitori da usare durante la scalabilità automatica di questa versione in un endpoint. Il valore predefinito è 10. Valore predefinito: None
autoscale_refresh_seconds	int La frequenza con cui il ridimensionatore automatico deve tentare di ridimensionare questa versione in un endpoint. Impostazione predefinita su 1 Valore predefinito: None
autoscale_target_utilization	int L'utilizzo di destinazione (in percentuale superiore a 100) il ridimensionatore automatico deve tentare di mantenere per questa versione in un endpoint. Il valore predefinito è 70. Valore predefinito: None
collect_model_data	bool Indica se abilitare o meno la raccolta dati del modello per questa versione in un endpoint. Il valore predefinito è False. Valore predefinito: None
cpu_cores	float Numero di core cpu da allocare per questa versione in un endpoint. Può essere un decimale. Impostazione predefinita a 0.1 Valore predefinito: None
memory_gb	float Quantità di memoria (in GB) da allocare per questa versione in un endpoint. Può essere un decimale. Impostazione predefinita a 0,5 Valore predefinito: None
scoring_timeout_ms	int Timeout da applicare per l'assegnazione dei punteggi a questa versione in un endpoint. Il valore predefinito è 60000. Valore predefinito: None
replica_max_concurrent_requests	int Numero massimo di richieste simultanee per replica che consentono questa versione in un endpoint. Assume il valore predefinito 1. Non modificare questa impostazione dal valore predefinito 1, a meno che non venga richiesto dal supporto tecnico Microsoft o da un membro del team di Azure Machine Learning. Valore predefinito: None
max_request_wait_time	int La quantità massima di tempo per cui una richiesta rimarrà nella coda (in millisecondi) prima di restituire un errore 503. Il valore predefinito è 500. Valore predefinito: None
num_replicas	int Numero di contenitori da allocare per questa versione in un endpoint. Nessun valore predefinito, se questo parametro non è impostato, l'utilità di scalabilità automatica è abilitata per impostazione predefinita. Valore predefinito: None
tags	dict[str, str] Dizionario dei tag chiave-valore da assegnare a questo endpoint. Valore predefinito: None
properties	dict[str, str] Dizionario delle proprietà chiave-valore per assegnare questo endpoint. Queste proprietà non possono essere modificate dopo la distribuzione, ma è possibile aggiungere nuove coppie chiave-valore. Valore predefinito: None
description	str Descrizione da assegnare a questo endpoint Valore predefinito: None
models	list[Model] Elenco di oggetti Model da creare in un pacchetto con il servizio aggiornato Valore predefinito: None
inference_config	InferenceConfig Oggetto InferenceConfig usato per fornire le proprietà di distribuzione del modello necessarie. Valore predefinito: None
gpu_cores	int Numero di core GPU da allocare per questa versione in un endpoint. Il valore predefinito è 0. Valore predefinito: None
period_seconds	int La frequenza (in secondi) con cui eseguire il probe di attività. Il valore predefinito è 10 secondi. Il valore minimo è 1. Valore predefinito: None
initial_delay_seconds	int Numero di secondi dopo l'avvio del contenitore prima dell'avvio dei probe di attività. Il valore predefinito è 310. Valore predefinito: None
timeout_seconds	int Numero di secondi dopo il quale si verifica il timeout del probe di attività. Il valore predefinito è 2 secondi. Il valore minimo è 1. Valore predefinito: None
success_threshold	int Numero minimo di successi consecutivi per il probe di attività da considerare riuscito dopo l'esito negativo. Assume il valore predefinito 1. Il valore minimo è 1. Valore predefinito: None
failure_threshold	int Quando un pod viene avviato e il probe di attività non riesce, Kubernetes continuerà a provare per il numero di volte indicato in failureThreshold prima di rinunciare. Il valore predefinito è 3. Il valore minimo è 1. Valore predefinito: None
traffic_percentile	float Quantità di traffico impiegato dalla versione in un endpoint. Valore predefinito: None
is_default	bool Indica se impostare o meno questa versione come versione predefinita in un endpoint. Il valore predefinito è False. Valore predefinito: None
is_control_version_type	bool Indica se impostare o meno questa versione come versione del controllo in un endpoint. Il valore predefinito è False. Valore predefinito: None
cpu_cores_limit	float È consentito usare il numero massimo di core cpu per questo servizio Web. Può essere un decimale. Valore predefinito: None
memory_gb_limit	float La quantità massima di memoria (in GB) che questo servizio Web può usare. Può essere un decimale. Valore predefinito: None

Eccezioni

Tipo	Descrizione
WebserviceException