LocalWebservice Classe
Représente un modèle Machine Learning déployé en tant que point de terminaison de service web local.
Le déploiement de services web localement est utile pour le débogage et les scénarios de test.
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.
Constructeur
LocalWebservice(*args, **kwargs)
Paramètres
| Nom | Description |
|---|---|
|
workspace
Obligatoire
|
Objet d’espace de travail contenant tous les objets Model qui seront récupérés. |
|
name
Obligatoire
|
Nom de l’objet Webservice à récupérer. |
|
must_exist
Obligatoire
|
Indique si le service web doit déjà exister lors de la création de l’objet en mémoire. |
|
workspace
Obligatoire
|
Objet d’espace de travail contenant tous les objets Model qui seront récupérés. |
|
name
Obligatoire
|
Nom de l’objet LocalWebservice à récupérer. |
|
must_exist
Obligatoire
|
Indique si le service web doit déjà exister lors 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 bloc-notes.
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()
Méthodes
| delete |
Supprimez ce localWebservice de l’ordinateur local. Cet appel de fonction n’est pas asynchrone ; elle s’exécute jusqu’à ce que le service soit supprimé. |
| deploy_configuration |
Créez un objet de configuration pour le déploiement d’un service Web local. |
| deploy_to_cloud |
Déployez un service Web en fonction de la configuration de LocalWebservice. |
| deserialize |
Convertissez un objet JSON de réponse du service de gestion des modèles en objet Webservice. Remarque Non pris en charge pour LocalWebservice. |
| get_keys |
Récupérez les clés d’authentification pour ce service Web. Remarque Non pris en charge pour LocalWebservice. |
| get_logs |
Récupérez les journaux d’activité de ce service LocalWebservice. |
| get_token |
Récupérez le jeton d’authentification pour ce service Web, limité à l’utilisateur actuel. Remarque Non pris en charge pour LocalWebservice. |
| list |
Répertoriez les localWebservices associés à l’espace de travail correspondant. Les résultats retournés peuvent être filtrés à l’aide de paramètres. |
| regen_key |
Régénérer l’une des clés du service Web. Remarque Non pris en charge pour LocalWebservice. |
| reload |
Rechargez le script d’exécution et les dépendances du service LocalWebservice. Cela redémarre le conteneur du service avec des copies des ressources mises à jour, y compris le script d’exécution et les dépendances locales, mais elle ne régénère pas l’image sous-jacente. En conséquence, les modifications apportées aux dépendances Conda/pip ou aux étapes Docker personnalisées ne sont pas reflétées dans le service LocalWebservice rechargé. Pour gérer ces modifications, appelez la méthode à la update place. |
| run |
Appelez ce LocalWebservice avec l’entrée fournie. |
| serialize |
Convertissez cet objet Webservice en dictionnaire sérialisé JSON. |
| update |
Mettez à jour localWebservice avec les propriétés fournies. Les valeurs laissées comme None restent inchangées dans ce LocalWebservice. |
| update_deployment_state |
Actualisez l’état actuel de l’objet en mémoire. Effectuez 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 |
Interrogez le déploiement LocalWebservice en cours d’exécution. |
delete
Supprimez ce localWebservice de l’ordinateur local.
Cet appel de fonction n’est pas asynchrone ; elle 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
|
Indique s’il faut supprimer les fichiers temporaires mis en cache pour le service. (Valeur par défaut : True) |
|
delete_image
Obligatoire
|
Indique s’il faut supprimer l’image Docker du service. (Par défaut : False) |
|
delete_volume
Obligatoire
|
Indique s’il faut supprimer le volume Docker du service. (Valeur par défaut : True) |
Exceptions
| Type | Description |
|---|---|
deploy_configuration
Créez un objet de configuration pour le déploiement d’un service Web local.
static deploy_configuration(port=None)
Paramètres
| Nom | Description |
|---|---|
|
port
|
Port local sur lequel exposer le point de terminaison HTTP du service. Valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
|
Objet de configuration à utiliser lors du déploiement d’un objet Webservice. |
Exceptions
| Type | Description |
|---|---|
deploy_to_cloud
Déployez un service Web en fonction de la configuration de LocalWebservice.
deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)
Paramètres
| Nom | Description |
|---|---|
|
name
|
Nom à attribuer au service déployé. Doit être unique à l’espace de travail. Valeur par défaut: None
|
|
deployment_config
|
WebserviceDeploymentConfiguration utilisé pour configurer le service web. Si aucun objet de configuration n’est fourni, un objet de configuration vide est utilisé en fonction de la cible souhaitée. Valeur par défaut: None
|
|
deployment_target
|
À ComputeTarget laquelle déployer le service Web. Comme ACI n’a pas d’associé ComputeTarget, laissez ce paramètre comme Aucun à déployer sur ACI. Valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
|
Objet Webservice correspondant au service web déployé. |
Exceptions
| Type | Description |
|---|---|
deserialize
Convertissez un objet JSON de réponse du service de gestion des modèles en objet Webservice.
Remarque
Non pris en charge pour LocalWebservice.
deserialize(workspace, webservice_payload)
Paramètres
| Nom | Description |
|---|---|
|
cls
Obligatoire
|
|
|
workspace
Obligatoire
|
Objet d’espace de travail sous lequel le service Web est inscrit. |
|
webservice_payload
Obligatoire
|
Objet JSON à convertir en objet Webservice. |
Exceptions
| Type | Description |
|---|---|
|
azureml.exceptions.NotImplementedError
|
get_keys
Récupérez les clés d’authentification pour ce service Web.
Remarque
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érez les journaux d’activité de ce service LocalWebservice.
get_logs(num_lines=5000, raw=False)
Paramètres
| Nom | Description |
|---|---|
|
num_lines
Obligatoire
|
Nombre maximal de lignes de journal à récupérer. (Par défaut : 5000) |
|
raw
Obligatoire
|
Retournez la sortie brute du conteneur Docker sans tenter de la mettre en forme. (Par défaut : False) |
Retours
| Type | Description |
|---|---|
|
Journaux d’activité de ce localWebservice. |
Exceptions
| Type | Description |
|---|---|
get_token
Récupérez le jeton d’authentification pour ce service Web, limité à l’utilisateur actuel.
Remarque
Non pris en charge pour LocalWebservice.
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
|
list
Répertoriez les localWebservices 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
|
Objet Workspace associé aux services LocalWebservices. |
|
model_name
|
Filtrez la liste pour inclure uniquement les services LocalWebservices déployés avec le nom de modèle spécifique. Valeur par défaut: None
|
|
model_id
|
Liste de filtres pour inclure uniquement les services LocalWebservices déployés avec l’ID de modèle spécifique. Valeur par défaut: None
|
|
all
|
Afficher tous les services. Seuls les services en cours d’exécution sont affichés par défaut. Valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
|
Liste filtrée de LocalWebservices associés à l’espace de travail fourni. |
Exceptions
| Type | Description |
|---|---|
regen_key
Régénérer l’une des clés du service Web.
Remarque
Non pris en charge pour LocalWebservice.
regen_key(key)
Paramètres
| Nom | Description |
|---|---|
|
key
Obligatoire
|
Clé à régénérer. Les options sont « Primaire » ou « Secondaire » |
Exceptions
| Type | Description |
|---|---|
reload
Rechargez le script d’exécution et les dépendances du service LocalWebservice.
Cela redémarre le conteneur du service avec des copies des ressources mises à jour, y compris le script d’exécution et les dépendances locales, mais elle ne régénère pas l’image sous-jacente. En conséquence, les modifications apportées aux dépendances Conda/pip ou aux étapes Docker personnalisées ne sont pas reflétées dans le service LocalWebservice rechargé. Pour gérer ces modifications, appelez la méthode à la update place.
reload(wait=False)
Paramètres
| Nom | Description |
|---|---|
|
wait
Obligatoire
|
Attendez que le conteneur du service atteigne un état sain. (Par défaut : False) |
Exceptions
| Type | Description |
|---|---|
run
Appelez ce LocalWebservice avec l’entrée fournie.
run(input_data)
Paramètres
| Nom | Description |
|---|---|
|
input_data
Obligatoire
|
<xref:varies>
Entrée avec laquelle appeler localWebservice. |
Retours
| Type | Description |
|---|---|
|
<xref:varies>
|
Résultat de l’appel de LocalWebservice. |
Exceptions
| Type | Description |
|---|---|
serialize
Convertissez cet objet Webservice en dictionnaire sérialisé JSON.
serialize()
Retours
| Type | Description |
|---|---|
|
Représentation sérialisée de l’objet Webservice. |
update
Mettez à jour localWebservice avec les propriétés fournies.
Les valeurs laissées comme None restent inchangées dans ce LocalWebservice.
update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)
Paramètres
| Nom | Description |
|---|---|
|
models
Obligatoire
|
Nouvelle liste de modèles contenus dans LocalWebservice. |
|
image_config
Obligatoire
|
Options de configuration d’image à appliquer au service LocalWebservice. |
|
deployment_config
Obligatoire
|
Options de configuration de déploiement à appliquer au service LocalWebservice. |
|
inference_config
Obligatoire
|
Objet InferenceConfig utilisé pour fournir les propriétés de déploiement de modèle requises. |
|
wait
Obligatoire
|
Attendez que le conteneur du service atteigne un état sain. (Par défaut : False) |
Retours
| Type | Description |
|---|---|
Exceptions
| Type | Description |
|---|---|
update_deployment_state
Actualisez l’état actuel de l’objet en mémoire.
Effectuez 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
|
Indique si le service web doit déjà exister lors de la création de l’objet en mémoire. Valeur par défaut: False
|
wait_for_deployment
Interrogez le déploiement LocalWebservice en cours d’exécution.
wait_for_deployment(show_output=False)
Paramètres
| Nom | Description |
|---|---|
|
show_output
Obligatoire
|
Option permettant d’imprimer une sortie plus détaillée. (Par défaut : False) |
Exceptions
| Type | Description |
|---|---|
Attributs
port
scoring_uri
swagger_uri
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'