LocalWebservice Classe

Référence

Représente un modèle Machine Learning déployé en tant que point de terminaison de service web local.

Le déploiement local de services web est utile au débogage et aux tests de scénarios.

Constructeur de service web local.

Le constructeur LocalWebservice est utilisé pour récupérer une représentation locale d’un objet LocalWebservice associé à l’espace de travail fourni.

Héritage: Webservice

LocalWebservice

Constructeur

LocalWebservice(*args, **kwargs)

Paramètres

Nom	Description
workspace Obligatoire	Workspace Objet Workspace contenant les objets Model à récupérer.
name Obligatoire	str Nom de l’objet Webservice à récupérer.
must_exist Obligatoire	bool Indique si le service web doit déjà exister au moment de la création de l’objet en mémoire.
workspace Obligatoire	Workspace Objet Workspace contenant les objets Model à récupérer.
name Obligatoire	str Nom de l’objet LocalWebservice à récupérer.
must_exist Obligatoire	bool Indique si le service web doit déjà exister au moment de la création de l’objet en mémoire.

Remarques

Les exemples de code suivants montrent comment créer un service web Docker local. Pour plus d’informations, consultez le lien du notebook.


   from azureml.core.webservice import LocalWebservice

   # This is optional, if not provided Docker will choose a random unused port.
   deployment_config = LocalWebservice.deploy_configuration(port=6789)

   local_service = Model.deploy(ws, "test", [model], inference_config, deployment_config)

   local_service.wait_for_deployment()

Un exemple complet est disponible à l’adresse https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb

Méthodes

delete	Supprime cet objet LocalWebservice de l’ordinateur local. Cet appel de fonction n’est pas asynchrone ; il s’exécute jusqu’à ce que le service soit supprimé.
deploy_configuration	Crée un objet Configuration pour le déploiement d’un service web local.
deploy_to_cloud	Déploie un service web basé sur la configuration de l’objet LocalWebservice.
deserialize	Convertit un objet JSON de réponse au service Gestion des modèles en objet Webservice. Notes Non pris en charge pour LocalWebservice.
get_keys	Récupère des clés d’authentification pour ce service web. Notes Non pris en charge pour LocalWebservice.
get_logs	Récupère les journaux de cet objet LocalWebservice.
get_token	Récupère le jeton d’authentification de ce service web, limité à l’utilisateur actif. Notes Non pris en charge pour LocalWebservice.
list	Liste les objets LocalWebservice associés à l’espace de travail correspondant. Les résultats retournés peuvent être filtrés à l’aide de paramètres.
regen_key	Regénère l’une des clés du service web. Notes Non pris en charge pour LocalWebservice.
reload	Recharge le script d’exécution et les dépendances de l’objet LocalWebservice. Le conteneur du service redémarre alors avec des copies des ressources mises à jour, notamment le script d’exécution et les dépendances locales, mais l’image sous-jacente n’est pas regénérée. Par conséquent, les modifications apportées aux dépendances Conda/PIP ou aux étapes Docker personnalisées ne sont pas répercutées dans l’objet LocalWebservice rechargé. Pour traiter ces modifications, appelez plutôt la méthode update.
run	Appelle cet objet LocalWebservice avec l’entrée fournie.
serialize	Convertit cet objet Webservice en dictionnaire sérialisé par JSON.
update	Met à jour l’objet LocalWebservice avec les propriétés fournies. Les valeurs pour lesquelles None est spécifié restent inchangées dans cet objet LocalWebservice.
update_deployment_state	Actualise l’état actuel de l’objet en mémoire. Effectue une mise à jour sur place des propriétés de l’objet en fonction de l’état actuel du conteneur Docker local correspondant.
wait_for_deployment	Interroge le déploiement LocalWebservice en cours d’exécution.

delete

Supprime cet objet LocalWebservice de l’ordinateur local.

Cet appel de fonction n’est pas asynchrone ; il s’exécute jusqu’à ce que le service soit supprimé.

delete(delete_cache=True, delete_image=False, delete_volume=True)

Paramètres

Nom	Description
delete_cache Obligatoire	bool Indique si les fichiers temporaires mis en cache pour le service doivent être supprimés. (Valeur par défaut : True)
delete_image Obligatoire	bool Indique si l’image Docker du service doit être supprimée. (Par défaut : False)
delete_volume Obligatoire	bool Indique si le volume Docker du service doit être supprimé. (Valeur par défaut : True)

Exceptions

Type	Description
WebserviceException

deploy_configuration

Crée un objet Configuration pour le déploiement d’un service web local.

static deploy_configuration(port=None)

Paramètres

Nom	Description
port	int Port local sur lequel exposer le point de terminaison HTTP du service. Valeur par défaut: None

Retours

Type	Description
LocalWebserviceDeploymentConfiguration	Objet Configuration à utiliser lors du déploiement d’un objet WebService.

Exceptions

Type	Description
WebserviceException

deploy_to_cloud

Déploie un service web basé sur la configuration de l’objet LocalWebservice.

deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)

Paramètres

Nom	Description
name	str Nom à donner au service déployé. Doit être unique à l’espace de travail. Valeur par défaut: None
deployment_config	WebserviceDeploymentConfiguration Objet WebserviceDeploymentConfiguration utilisé pour configurer le service web. En l’absence d’indication, un objet de configuration vide est utilisé en fonction de la cible souhaitée. Valeur par défaut: None
deployment_target	ComputeTarget Objet ComputeTarget sur lequel le service web doit être déployé. Comme aucun ComputeTarget n’est associé à ACI, laissez à ce paramètre la valeur None pour effectuer le déploiement sur ACI. Valeur par défaut: None

Retours

Type	Description
Webservice	Objet Webservice correspondant au service web déployé.

Exceptions

Type	Description
WebserviceException

deserialize

Convertit un objet JSON de réponse au service Gestion des modèles en objet Webservice.

Notes

Non pris en charge pour LocalWebservice.

deserialize(workspace, webservice_payload)

Paramètres

Nom	Description
cls Obligatoire
workspace Obligatoire	Workspace Objet Workspace sous lequel le service web est inscrit.
webservice_payload Obligatoire	dict Objet JSON à convertir en objet Webservice.

Exceptions

Type	Description
azureml.exceptions.NotImplementedError

get_keys

Récupère des clés d’authentification pour ce service web.

Notes

Non pris en charge pour LocalWebservice.

get_keys()

Retours

Type	Description
	Clés d’authentification pour ce service web.

Exceptions

Type	Description
azureml.exceptions.NotImplementedError

get_logs

Récupère les journaux de cet objet LocalWebservice.

get_logs(num_lines=5000, raw=False)

Paramètres

Nom	Description
num_lines Obligatoire	int Nombre maximal de lignes de journal à récupérer. (Valeur par défaut : 5000)
raw Obligatoire	bool Retourne la sortie brute du conteneur Docker sans tenter de la mettre en forme. (Par défaut : False)

Retours

Type	Description
str	Journaux de cet objet LocalWebservice.

Exceptions

Type	Description
WebserviceException

get_token

Récupère le jeton d’authentification de ce service web, limité à l’utilisateur actif.

Notes

Non pris en charge pour LocalWebservice.

get_token()

Retours

Type	Description
str, datetime	Jeton d’authentification pour ce service web et moment auquel il doit être actualisé par la suite.

Exceptions

Type	Description
azureml.exceptions.NotImplementedError

list

Liste les objets LocalWebservice associés à l’espace de travail correspondant.

Les résultats retournés peuvent être filtrés à l’aide de paramètres.

static list(workspace, model_name=None, model_id=None, all=None)

Paramètres

Nom	Description
workspace Obligatoire	Workspace Objet Workspace associé aux objets LocalWebservice.
model_name	str Filtre la liste pour inclure uniquement les objets LocalWebservice déployés avec le nom de modèle spécifique. Valeur par défaut: None
model_id	str Filtre la liste afin de n’inclure que les objets LocalWebservice déployés avec l’ID de modèle spécifique. Valeur par défaut: None
all	bool Affiche tous les services. Par défaut, seuls les services en cours d’exécution sont affichés. Valeur par défaut: None

Retours

Type	Description
list[LocalWebservice]	Liste filtrée des objets LocalWebservice associés à l’espace de travail fourni.

Exceptions

Type	Description
WebserviceException

regen_key

Regénère l’une des clés du service web.

Notes

Non pris en charge pour LocalWebservice.

regen_key(key)

Paramètres

Nom	Description
key Obligatoire	str Clé à regénérer. Les options sont « Primary » ou « Secondary »

Exceptions

Type	Description
NotImplementedError

reload

Recharge le script d’exécution et les dépendances de l’objet LocalWebservice.

Le conteneur du service redémarre alors avec des copies des ressources mises à jour, notamment le script d’exécution et les dépendances locales, mais l’image sous-jacente n’est pas regénérée. Par conséquent, les modifications apportées aux dépendances Conda/PIP ou aux étapes Docker personnalisées ne sont pas répercutées dans l’objet LocalWebservice rechargé. Pour traiter ces modifications, appelez plutôt la méthode update.

reload(wait=False)

Paramètres

Nom	Description
wait Obligatoire	bool Attend que le conteneur du service atteigne un état d’intégrité. (Par défaut : False)

Exceptions

Type	Description
WebserviceException

run

Appelle cet objet LocalWebservice avec l’entrée fournie.

run(input_data)

Paramètres

Nom	Description
input_data Obligatoire	<xref:varies> Entrée avec laquelle appeler l’objet LocalWebservice.

Retours

Type	Description
<xref:varies>	Résultat de l’appel de l’objet LocalWebservice.

Exceptions

Type	Description
WebserviceException

serialize

Convertit cet objet Webservice en dictionnaire sérialisé par JSON.

serialize()

Retours

Type	Description
dict	Représentation sérialisée de l’objet WebService.

Exceptions

Type	Description
WebserviceException

update

Met à jour l’objet LocalWebservice avec les propriétés fournies.

Les valeurs pour lesquelles None est spécifié restent inchangées dans cet objet LocalWebservice.

update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)

Paramètres

Nom	Description
models Obligatoire	list[Model] Nouvelle liste des modèles contenus dans l’objet LocalWebservice.
image_config Obligatoire	ContainerImageConfig Options de configuration d’image à appliquer à l’objet LocalWebservice.
deployment_config Obligatoire	LocalWebserviceDeploymentConfiguration Options de configuration de déploiement à appliquer à l’objet LocalWebservice.
inference_config Obligatoire	InferenceConfig Objet InferenceConfig utilisé pour fournir les propriétés de déploiement de modèle nécessaires.
wait Obligatoire	bool Attend que le conteneur du service atteigne un état d’intégrité. (Par défaut : False)

Retours

Type	Description
None

Exceptions

Type	Description
WebserviceException

update_deployment_state

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

Effectue une mise à jour sur place des propriétés de l’objet en fonction de l’état actuel du conteneur Docker local correspondant.

update_deployment_state(must_exist=False)

Paramètres

Nom	Description
must_exist	bool Indique si le service web doit déjà exister au moment de la création de l’objet en mémoire. Valeur par défaut: False

Exceptions

Type	Description
WebserviceException

wait_for_deployment

Interroge le déploiement LocalWebservice en cours d’exécution.

wait_for_deployment(show_output=False)

Paramètres

Nom	Description
show_output Obligatoire	bool Option permettant d’imprimer une sortie plus détaillée. (Par défaut : False)

Exceptions

Type	Description
WebserviceException

Attributs

port

Obtient le port du service web local.

Retours

Type	Description
int	Numéro de port.

scoring_uri

Obtient l’URI de scoring du service web local.

Retours

Type	Description
str	URI de scoring.

swagger_uri

Obtient l’URI Swagger du service web local.

Retours

Type	Description
str	URI Swagger.

NETWORK_NAME

NETWORK_NAME = 'azureml-local'

STATE_DELETED

STATE_DELETED = 'deleted'

STATE_DEPLOYING

STATE_DEPLOYING = 'deploying'

STATE_FAILED

STATE_FAILED = 'failed'

STATE_RUNNING

STATE_RUNNING = 'running'

STATE_UNKNOWN

STATE_UNKNOWN = 'unknown'

Partager via

LocalWebservice Classe

Constructeur

Paramètres

Remarques

Méthodes

delete

Paramètres

Exceptions

deploy_configuration

Paramètres

Retours

Exceptions

deploy_to_cloud

Paramètres

Retours

Exceptions

deserialize

Paramètres

Exceptions

get_keys

Retours

Exceptions

get_logs

Paramètres

Retours

Exceptions

get_token

Retours

Exceptions

list

Paramètres

Retours

Exceptions

regen_key

Paramètres

Exceptions

reload

Paramètres

Exceptions

run

Paramètres

Retours

Exceptions

serialize

Retours

Exceptions

update

Paramètres

Retours

Exceptions

update_deployment_state

Paramètres

Exceptions

wait_for_deployment

Paramètres

Exceptions

Attributs

port

Retours

scoring_uri

Retours

swagger_uri

Retours

NETWORK_NAME

STATE_DELETED

STATE_DEPLOYING

STATE_FAILED

STATE_RUNNING

STATE_UNKNOWN

Commentaires

Ressources supplémentaires