Partager via

ContainerImage Classe

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

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

L’image contient les dépendances nécessaires pour exécuter le modèle, notamment :

  • Runtime

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

  • Possibilité d’activer la prise en charge du GPU

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

Constructeur d’image.

Cette classe est DÉCONSEILLÉ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é.

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 «< name> :<version> »)

Valeur par défaut: None
tags
list

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

Valeur par défaut: None
properties
list

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

Valeur par défaut: None
version
str

Lorsque 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

Un ContainerImage est récupéré à l’aide du Image constructeur de classe en passant le nom ou l’ID d’un ContainerImage créé précédemment. L’exemple de code suivant montre une récupération d’image à partir d’un espace de travail par nom et ID.


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

Pour créer une configuration d’image à utiliser dans un déploiement, générez un ContainerImageConfig objet comme illustré 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éez et retournez un ContainerImageConfig objet.

Cette fonction accepte des paramètres pour définir la façon dont votre modèle doit s’exécuter dans le service Web, ainsi que l’environnement et les dépendances spécifiques qu’il doit exécuter.
run

Exécutez l’image localement avec les données d’entrée données.

Docker doit être installé et en cours d’exécution pour fonctionner. Cette méthode fonctionne uniquement sur l’UC, car l’image avec GPU ne peut s’exécuter que sur les services Microsoft Azure.
serialize

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

image_configuration

Créez et retournez un ContainerImageConfig objet.

Cette fonction accepte des paramètres pour définir la façon dont votre modèle doit s’exécuter dans le service Web, ainsi que l’environnement et les dépendances spécifiques qu’il doit 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 qui contient le code à exécuter pour l’image. Doit inclure 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. Les runtimes pris en charge actuels 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 déploiement de modèle.

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

Liste des chemins d’accès aux fichiers/dossiers supplémentaires que l’image doit exécuter.

Valeur par défaut: None
enable_gpu
bool

Indique s’il faut activer ou non la prise en charge du GPU dans l’image. L’image GPU doit être utilisée sur les services Microsoft Azure tels qu’Azure Container Instances, Azure Machine Learning Compute, Les machines virtuelles Azure et Azure Kubernetes Service. Par défaut, False

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

Dictionnaire de balises de valeur clé pour donner cette image.

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

Dictionnaire de propriétés de valeur clé pour donner cette image. 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
str

Description textuelle pour donner 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 donnée, l’image de base est utilisée en fonction du paramètre d’exécution donné.

Valeur par défaut: None
base_image_registry
ContainerRegistry

Registre d’images qui contient 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 qu’Azure Container Instances, Azure Machine Learning Compute, Les machines virtuelles Azure et Azure Kubernetes Service. Les versions prises en charge sont 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écutez l’image localement avec les données d’entrée données.

Docker doit être installé et en cours d’exécution pour fonctionner. Cette méthode fonctionne uniquement sur l’UC, car l’image avec GPU ne peut s’exécuter que 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

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

serialize()

Retours

Type Description
dict

Représentation JSON de ce ContainerImage.