AksEndpoint Classe
Remarque
Il s’agit d’une classe expérimentale et peut changer à tout moment. Pour plus d’informations, consultez https://aka.ms/azuremlexperimental.
Représente une collection de versions de service web derrière le même point de terminaison exécuté sur Azure Kubernetes Service.
Alors qu’un AksWebservice service unique est déployé avec un point de terminaison de scoring unique, la classe AksEndpoint vous permet de déployer plusieurs versions de service web derrière le même point de terminaison de scoring. Chaque version de service web peut être configurée pour servir un pourcentage du trafic afin de pouvoir déployer des modèles de manière contrôlée, par exemple pour les tests A/B. AksEndpoint autorise le déploiement à partir d’un objet modèle similaire à AksWebservice.
Initialisez l’instance webservice.
Le constructeur Webservice récupère une représentation cloud d’un objet Webservice associé à l’espace de travail fourni. Elle retourne une instance d’une classe enfant correspondant au type spécifique de l’objet Webservice récupéré.
Constructeur
AksEndpoint(workspace, name)Paramètres
| Nom | Description |
|---|---|
|
workspace
Obligatoire
|
Objet d’espace de travail contenant l’objet Webservice à récupérer. |
|
name
Obligatoire
|
Nom de l’objet Webservice à récupérer. |
Variables
| Nom | Description |
|---|---|
|
versions
|
Dictionnaire du nom de version à l’objet version. Contient toutes les versions déployées dans le cadre de ce point de terminaison. |
Méthodes
| create_version |
Ajoutez une nouvelle version dans un point de terminaison avec des propriétés fournies. |
| delete_version |
Supprimez une version dans un point de terminaison. |
| deploy_configuration |
Créez un objet de configuration pour le déploiement sur une cible de calcul AKS. |
| serialize |
Convertissez ce service Web en dictionnaire sérialisé JSON. |
| update |
Mettez à jour le point de terminaison avec les propriétés fournies. Les valeurs laissées comme None restent inchangées dans ce point de terminaison |
| update_version |
Mettez à jour une version existante dans un point de terminaison avec des propriétés fournies. Les valeurs laissées comme None restent inchangées dans cette version. |
create_version
Ajoutez une nouvelle version dans un point de terminaison avec des propriétés fournies.
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)Paramètres
| Nom | Description |
|---|---|
|
version_name
Obligatoire
|
Nom de la version à ajouter dans un point de terminaison. |
|
autoscale_enabled
|
Indique s’il faut activer la mise à l’échelle automatique pour cette version dans un point de terminaison.
La valeur par défaut est True si Valeur par défaut: None
|
|
autoscale_min_replicas
|
Nombre minimal de conteneurs à utiliser lors de la mise à l’échelle automatique de cette version dans un point de terminaison. Valeur par défaut : 1 Valeur par défaut: None
|
|
autoscale_max_replicas
|
Nombre maximal de conteneurs à utiliser lors de la mise à l’échelle automatique de cette version dans un point de terminaison. La valeur par défaut est 10 Valeur par défaut: None
|
|
autoscale_refresh_seconds
|
Fréquence à laquelle le générateur de mise à l’échelle automatique doit tenter de mettre à l’échelle cette version dans un point de terminaison. Valeur par défaut : 1 Valeur par défaut: None
|
|
autoscale_target_utilization
|
L’utilisation cible (en pourcentage sur 100) de la mise à l’échelle automatique doit tenter de gérer cette version dans un point de terminaison. La valeur par défaut est 70 Valeur par défaut: None
|
|
collect_model_data
|
Indique s’il faut activer ou non la collecte de données de modèle pour cette version dans un point de terminaison. Par défaut, False Valeur par défaut: None
|
|
cpu_cores
|
Nombre de cœurs d’UC à allouer pour cette version dans un point de terminaison. Peut être une décimale. Valeur par défaut 0.1 Valeur par défaut: None
|
|
memory_gb
|
Quantité de mémoire (en Go) à allouer pour cette version dans un point de terminaison. Peut être une décimale. La valeur par défaut est 0.5 Valeur par défaut: None
|
|
scoring_timeout_ms
|
Délai d’expiration à appliquer pour les appels de scoring à cette version dans un point de terminaison. La valeur par défaut est 6 0000. Valeur par défaut: None
|
|
replica_max_concurrent_requests
|
Nombre maximal de requêtes simultanées par réplica pour autoriser cette version dans un point de terminaison. La valeur par défaut est de 1. Ne modifiez pas ce paramètre de la valeur par défaut de 1, sauf indication du support technique Microsoft ou d’un membre de l’équipe Azure Machine Learning. Valeur par défaut: None
|
|
max_request_wait_time
|
Durée maximale pendant laquelle une demande reste dans la file d’attente (en millisecondes) avant de retourner une erreur 503. La valeur par défaut est 500. Valeur par défaut: None
|
|
num_replicas
|
Nombre de conteneurs à allouer pour cette version dans un point de terminaison. Aucune valeur par défaut, si ce paramètre n’est pas défini, le générateur de mise à l’échelle automatique est activé par défaut. Valeur par défaut: None
|
|
tags
|
Dictionnaire de balises de valeur clé pour donner ce point de terminaison. Valeur par défaut: None
|
|
properties
|
Dictionnaire des propriétés de valeur de clé pour donner à ce point de terminaison. Ces propriétés ne peuvent pas être modifiées après le déploiement, mais de nouvelles paires clé-valeur peuvent être ajoutées. Valeur par défaut: None
|
|
description
|
Description pour donner ce point de terminaison. Valeur par défaut: None
|
|
models
|
Liste des objets Model à empaqueter avec le service mis à jour. Valeur par défaut: None
|
|
inference_config
|
Objet InferenceConfig utilisé pour fournir les propriétés de déploiement de modèle requises. Valeur par défaut: None
|
|
gpu_cores
|
Nombre de cœurs GPU à allouer pour cette version dans un point de terminaison. La valeur par défaut est 0. Valeur par défaut: None
|
|
period_seconds
|
Fréquence (en secondes) d’exécution de probe liveness. La valeur par défaut est de 10 secondes. La valeur minimale est 1. Valeur par défaut: None
|
|
initial_delay_seconds
|
Nombre de secondes après le démarrage du conteneur avant l’initialisation des sondes liveness. La valeur par défaut est 310. Valeur par défaut: None
|
|
timeout_seconds
|
Nombre de secondes après lesquelles la sonde liveness expire. La valeur par défaut est de 2 secondes. La valeur minimale est 1. Valeur par défaut: None
|
|
success_threshold
|
Les réussites consécutives minimales pour la sonde liveness doivent être considérées comme réussies après avoir échoué. La valeur par défaut est de 1. La valeur minimale est 1. Valeur par défaut: None
|
|
failure_threshold
|
Quand un Pod démarre et que la probe liveness échoue, Kubernetes essaie FailureThreshold times avant d’abandonner. La valeur par défaut est 3. La valeur minimale est 1. Valeur par défaut: None
|
|
traffic_percentile
|
Quantité de trafic que la version prend dans un point de terminaison. Valeur par défaut: None
|
|
is_default
|
Indique si cette version doit être ou non une version par défaut dans un point de terminaison. Valeur par défaut False. Valeur par défaut: None
|
|
is_control_version_type
|
Indique si cette version doit être ou non en tant que version de contrôle dans un point de terminaison. Valeur par défaut False. Valeur par défaut: None
|
|
cpu_cores_limit
|
Le nombre maximal de cœurs d’uc que ce service Web est autorisé à utiliser. Peut être une décimale. Valeur par défaut: None
|
|
memory_gb_limit
|
La quantité maximale de mémoire (en Go) que ce service Web est autorisé à utiliser. Peut être une décimale. Valeur par défaut: None
|
Exceptions
| Type | Description |
|---|---|
delete_version
Supprimez une version dans un point de terminaison.
delete_version(version_name)Paramètres
| Nom | Description |
|---|---|
|
version_name
Obligatoire
|
Nom de la version dans un point de terminaison à supprimer. |
Exceptions
| Type | Description |
|---|---|
deploy_configuration
Créez un objet de configuration pour le déploiement sur une cible de calcul 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, version_name=None, traffic_percentile=None, compute_target_name=None, cpu_cores_limit=None, memory_gb_limit=None)Paramètres
| Nom | Description |
|---|---|
|
autoscale_enabled
|
Indique s’il faut activer la mise à l’échelle automatique pour cette version dans un point de terminaison.
La valeur par défaut est True si Valeur par défaut: None
|
|
autoscale_min_replicas
|
Nombre minimal de conteneurs à utiliser lors de la mise à l’échelle automatique de cette version dans un point de terminaison. La valeur par défaut est de 1. Valeur par défaut: None
|
|
autoscale_max_replicas
|
Nombre maximal de conteneurs à utiliser lors de la mise à l’échelle automatique de cette version dans un point de terminaison. La valeur par défaut est 10. Valeur par défaut: None
|
|
autoscale_refresh_seconds
|
Fréquence à laquelle le générateur de mise à l’échelle automatique doit tenter de mettre à l’échelle cette version dans un point de terminaison. La valeur par défaut est de 1. Valeur par défaut: None
|
|
autoscale_target_utilization
|
L’utilisation cible (en pourcentage sur 100) de la mise à l’échelle automatique doit tenter de gérer cette version dans un point de terminaison. La valeur par défaut est 70. Valeur par défaut: None
|
|
collect_model_data
|
Indique s’il faut activer ou non la collecte de données de modèle pour cette version dans un point de terminaison. Valeur par défaut False. Valeur par défaut: None
|
|
auth_enabled
|
Indique s’il faut activer l’authentification de clé pour cette version dans un point de terminaison. La valeur par défaut est True. Valeur par défaut: None
|
|
cpu_cores
|
Nombre de cœurs de processeur à allouer pour cette version dans un point de terminaison. Peut être une décimale. Valeur par défaut 0.1 Valeur par défaut: None
|
|
memory_gb
|
Quantité de mémoire (en Go) à allouer pour cette version dans un point de terminaison. Peut être une décimale. La valeur par défaut est 0.5 Valeur par défaut: None
|
|
enable_app_insights
|
Indique s’il faut activer la journalisation ApplicationInsights pour cette version dans un point de terminaison. Valeur par défaut False. Valeur par défaut: None
|
|
scoring_timeout_ms
|
Délai d’expiration pour appliquer des appels de scoring à cette version dans un point de terminaison. Valeur par défaut : 6 0000 Valeur par défaut: None
|
|
replica_max_concurrent_requests
|
Nombre maximal de requêtes simultanées par réplica pour autoriser cette version dans un point de terminaison. La valeur par défaut est de 1. Ne modifiez pas ce paramètre de la valeur par défaut de 1, sauf indication du support technique Microsoft ou d’un membre de l’équipe Azure Machine Learning. Valeur par défaut: None
|
|
max_request_wait_time
|
Durée maximale pendant laquelle une demande reste dans la file d’attente (en millisecondes) avant de retourner une erreur 503. La valeur par défaut est 500. Valeur par défaut: None
|
|
num_replicas
|
Nombre de conteneurs à allouer pour cette version dans un point de terminaison. Aucune valeur par défaut, si ce paramètre n’est pas défini, le générateur de mise à l’échelle automatique est activé par défaut. Valeur par défaut: None
|
|
primary_key
|
Clé d’authentification primaire à utiliser pour ce point de terminaison. Valeur par défaut: None
|
|
secondary_key
|
Clé d’authentification secondaire à utiliser pour ce point de terminaison. Valeur par défaut: None
|
|
tags
|
Dictionnaire de balises de valeur clé pour donner ce point de terminaison. Valeur par défaut: None
|
|
properties
|
Dictionnaire des propriétés de valeur de clé pour donner à ce point de terminaison. Ces propriétés ne peuvent pas être modifiées après le déploiement, mais de nouvelles paires clé-valeur peuvent être ajoutées Valeur par défaut: None
|
|
description
|
Description pour donner ce point de terminaison. Valeur par défaut: None
|
|
gpu_cores
|
Nombre de cœurs GPU à allouer pour cette version dans un point de terminaison. La valeur par défaut est 0. Valeur par défaut: None
|
|
period_seconds
|
Fréquence (en secondes) d’exécution de probe liveness. La valeur par défaut est de 10 secondes. La valeur minimale est 1. Valeur par défaut: None
|
|
initial_delay_seconds
|
Nombre de secondes après le démarrage du conteneur avant l’initialisation des sondes liveness. La valeur par défaut est 310. Valeur par défaut: None
|
|
timeout_seconds
|
Nombre de secondes après lesquelles la sonde liveness expire. La valeur par défaut est de 2 secondes. La valeur minimale est 1. Valeur par défaut: None
|
|
success_threshold
|
Nombre minimal de réussites consécutives pour que la probe liveness soit considérée comme réussie après avoir échoué. La valeur par défaut est de 1. La valeur minimale est 1. Valeur par défaut: None
|
|
failure_threshold
|
Quand un pod démarre et que la sonde liveness échoue, Kubernetes essaie Valeur par défaut: None
|
|
namespace
|
Espace de noms Kubernetes dans lequel déployer ce point de terminaison : jusqu’à 63 caractères alphanumériques minuscules ('a'-'z', '0'-'9') et trait d’union ('-'). Les premiers et derniers caractères ne peuvent pas être des traits d’union. Valeur par défaut: None
|
|
token_auth_enabled
|
Indique s’il faut activer l’authentification de jeton pour ce point de terminaison. Si cette option est activée, les utilisateurs peuvent accéder à ce point de terminaison en récupérant le jeton d’accès à l’aide de leurs informations d’identification Azure Active Directory. Valeur par défaut False. Valeur par défaut: None
|
|
version_name
|
Nom de la version dans un point de terminaison. Valeur par défaut: None
|
|
traffic_percentile
|
quantité de trafic que la version accepte dans un point de terminaison. Valeur par défaut: None
|
|
compute_target_name
|
Nom de la cible de calcul à déployer sur Valeur par défaut: None
|
|
cpu_cores_limit
|
Le nombre maximal de cœurs d’uc que ce service Web est autorisé à utiliser. Peut être une décimale. Valeur par défaut: None
|
|
memory_gb_limit
|
La quantité maximale de mémoire (en Go) que ce service Web est autorisé à utiliser. Peut être une décimale. Valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
Exceptions
| Type | Description |
|---|---|
serialize
Convertissez ce service Web en dictionnaire sérialisé JSON.
serialize()Retours
| Type | Description |
|---|---|
|
Représentation JSON de ce service Web. |
update
Mettez à jour le point de terminaison avec les propriétés fournies.
Les valeurs laissées comme None restent inchangées dans ce point de terminaison
update(auth_enabled=None, token_auth_enabled=None, enable_app_insights=None, description=None, tags=None, properties=None)Paramètres
| Nom | Description |
|---|---|
|
auth_enabled
|
Indique s’il faut activer l’authentification de clé pour cette version dans un point de terminaison. La valeur par défaut est True. Valeur par défaut: None
|
|
token_auth_enabled
|
Indique s’il faut activer l’authentification de jeton pour ce point de terminaison. Si cette option est activée, les utilisateurs peuvent accéder à ce point de terminaison en récupérant le jeton d’accès à l’aide de leurs informations d’identification Azure Active Directory. Valeur par défaut False. Valeur par défaut: None
|
|
enable_app_insights
|
Indique s’il faut activer la journalisation Application Insights pour cette version dans un point de terminaison. Valeur par défaut False. Valeur par défaut: None
|
|
description
|
Description pour donner ce point de terminaison. Valeur par défaut: None
|
|
tags
|
Dictionnaire de balises de valeur clé pour donner ce point de terminaison. Valeur par défaut: None
|
|
properties
|
Dictionnaire des propriétés de valeur de clé pour donner à ce point de terminaison. Ces propriétés ne peuvent pas être modifiées après le déploiement, mais de nouvelles paires clé-valeur peuvent être ajoutées. Valeur par défaut: None
|
Exceptions
| Type | Description |
|---|---|
update_version
Mettez à jour une version existante dans un point de terminaison avec des propriétés fournies.
Les valeurs laissées comme None restent inchangées dans cette version.
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)Paramètres
| Nom | Description |
|---|---|
|
version_name
Obligatoire
|
Nom de la version dans un point de terminaison. |
|
autoscale_enabled
|
Indique s’il faut activer la mise à l’échelle automatique pour cette version dans un point de terminaison. La valeur par défaut est True si num_replicas n’est pas. Valeur par défaut: None
|
|
autoscale_min_replicas
|
Nombre minimal de conteneurs à utiliser lors de la mise à l’échelle automatique de cette version dans un point de terminaison. La valeur par défaut est de 1. Valeur par défaut: None
|
|
autoscale_max_replicas
|
Nombre maximal de conteneurs à utiliser lors de la mise à l’échelle automatique de cette version dans un point de terminaison. La valeur par défaut est 10. Valeur par défaut: None
|
|
autoscale_refresh_seconds
|
Fréquence à laquelle le générateur de mise à l’échelle automatique doit tenter de mettre à l’échelle cette version dans un point de terminaison. Valeur par défaut : 1 Valeur par défaut: None
|
|
autoscale_target_utilization
|
L’utilisation cible (en pourcentage sur 100) de la mise à l’échelle automatique doit tenter de gérer cette version dans un point de terminaison. La valeur par défaut est 70. Valeur par défaut: None
|
|
collect_model_data
|
Indique s’il faut activer ou non la collecte de données de modèle pour cette version dans un point de terminaison. Valeur par défaut False. Valeur par défaut: None
|
|
cpu_cores
|
Nombre de cœurs de processeur à allouer pour cette version dans un point de terminaison. Peut être une décimale. Valeur par défaut 0.1 Valeur par défaut: None
|
|
memory_gb
|
Quantité de mémoire (en Go) à allouer pour cette version dans un point de terminaison. Peut être une décimale. La valeur par défaut est 0.5 Valeur par défaut: None
|
|
scoring_timeout_ms
|
Délai d’expiration à appliquer pour les appels de scoring à cette version dans un point de terminaison. La valeur par défaut est 6 0000. Valeur par défaut: None
|
|
replica_max_concurrent_requests
|
Nombre maximal de requêtes simultanées par réplica pour autoriser cette version dans un point de terminaison. La valeur par défaut est de 1. Ne modifiez pas ce paramètre de la valeur par défaut de 1, sauf indication du support technique Microsoft ou d’un membre de l’équipe Azure Machine Learning. Valeur par défaut: None
|
|
max_request_wait_time
|
Durée maximale pendant laquelle une demande reste dans la file d’attente (en millisecondes) avant de retourner une erreur 503. La valeur par défaut est 500. Valeur par défaut: None
|
|
num_replicas
|
Nombre de conteneurs à allouer pour cette version dans un point de terminaison. Aucune valeur par défaut, si ce paramètre n’est pas défini, le générateur de mise à l’échelle automatique est activé par défaut. Valeur par défaut: None
|
|
tags
|
Dictionnaire de balises de valeur clé pour donner ce point de terminaison. Valeur par défaut: None
|
|
properties
|
Dictionnaire des propriétés de valeur de clé pour donner à ce point de terminaison. Ces propriétés ne peuvent pas être modifiées après le déploiement, mais de nouvelles paires clé-valeur peuvent être ajoutées. Valeur par défaut: None
|
|
description
|
Description pour donner à ce point de terminaison Valeur par défaut: None
|
|
models
|
Liste des objets Model à empaqueter avec le service mis à jour Valeur par défaut: None
|
|
inference_config
|
Objet InferenceConfig utilisé pour fournir les propriétés de déploiement de modèle requises. Valeur par défaut: None
|
|
gpu_cores
|
Nombre de cœurs GPU à allouer pour cette version dans un point de terminaison. La valeur par défaut est 0. Valeur par défaut: None
|
|
period_seconds
|
Fréquence (en secondes) d’exécution de probe liveness. La valeur par défaut est de 10 secondes. La valeur minimale est 1. Valeur par défaut: None
|
|
initial_delay_seconds
|
Nombre de secondes après le démarrage du conteneur avant l’initialisation des sondes liveness. La valeur par défaut est 310. Valeur par défaut: None
|
|
timeout_seconds
|
Nombre de secondes après lesquelles la sonde liveness expire. La valeur par défaut est de 2 secondes. La valeur minimale est 1. Valeur par défaut: None
|
|
success_threshold
|
Les réussites consécutives minimales pour la sonde liveness doivent être considérées comme réussies après avoir échoué. La valeur par défaut est de 1. La valeur minimale est 1. Valeur par défaut: None
|
|
failure_threshold
|
Quand un Pod démarre et que la probe liveness échoue, Kubernetes essaie FailureThreshold times avant d’abandonner. La valeur par défaut est 3. La valeur minimale est 1. Valeur par défaut: None
|
|
traffic_percentile
|
Quantité de trafic que la version prend dans un point de terminaison. Valeur par défaut: None
|
|
is_default
|
Indique si cette version doit être ou non une version par défaut dans un point de terminaison. Valeur par défaut False. Valeur par défaut: None
|
|
is_control_version_type
|
Indique si cette version doit être ou non en tant que version de contrôle dans un point de terminaison. Valeur par défaut False. Valeur par défaut: None
|
|
cpu_cores_limit
|
Le nombre maximal de cœurs d’uc que ce service Web est autorisé à utiliser. Peut être une décimale. Valeur par défaut: None
|
|
memory_gb_limit
|
La quantité maximale de mémoire (en Go) que ce service Web est autorisé à utiliser. Peut être une décimale. Valeur par défaut: None
|
Exceptions
| Type | Description |
|---|---|