AciWebservice Classe
Représente un modèle Machine Learning déployé en tant que point de terminaison de service web sur Azure Container Instances.
Un service déployé est créé à partir d’un modèle, d’un script et de fichiers associés. Le service web résultant est un point de terminaison HTTP à charge équilibrée avec une API REST. Vous pouvez envoyer des données à cette API et recevoir la prédiction retournée par le modèle.
Pour plus d’informations, consultez Déployer un modèle dans Azure Container Instances.
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
AciWebservice(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. |
Remarques
Le modèle de déploiement recommandé consiste à créer un objet de configuration de déploiement avec la deploy_configuration méthode, puis à l’utiliser avec la deploy méthode de la Model classe, comme indiqué ci-dessous.
from azureml.core.model import InferenceConfig
from azureml.core.webservice import AciWebservice
service_name = 'my-custom-env-service'
inference_config = InferenceConfig(entry_script='score.py', environment=environment)
aci_config = AciWebservice.deploy_configuration(cpu_cores=1, memory_gb=1)
service = Model.deploy(workspace=ws,
name=service_name,
models=[model],
inference_config=inference_config,
deployment_config=aci_config,
overwrite=True)
service.wait_for_deployment(show_output=True)
Il existe plusieurs façons de déployer un modèle en tant que service web, notamment avec les éléments suivants :
deployméthode des Model modèles déjà inscrits dans l’espace de travail.deploy_from_imageméthode de Webservice.deploy_from_modelméthode des Webservice modèles déjà inscrits dans l’espace de travail. Cette méthode crée une image.deployméthode de l’objet Webservice, qui inscrit un modèle et crée une image.
Pour plus d’informations sur l’utilisation des services web, consultez
La section Variables répertorie les attributs d’une représentation locale de l’objet AciWebservice cloud. Ces variables doivent être considérées comme en lecture seule. La modification de leurs valeurs ne sera pas reflétée dans l’objet cloud correspondant.
Variables
| Nom | Description |
|---|---|
|
enable_app_insights
|
Indique si la journalisation AppInsights est activée ou non pour le service Web. |
|
cname
|
Nom cname pour le service Web. |
|
container_resource_requirements
|
Configuration requise pour les ressources de conteneur pour le service Web. |
|
encryption_properties
|
Propriétés de chiffrement du service Web. |
|
vnet_configuration
|
Les propriétés du réseau virtuel pour le service Web, la configuration doit être créée et fournie par l’utilisateur. |
|
azureml.core.webservice.AciWebservice.location
|
Emplacement sur lequel le service Web est déployé. |
|
public_ip
|
Adresse IP publique du service Web. |
|
azureml.core.webservice.AciWebservice.scoring_uri
|
Point de terminaison de scoring pour le service Web |
|
ssl_enabled
|
Indique si SSL est activé ou non pour le service Web |
|
public_fqdn
|
Nom de domaine complet public pour le service Web |
|
environment
|
Objet Environment utilisé pour créer le service Web |
|
azureml.core.webservice.AciWebservice.models
|
Liste des modèles déployés sur le service Web |
|
azureml.core.webservice.AciWebservice.swagger_uri
|
Point de terminaison Swagger pour le service Web |
Méthodes
| add_properties |
Ajoutez des paires clé-valeur au dictionnaire de propriétés de ce service WebService. |
| add_tags |
Ajoutez des paires clé-valeur au dictionnaire d’étiquettes de ce service WebService. |
| deploy_configuration |
Créez un objet de configuration pour le déploiement d’un AciWebservice. |
| get_token |
Récupérez le jeton d’authentification pour ce service Web, limité à l’utilisateur actuel. Remarque Non implémenté. |
| remove_tags |
Supprimez les clés spécifiées du dictionnaire de balises de ce service WebService. |
| run |
Appelez ce service Web avec l’entrée fournie. |
| serialize |
Convertissez ce service Web en dictionnaire sérialisé JSON. |
| update |
Mettez à jour le service Web avec les propriétés fournies. Les valeurs laissées comme None restent inchangées dans ce service Web. |
add_properties
add_tags
Ajoutez des paires clé-valeur au dictionnaire d’étiquettes de ce service WebService.
add_tags(tags)
Paramètres
| Nom | Description |
|---|---|
|
tags
Obligatoire
|
Dictionnaire de balises à ajouter. |
Exceptions
| Type | Description |
|---|---|
deploy_configuration
Créez un objet de configuration pour le déploiement d’un AciWebservice.
static deploy_configuration(cpu_cores=None, memory_gb=None, tags=None, properties=None, description=None, location=None, auth_enabled=None, ssl_enabled=None, enable_app_insights=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, dns_name_label=None, primary_key=None, secondary_key=None, collect_model_data=None, cmk_vault_base_url=None, cmk_key_name=None, cmk_key_version=None, vnet_name=None, subnet_name=None)
Paramètres
| Nom | Description |
|---|---|
|
cpu_cores
|
Nombre de cœurs d’UC à allouer pour ce service Web. 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 ce service Web. Peut être une décimale. La valeur par défaut est 0.5 Valeur par défaut: None
|
|
tags
|
Dictionnaire de balises de valeur de clé pour donner à ce service Webservice. Valeur par défaut: None
|
|
properties
|
Dictionnaire de propriétés de valeur de clé pour donner à ce service Web. 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 service Web. Valeur par défaut: None
|
|
location
|
Région Azure dans laquelle déployer ce service web. Si elle n’est pas spécifiée, l’emplacement de l’espace de travail sera utilisé. Pour plus d’informations sur les régions disponibles, consultez Produits par région. Valeur par défaut: None
|
|
auth_enabled
|
Indique s’il faut activer l’authentification pour ce service Web. Valeur par défaut False. Valeur par défaut: None
|
|
ssl_enabled
|
Indique s’il faut activer SSL pour ce service Web. Valeur par défaut False. Valeur par défaut: None
|
|
enable_app_insights
|
Indique s’il faut activer AppInsights pour ce service Web. Valeur par défaut False. Valeur par défaut: None
|
|
ssl_cert_pem_file
|
Fichier de certificat nécessaire si SSL est activé. Valeur par défaut: None
|
|
ssl_key_pem_file
|
Fichier de clé nécessaire si SSL est activé. Valeur par défaut: None
|
|
ssl_cname
|
Nom cname pour lequel SSL est activé. Valeur par défaut: None
|
|
dns_name_label
|
Étiquette de nom DNS pour le point de terminaison de scoring. Si aucune étiquette de nom DNS unique n’est spécifiée, elle est générée pour le point de terminaison de scoring. Valeur par défaut: None
|
|
primary_key
|
Clé d’authentification primaire à utiliser pour ce service Web. Valeur par défaut: None
|
|
secondary_key
|
Clé d’authentification secondaire à utiliser pour ce service Web. Valeur par défaut: None
|
|
collect_model_data
|
Indique si la collecte de données de modèle est activée ou non pour le service Web. Valeur par défaut: None
|
|
cmk_vault_base_url
|
URL de base du coffre de clés géré par le client Valeur par défaut: None
|
|
cmk_key_name
|
nom de clé gérée par le client. Valeur par défaut: None
|
|
cmk_key_version
|
version de clé gérée par le client. Valeur par défaut: None
|
|
vnet_name
|
nom du réseau virtuel. Valeur par défaut: None
|
|
subnet_name
|
nom de sous-réseau au sein du réseau virtuel. Valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
|
Objet de configuration à utiliser lors du déploiement d’un objet Webservice. |
Exceptions
| Type | Description |
|---|---|
get_token
Récupérez le jeton d’authentification pour ce service Web, limité à l’utilisateur actuel.
Remarque
Non implémenté.
get_token()
Retours
| Type | Description |
|---|---|
|
Jeton d’authentification pour ce service Web et quand il doit être actualisé après. |
Exceptions
| Type | Description |
|---|---|
|
azureml.exceptions.NotImplementedError
|
remove_tags
run
Appelez ce service Web avec l’entrée fournie.
run(input_data)
Paramètres
| Nom | Description |
|---|---|
|
input_data
Obligatoire
|
<xref:varies>
Entrée avec lequel appeler le service Web. |
Retours
| Type | Description |
|---|---|
|
Résultat de l’appel du service Web. |
Exceptions
| Type | Description |
|---|---|
serialize
Convertissez ce service Web en dictionnaire sérialisé JSON.
serialize()
Retours
| Type | Description |
|---|---|
|
Représentation JSON de cet objet Webservice. |
update
Mettez à jour le service Web avec les propriétés fournies.
Les valeurs laissées comme None restent inchangées dans ce service Web.
update(image=None, tags=None, properties=None, description=None, auth_enabled=None, ssl_enabled=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, enable_app_insights=None, models=None, inference_config=None)
Paramètres
| Nom | Description |
|---|---|
|
image
|
Nouvelle image à déployer sur le service Web. Valeur par défaut: None
|
|
tags
|
Dictionnaire de balises de valeur de clé pour donner à ce service Webservice. Remplace les balises existantes. Valeur par défaut: None
|
|
properties
|
Dictionnaire de propriétés de valeur de clé à ajouter au dictionnaire de propriétés existantes. Valeur par défaut: None
|
|
description
|
Description pour donner à ce service Web. Valeur par défaut: None
|
|
auth_enabled
|
Activez ou désactivez l’authentification pour ce service Web. Valeur par défaut: None
|
|
ssl_enabled
|
Indique s’il faut activer SSL pour ce service Web. Valeur par défaut: None
|
|
ssl_cert_pem_file
|
Fichier de certificat nécessaire si SSL est activé. Valeur par défaut: None
|
|
ssl_key_pem_file
|
Fichier de clé nécessaire si SSL est activé. Valeur par défaut: None
|
|
ssl_cname
|
Nom cname pour lequel SSL est activé. Valeur par défaut: None
|
|
enable_app_insights
|
Indique s’il faut activer AppInsights pour ce service Web. Valeur par défaut: None
|
|
models
|
Liste des objets Model à empaqueter dans 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
|
Retours
| Type | Description |
|---|---|