ModelPackage Classe

  • Référence

Représente un empaquetage d’un ou de plusieurs modèles et de leurs dépendances dans une image Docker ou un fichier Docker.

Un objet ModelPackage est retourné à partir de la méthode package de la classe Model. Le paramètre generate_dockerfile de la méthode de package détermine si une image Docker ou fichier Docker est créé(e).

Initialisez le package créé avec des modèles et des dépendances.

Héritage
builtins.object
ModelPackage

Constructeur

ModelPackage(workspace, operation_id, environment)

Paramètres

Nom Description
workspace
Obligatoire
Workspace

Espace de travail dans lequel se trouve le package.
operation_id
Obligatoire
str

ID de l’opération de création du package.
environment
Obligatoire
Environment

Environnement dans lequel le modèle est empaqueté.
workspace
Obligatoire
Workspace

Espace de travail dans lequel se trouve le package.
operation_id
Obligatoire
str

ID de l’opération de création du package.
environment
Obligatoire
Environment

Environnement dans lequel le modèle est empaqueté.

Remarques

Pour générer une image Docker qui encapsule votre modèle et ses dépendances, vous pouvez utiliser l’option d’empaquetage de modèle. L’image de sortie sera envoyée (push) dans l’ACR de votre espace de travail.

Vous devez inclure un objet Environment dans votre configuration d’inférence pour utiliser la méthode Empaquetage de modèle.


   package = Model.package(ws, [model], inference_config)
   package.wait_for_creation(show_output=True)  # Or show_output=False to hide the Docker build logs.
   package.pull()

Au lieu d’une image entièrement générée, vous pouvez à la place générer un Dockerfile et télécharger toutes les ressources nécessaires pour créer une image en plus de votre environnement.


   package = Model.package(ws, [model], inference_config, generate_dockerfile=True)
   package.wait_for_creation(show_output=True)
   package.save("./local_context_dir")

Variables

Nom Description
azureml.core.model.ModelPackage.workspace

Espace de travail dans lequel est créé le package.

Méthodes

get_container_registry

Retourne un objet ContainerRegistry indiquant l’emplacement de stockage de l’image ou de l’image de base (packages Dockerfile).
get_logs

Récupère les journaux de création du package.
pull

Extrait la sortie du package sur l’ordinateur local.

Ne peut être utilisé qu’avec un package d’images Docker.
save

Enregistre la sortie du package dans un répertoire local.

Ne peut être utilisé qu’avec un package Dockerfile.
serialize

Convertit ce ModelPackage en dictionnaire JSON sérialisable pour affichage par l’interface CLI.
update_creation_state

Actualise l’état actuel de l’objet en mémoire.

Cette méthode effectue une mise à jour sur place des propriétés de l’objet en fonction de l’état actuel de l’objet cloud correspondant. Elle est principalement utilisée pour l’interrogation manuelle de l’état de création.
wait_for_creation

Attend que la création du package soit terminée.

Cette méthode attend que la création du package atteigne un état terminal. Lève une exception WebserviceException si elle atteint un état terminal infructueux.

get_container_registry

Retourne un objet ContainerRegistry indiquant l’emplacement de stockage de l’image ou de l’image de base (packages Dockerfile).

get_container_registry()

Retours

Type Description
ContainerRegistry

Adresse et informations de connexion du registre de conteneurs.

get_logs

Récupère les journaux de création du package.

get_logs(decode=True, offset=0)

Paramètres

Nom Description
decode
bool

Indique s’il faut décoder les octets de journal bruts en chaîne.

Valeur par défaut: True
offset
int

Décalage d’octet à partir duquel commencer la lecture des journaux.

Valeur par défaut: 0

Retours

Type Description
bytes,
str

Journaux de création du package.

Exceptions

Type Description
WebserviceException

pull

Extrait la sortie du package sur l’ordinateur local.

Ne peut être utilisé qu’avec un package d’images Docker.

pull()

Exceptions

Type Description
WebserviceException

save

Enregistre la sortie du package dans un répertoire local.

Ne peut être utilisé qu’avec un package Dockerfile.

save(output_directory)

Paramètres

Nom Description
output_directory
Obligatoire
str

Répertoire local qui sera créé pour inclure le contenu du package.

Exceptions

Type Description
WebserviceException

serialize

Convertit ce ModelPackage en dictionnaire JSON sérialisable pour affichage par l’interface CLI.

serialize()

Retours

Type Description
dict

Représentation JSON de ce ModelPackage.

update_creation_state

Actualise l’état actuel de l’objet en mémoire.

Cette méthode effectue une mise à jour sur place des propriétés de l’objet en fonction de l’état actuel de l’objet cloud correspondant. Elle est principalement utilisée pour l’interrogation manuelle de l’état de création.

update_creation_state()

Exceptions

Type Description
WebserviceException

wait_for_creation

Attend que la création du package soit terminée.

Cette méthode attend que la création du package atteigne un état terminal. Lève une exception WebserviceException si elle atteint un état terminal infructueux.

wait_for_creation(show_output=False)

Paramètres

Nom Description
show_output
bool

Indique s’il est nécessaire d’imprimer une sortie plus détaillée.

Valeur par défaut: False

Exceptions

Type Description
WebserviceException