Partager via

ContainerImage Classe

  • Référence

Représente une image de conteneur, actuellement uniquement pour les images Docker.

Cette classe est DÉPRÉCIÉE. Utilisez plutôt la classe Environment.

L’image contient les dépendances nécessaires à l’exécution du modèle :

  • Runtime

  • Définitions d’environnement Python spécifiées dans un fichier Conda

  • Possibilité d’activer la prise en charge GPU

  • Fichier Docker personnalisé pour les commandes d’exécution spécifiques

Constructeur d’image.

Cette classe est DÉPRÉCIÉE. Utilisez plutôt la classe Environment.

Le constructeur d’image est utilisé pour récupérer une représentation cloud d’un objet Image associé à l’espace de travail fourni. Retourne une instance d’une classe enfant correspondant au type spécifique de l’objet Image récupéré.

Héritage
Image
ContainerImage

Constructeur

ContainerImage(workspace, name=None, id=None, tags=None, properties=None, version=None)

Paramètres

Nom Description
workspace
Obligatoire
Workspace

Objet d’espace de travail contenant l’image à récupérer
name
str

Nom de l’image à récupérer. Retourne la dernière version, le cas échéant

Valeur par défaut: None
id
str

ID spécifique de l’image à récupérer. (L’ID est « : »)

Valeur par défaut: None
tags
list

Filtre les résultats d’image en fonction de la liste fournie, par « key » ou « [key, value] ». Ex. ['key', ['key2', 'key2 value']]

Valeur par défaut: None
properties
list

Filtre les résultats d’image en fonction de la liste fournie, par « key » ou « [key, value] ». Ex. ['key', ['key2', 'key2 value']]

Valeur par défaut: None
version
str

Quand la version et le nom sont tous les deux spécifiés, retourne la version spécifique de l’image.

Valeur par défaut: None

Remarques

Une ContainerImage est récupérée à l’aide du constructeur de classe Image en transmettant le nom ou l’ID d’une ContainerImage créée précédemment. L’exemple de code suivant illustre la récupération d’une image à partir d’un espace de travail selon le nom et l’ID.


   container_image_from_name = Image(workspace, name="image-name")
   container_image_from_id = Image(workspace, id="image-id")

Pour créer une nouvelle configuration d’image à utiliser dans un déploiement, générez un objet ContainerImageConfig comme indiqué dans l’exemple de code suivant :


   from azureml.core.image import ContainerImage

   image_config = ContainerImage.image_configuration(execution_script="score.py",
                                                    runtime="python",
                                                    conda_file="myenv.yml",
                                                    description="image for model",
                                                    cuda_version="9.0"
                                                    )

Méthodes

image_configuration

Crée et retourne un objet ContainerImageConfig.

Cette fonction accepte des paramètres pour définir la manière dont votre modèle doit s’exécuter dans le service web, ainsi que l’environnement et les dépendances spécifiques dont il a besoin pour pouvoir s’exécuter.
run

Exécute l’image localement avec les données d’entrée spécifiées.

Docker doit être installé et en cours d’exécution pour fonctionner. Cette méthode fonctionne uniquement sur le processeur, car l’image avec processeur graphique (GPU) peut s’exécuter uniquement sur les Services Microsoft Azure.
serialize

Convertit cet objet ContainerImage en dictionnaire JSON sérialisé.

image_configuration

Crée et retourne un objet ContainerImageConfig.

Cette fonction accepte des paramètres pour définir la manière dont votre modèle doit s’exécuter dans le service web, ainsi que l’environnement et les dépendances spécifiques dont il a besoin pour pouvoir s’exécuter.

static image_configuration(execution_script, runtime, conda_file=None, docker_file=None, schema_file=None, dependencies=None, enable_gpu=None, tags=None, properties=None, description=None, base_image=None, base_image_registry=None, cuda_version=None)

Paramètres

Nom Description
execution_script
Obligatoire
str

Chemin d’accès au fichier Python local contenant le code à exécuter pour l’image. Doit inclure à la fois les fonctions init() et run(input_data) qui définissent les étapes d’exécution du modèle pour le service web.
runtime
Obligatoire
str

Runtime à utiliser pour l’image. Actuellement, les runtimes pris en charge sont « spark-py » et « python ».
conda_file
str

Chemin d’accès au fichier .yml local contenant une définition d’environnement Conda à utiliser pour l’image.

Valeur par défaut: None
docker_file
str

Chemin d’accès au fichier local contenant des étapes Docker supplémentaires à exécuter lors de la configuration de l’image.

Valeur par défaut: None
schema_file
str

Chemin d’accès au fichier local contenant un schéma de service web à utiliser lorsque l’image est déployée. Utilisé pour générer des spécifications Swagger pour un modèle de déploiement.

Valeur par défaut: None
dependencies
list[str]

Liste de chemins d’accès aux fichiers/dossiers supplémentaires qui sont nécessaires à l’exécution de l’image.

Valeur par défaut: None
enable_gpu
bool

Activer ou non la prise en charge GPU dans l’image. L’image GPU doit être utilisée sur les services Microsoft Azure tels que Azure Container Instances, Capacité de calcul Azure Machine Learning, Machines virtuelles Azure et Azure Kubernetes Service. Par défaut, False

Valeur par défaut: None
tags
dict[str, str]

Dictionnaire des étiquettes de valeur de clé à attribuer à cette image.

Valeur par défaut: None
properties
dict[str, str]

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

Valeur par défaut: None
description
str

Description textuelle à utiliser pour cette image.

Valeur par défaut: None
base_image
str

Image personnalisée à utiliser comme image de base. Si aucune image de base n’est proposée, l’image de base sera utilisée en fonction d’un paramètre d’exécution donné.

Valeur par défaut: None
base_image_registry
ContainerRegistry

Registre d’images contenant l’image de base.

Valeur par défaut: None
cuda_version
str

Version de CUDA à installer pour les images nécessitant une prise en charge GPU. L’image GPU doit être utilisée sur les services Microsoft Azure tels que Azure Container Instances, Capacité de calcul Azure Machine Learning, Machines virtuelles Azure et Azure Kubernetes Service. Les versions prises en charge sont les versions 9.0, 9.1 et 10.0. Si « enable_gpu » est défini, la valeur par défaut est « 9.1 ».

Valeur par défaut: None

Retours

Type Description
ContainerImageConfig

Objet de configuration à utiliser lors de la création de l’image.

Exceptions

Type Description
WebserviceException

run

Exécute l’image localement avec les données d’entrée spécifiées.

Docker doit être installé et en cours d’exécution pour fonctionner. Cette méthode fonctionne uniquement sur le processeur, car l’image avec processeur graphique (GPU) peut s’exécuter uniquement sur les Services Microsoft Azure.

run(input_data)

Paramètres

Nom Description
input_data
Obligatoire
<xref:varies>

Données d’entrée à transmettre à l’image lors de l’exécution

Retours

Type Description
<xref:varies>

Résultats de l’exécution de l’image.

Exceptions

Type Description
WebserviceException

serialize

Convertit cet objet ContainerImage en dictionnaire JSON sérialisé.

serialize()

Retours

Type Description
dict

Représentation JSON de cette ContainerImage.

Exceptions

Type Description
WebserviceException