Partager via


AksEndpointDeploymentConfiguration Classe

Notes

Il s’agit d’une classe expérimentale qui peut changer à tout moment. Pour plus d’informations, consultez https://aka.ms/azuremlexperimental.

Représente les informations de configuration de déploiement pour un service déployé sur Azure Kubernetes Service.

Créez un objet AksEndpointDeploymentConfiguration à l’aide de la méthode deploy_configuration de la classe AksEndpoint.

Initialisez un objet de configuration pour le déploiement d’un point de terminaison sur une cible de calcul AKS.

Héritage
AksEndpointDeploymentConfiguration

Constructeur

AksEndpointDeploymentConfiguration(autoscale_enabled, autoscale_min_replicas, autoscale_max_replicas, autoscale_refresh_seconds, autoscale_target_utilization, collect_model_data, auth_enabled, cpu_cores, memory_gb, enable_app_insights, scoring_timeout_ms, replica_max_concurrent_requests, max_request_wait_time, num_replicas, primary_key, secondary_key, tags, properties, description, gpu_cores, period_seconds, initial_delay_seconds, timeout_seconds, success_threshold, failure_threshold, namespace, token_auth_enabled, version_name, traffic_percentile, compute_target_name, cpu_cores_limit, memory_gb_limit)

Paramètres

Nom Description
autoscale_enabled
Obligatoire

Indique s’il est nécessaire ou non d’activer la mise à l’échelle automatique pour ce service web. La valeur par défaut est True si la valeur de num_replicas est None.

autoscale_min_replicas
Obligatoire
int

Nombre minimal de conteneurs à utiliser durant la mise à l’échelle automatique de ce Webservice. La valeur par défaut est de 1.

autoscale_max_replicas
Obligatoire
int

Nombre maximal de conteneurs à utiliser durant la mise à l’échelle automatique de ce Webservice. La valeur par défaut est 10.

autoscale_refresh_seconds
Obligatoire
int

Fréquence à laquelle l’autoscaler doit tenter de mettre à l’échelle ce Webservice. La valeur par défaut est de 1.

autoscale_target_utilization
Obligatoire
int

Utilisation cible en pourcentage que l’autoscaler doit tenter de conserver pour ce Webservice. La valeur par défaut est 70.

collect_model_data
Obligatoire

Indique s’il est nécessaire ou non d’activer la collecte de données de modèle pour ce Webservice. Valeur par défaut False.

auth_enabled
Obligatoire

Indique s’il faut activer ou pas l’authentification pour ce service web. La valeur par défaut est True.

cpu_cores
Obligatoire

Nombre de cœurs de processeur à allouer pour ce Webservice. Peut être un nombre décimal. La valeur par défaut est 0.1

memory_gb
Obligatoire

Quantité de mémoire (en Go) à allouer pour ce Webservice. Peut être un nombre décimal. La valeur par défaut est 0.5

enable_app_insights
Obligatoire

Indique s’il est nécessaire ou non d’activer la journalisation Application Insights pour ce Webservice. Valeur par défaut False.

scoring_timeout_ms
Obligatoire
int

Délai d’expiration à appliquer pour le scoring des appels à ce Webservice. La valeur par défaut est 60000.

replica_max_concurrent_requests
Obligatoire
int

Nombre maximal de requêtes simultanées par réplica à autoriser pour ce Webservice. La valeur par défaut est de 1. Ne modifiez pas la valeur de ce paramètre (la valeur par défaut est 1), sauf indication contraire du support technique Microsoft ou d’un membre de l’équipe Azure Machine Learning.

max_request_wait_time
Obligatoire
int

Durée maximale pendant laquelle une requête reste en file d’attente (en millisecondes) avant de retourner une erreur 503. La valeur par défaut est 500.

num_replicas
Obligatoire
int

Nombre de conteneurs à allouer pour ce Webservice. Aucune valeur par défaut. Si ce paramètre n’est pas défini, la mise à l’échelle automatique est activée par défaut.

primary_key
Obligatoire
str

Clé d’authentification principale à utiliser pour ce service web

secondary_key
Obligatoire
str

Clé d’authentification secondaire à utiliser pour ce service web

tags
Obligatoire

Dictionnaire des étiquettes de valeur de clé à attribuer à ce service web.

properties
Obligatoire

Dictionnaire des propriétés de valeur de clé à attribuer à ce service web. Vous ne pouvez pas changer ces propriétés après le déploiement. Toutefois, vous pouvez ajouter de nouvelles paires clé-valeur.

description
Obligatoire
str

Description à fournir à ce Webservice.

gpu_cores
Obligatoire
int

Nombre de cœurs GPU à allouer pour ce service web. La valeur par défaut est 0.

period_seconds
Obligatoire
int

Fréquence (en secondes) d’exécution de probe liveness. La valeur par défaut est 10 secondes. La valeur minimale est 1.

initial_delay_seconds
Obligatoire
int

Nombre de secondes après le démarrage du conteneur avant le lancement des probes liveness. La valeur par défaut est 310.

timeout_seconds
Obligatoire
int

Délai d’expiration en secondes de la probe liveness. La valeur par défaut est de 2 secondes. La valeur minimale est 1.

success_threshold
Obligatoire
int

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.

failure_threshold
Obligatoire
int

Lorsqu’un Pod démarre et que la probe liveness échoue, Kubernetes essaie failureThreshold fois avant d’abandonner. La valeur par défaut est 3. La valeur minimale est 1.

namespace
Obligatoire
str

Espace de noms Kubernetes sur lequel déployer ce Webservice : jusqu’à 63 caractères alphanumériques minuscules (lettres allant de « a » à « z », chiffres allant de « 0 » à « 9 » et traits d’union (« - »)). Le premier caractère et le dernier caractère ne peuvent pas être des traits d’union.

token_auth_enabled
Obligatoire

Indique s’il est nécessaire ou non d’activer l’authentification Azure Active Directory pour ce service web. Si cette option est activée, les utilisateurs peuvent accéder au Webservice en récupérant un jeton d’accès à l’aide de leurs informations d’identification Azure Active Directory. Valeur par défaut False.

version_name
Obligatoire
str

Nom de la version dans un point de terminaison.

traffic_percentile
Obligatoire

Quantité de trafic que la version prend dans un point de terminaison.

cpu_cores_limit
Obligatoire

Nombre maximal de cœurs de processeur que ce service web est autorisé à utiliser. Peut être un nombre décimal.

memory_gb_limit
Obligatoire

Quantité maximale de mémoire (en Go) que ce Webservice est autorisé à utiliser. Peut être un nombre décimal.

autoscale_enabled
Obligatoire

Indique s’il est nécessaire ou non d’activer la mise à l’échelle automatique pour ce service web. La valeur par défaut est True si la valeur de num_replicas est None.

autoscale_min_replicas
Obligatoire
int

Nombre minimal de conteneurs à utiliser durant la mise à l’échelle automatique de ce Webservice. La valeur par défaut est de 1.

autoscale_max_replicas
Obligatoire
int

Nombre maximal de conteneurs à utiliser durant la mise à l’échelle automatique de ce Webservice. La valeur par défaut est 10.

autoscale_refresh_seconds
Obligatoire
int

Fréquence à laquelle l’autoscaler doit tenter de mettre à l’échelle ce Webservice. La valeur par défaut est de 1.

autoscale_target_utilization
Obligatoire
int

Utilisation cible en pourcentage que l’autoscaler doit tenter de conserver pour ce Webservice. La valeur par défaut est 70.

collect_model_data
Obligatoire

Indique s’il est nécessaire ou non d’activer la collecte de données de modèle pour ce Webservice. Valeur par défaut False.

auth_enabled
Obligatoire

Indique s’il faut activer ou pas l’authentification pour ce service web. La valeur par défaut est True.

cpu_cores
Obligatoire

Nombre de cœurs de processeur à allouer pour ce Webservice. Peut être un nombre décimal. La valeur par défaut est 0.1

memory_gb
Obligatoire

Quantité de mémoire (en Go) à allouer pour ce Webservice. Peut être un nombre décimal. La valeur par défaut est 0.5

enable_app_insights
Obligatoire

Indique s’il est nécessaire ou non d’activer la journalisation Application Insights pour ce Webservice. Valeur par défaut False.

scoring_timeout_ms
Obligatoire
int

Délai d’expiration à appliquer pour le scoring des appels à ce Webservice. La valeur par défaut est 60000.

replica_max_concurrent_requests
Obligatoire
int

Nombre maximal de requêtes simultanées par réplica à autoriser pour ce Webservice. La valeur par défaut est de 1. Ne modifiez pas la valeur de ce paramètre (la valeur par défaut est 1), sauf indication contraire du support technique Microsoft ou d’un membre de l’équipe Azure Machine Learning.

max_request_wait_time
Obligatoire
int

Durée maximale pendant laquelle une requête reste en file d’attente (en millisecondes) avant de retourner une erreur 503. La valeur par défaut est 500.

num_replicas
Obligatoire
int

Nombre de conteneurs à allouer pour ce Webservice. Aucune valeur par défaut. Si ce paramètre n’est pas défini, la mise à l’échelle automatique est activée par défaut.

primary_key
Obligatoire
str

Clé d’authentification principale à utiliser pour ce service web

secondary_key
Obligatoire
str

Clé d’authentification secondaire à utiliser pour ce service web

tags
Obligatoire

Dictionnaire des étiquettes de valeur de clé à attribuer à ce service web.

properties
Obligatoire

Dictionnaire des propriétés de valeur de clé à attribuer à ce service web. Vous ne pouvez pas changer ces propriétés après le déploiement. Toutefois, vous pouvez ajouter de nouvelles paires clé-valeur.

description
Obligatoire
str

Description à fournir à ce Webservice.

gpu_cores
Obligatoire
int

Nombre de cœurs GPU à allouer pour ce service web. La valeur par défaut est 0.

period_seconds
Obligatoire
int

Fréquence (en secondes) d’exécution de probe liveness. La valeur par défaut est 10 secondes. La valeur minimale est 1.

initial_delay_seconds
Obligatoire
int

Nombre de secondes après le démarrage du conteneur avant le lancement des probes liveness. La valeur par défaut est 310.

timeout_seconds
Obligatoire
int

Délai d’expiration en secondes de la probe liveness. La valeur par défaut est de 2 secondes. La valeur minimale est 1.

success_threshold
Obligatoire
int

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.

failure_threshold
Obligatoire
int

Lorsqu’un Pod démarre et que la probe liveness échoue, Kubernetes essaie failureThreshold fois avant d’abandonner. La valeur par défaut est 3. La valeur minimale est 1.

namespace
Obligatoire
str

Espace de noms Kubernetes sur lequel déployer ce Webservice : jusqu’à 63 caractères alphanumériques minuscules (lettres allant de « a » à « z », chiffres allant de « 0 » à « 9 » et traits d’union (« - »)). Le premier caractère et le dernier caractère ne peuvent pas être des traits d’union.

token_auth_enabled
Obligatoire

Indique s’il est nécessaire ou non d’activer l’authentification Azure Active Directory pour ce service web. Si cette option est activée, les utilisateurs peuvent accéder au Webservice en récupérant un jeton d’accès à l’aide de leurs informations d’identification Azure Active Directory. Valeur par défaut False.

version_name
Obligatoire
str

Nom de la version dans un point de terminaison.

traffic_percentile
Obligatoire

Quantité de trafic que la version prend dans un point de terminaison.

compute_target_name
Obligatoire
str

Nom de la cible de calcul sur laquelle effectuer le déploiement

cpu_cores_limit
Obligatoire

Nombre maximal de cœurs de processeur que ce Webservice est autorisé à utiliser. Peut être un nombre décimal.

memory_gb_limit
Obligatoire

Quantité maximale de mémoire (en Go) que ce Webservice est autorisé à utiliser. Peut être un nombre décimal.

Variables

Nom Description
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_enabled

Indique s’il est nécessaire ou non d’activer la mise à l’échelle automatique pour ce service web. La valeur par défaut est True si la valeur de num_replicas est None.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_min_replicas

Nombre minimal de conteneurs à utiliser durant la mise à l’échelle automatique de ce Webservice. La valeur par défaut est de 1.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_max_replicas

Nombre maximal de conteneurs à utiliser durant la mise à l’échelle automatique de ce Webservice. La valeur par défaut est 10.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_refresh_seconds

Fréquence à laquelle l’autoscaler doit tenter de mettre à l’échelle ce Webservice. La valeur par défaut est de 1.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_target_utilization

Utilisation cible en pourcentage que l’autoscaler doit tenter de conserver pour ce Webservice. La valeur par défaut est 70.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.collect_model_data

Indique s’il est nécessaire ou non d’activer la collecte de données de modèle pour ce Webservice. Valeur par défaut False.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.auth_enabled

Indique s’il faut activer ou pas l’authentification pour ce service web. La valeur par défaut est True.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.cpu_cores

Nombre de cœurs de processeur à allouer pour ce Webservice. Peut être un nombre décimal. La valeur par défaut est 0.1

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.memory_gb

Quantité de mémoire (en Go) à allouer pour ce Webservice. Peut être un nombre décimal. La valeur par défaut est 0.5

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.enable_app_insights

Indique s’il est nécessaire ou non d’activer la journalisation Application Insights pour ce Webservice. Valeur par défaut False.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.scoring_timeout_ms

Délai d’expiration à appliquer pour le scoring des appels à ce Webservice. La valeur par défaut est 60000.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.replica_max_concurrent_requests

Nombre maximal de requêtes simultanées par réplica à autoriser pour ce Webservice. La valeur par défaut est de 1. Ne modifiez pas la valeur de ce paramètre (la valeur par défaut est 1), sauf indication contraire du support technique Microsoft ou d’un membre de l’équipe Azure Machine Learning.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.max_request_wait_time

Durée maximale pendant laquelle une requête reste en file d’attente (en millisecondes) avant de retourner une erreur 503. La valeur par défaut est 500.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.num_replicas

Nombre de conteneurs à allouer pour ce Webservice. Aucune valeur par défaut. Si ce paramètre n’est pas défini, la mise à l’échelle automatique est activée par défaut.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.primary_key

Clé d’authentification principale à utiliser pour ce service web

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.secondary_key

Clé d’authentification secondaire à utiliser pour ce service web

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.tags

Dictionnaire des étiquettes de valeur de clé à attribuer à ce service web.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.properties

Dictionnaire des propriétés de valeur de clé à attribuer à ce service web. Vous ne pouvez pas changer ces propriétés après le déploiement. Toutefois, vous pouvez ajouter de nouvelles paires clé-valeur.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.description

Description à fournir à ce Webservice.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.gpu_cores

Nombre de cœurs GPU à allouer pour ce service web. La valeur par défaut est 0.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.period_seconds

Fréquence (en secondes) d’exécution de probe liveness. La valeur par défaut est 10 secondes. La valeur minimale est 1.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.initial_delay_seconds

Nombre de secondes après le démarrage du conteneur avant le lancement des probes liveness. La valeur par défaut est 310.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.timeout_seconds

Délai d’expiration en secondes de la probe liveness. La valeur par défaut est de 2 secondes. La valeur minimale est 1.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.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.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.failure_threshold

Lorsqu’un Pod démarre et que la probe liveness échoue, Kubernetes essaie failureThreshold fois avant d’abandonner. La valeur par défaut est 3. La valeur minimale est 1.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.namespace

Espace de noms Kubernetes sur lequel déployer ce Webservice : jusqu’à 63 caractères alphanumériques minuscules (lettres allant de « a » à « z », chiffres allant de « 0 » à « 9 » et traits d’union (« - »)). Le premier caractère et le dernier caractère ne peuvent pas être des traits d’union.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.token_auth_enabled

Indique s’il est nécessaire ou non d’activer l’authentification Azure Active Directory pour ce service web. Si cette option est activée, les utilisateurs peuvent accéder au Webservice en récupérant un jeton d’accès à l’aide de leurs informations d’identification Azure Active Directory. Valeur par défaut False.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.version_name

Nom de la version dans un point de terminaison.

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.traffic_percentile

Quantité de trafic que la version prend dans un point de terminaison.

Méthodes

validate_endpoint_configuration

Vérifie que les valeurs de configuration spécifiées sont valides.

Lève une WebserviceException si la validation échoue.

validate_endpoint_configuration

Vérifie que les valeurs de configuration spécifiées sont valides.

Lève une WebserviceException si la validation échoue.

validate_endpoint_configuration()

Exceptions

Type Description