Freigeben über

LocalWebservice Klasse

  • Referenz

Stellt ein Machine Learning-Modell dar, das als lokaler Webdienst-Endpunkt bereitgestellt wird.

Die lokale Bereitstellung von Webdiensten ist für Debug- und Testszenarios nützlich.

Lokaler Webdienstkonstruktor.

Der LocalWebservice-Konstruktor wird verwendet, um eine lokale Darstellung eines LocalWebservice-Objekts abzurufen, das dem bereitgestellten Arbeitsbereich zugeordnet ist.

Vererbung
Webservice
LocalWebservice

Konstruktor

LocalWebservice(*args, **kwargs)

Parameter

Name Beschreibung
workspace
Erforderlich
Workspace

Das Arbeitsbereichsobjekt, das alle Modellobjekte enthält, die abgerufen werden.
name
Erforderlich
str

Der Name des abzurufenden Webservice-Objekts.
must_exist
Erforderlich
bool

Gibt an, ob der Webdienst beim Erstellen des In-Memory-Objekts bereits vorhanden sein muss.
workspace
Erforderlich
Workspace

Das Arbeitsbereichsobjekt, das alle Modellobjekte enthält, die abgerufen werden.
name
Erforderlich
str

Der Name des abzurufenden LocalWebservice-Objekts.
must_exist
Erforderlich
bool

Gibt an, ob der Webdienst beim Erstellen des In-Memory-Objekts bereits vorhanden sein muss.

Hinweise

Die folgenden Codebeispiele zeigen, wie Sie einen lokalen Docker-Webdienst erstellen. Weitere Einzelheiten finden Sie unter dem Notebook-Link.


   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()

Das vollständige Beispiel finden Sie unter https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb.

Methoden

delete

Löscht diesen LocalWebservice vom lokalen Computer.

Dieser Funktionsaufruf ist nicht asynchron. Er wird ausgeführt, bis der Dienst gelöscht wird.
deploy_configuration

Erstellt ein Konfigurationsobjekt für die Bereitstellung eines lokalen Webdiensts.
deploy_to_cloud

Stellt einen Webdienst basierend auf der LocalWebservice-Konfiguration bereit.
deserialize

Konvertiert ein JSON-Objekt einer Modellverwaltungsdienstantwort in ein Webdienstobjekt.

Hinweis

Wird für LocalWebservice nicht unterstützt.
get_keys

Ruft die Authentifizierungsschlüssel für diesen Webdienst ab.

Hinweis

Wird für LocalWebservice nicht unterstützt.
get_logs

Ruft die Protokolle für diesen LocalWebservice ab.
get_token

Ruft das Authentifizierungstoken für diesen Webdienst ab, das auf den aktuellen Benutzer beschränkt ist.

Hinweis

Wird für LocalWebservice nicht unterstützt.
list

Listet die LocalWebservices auf, die dem entsprechenden Arbeitsbereich zugeordnet sind.

Die zurückgegebenen Ergebnisse können mithilfe von Parametern gefiltert werden.
regen_key

Generiert einen der Schlüssel des Webdiensts erneut.

Hinweis

Wird für LocalWebservice nicht unterstützt.
reload

Lädt das Ausführungsskript und die Abhängigkeiten des LocalWebservice erneut.

Dadurch wird der Container des Diensts mit Kopien aktualisierter Ressourcen neu gestartet, einschließlich des Ausführungsskripts und lokaler Abhängigkeiten. Das zugrunde liegende Image wird jedoch nicht neu erstellt. Entsprechend werden Änderungen an conda-/pip-Abhängigkeiten oder benutzerdefinierten Docker-Schritten nicht im neu geladenen LocalWebservice angewandt. Um diese Änderungen anzuwenden, rufen Sie stattdessen die update-Methode auf.
run

Ruft diesen LocalWebservice mit der bereitgestellten Eingabe auf.
serialize

Konvertiert dieses Webdienstobjekt in ein serialisiertes JSON-Wörterbuch.
update

Aktualisiert den LocalWebservice mit den bereitgestellten Eigenschaften.

Werte, für die None angegeben werden, bleiben in diesem LocalWebservice unverändert.
update_deployment_state

Aktualisiert den aktuellen Zustand des In-Memory-Objekts.

Führt ein direktes Updates der Eigenschaften des Objekts basierend auf dem aktuellen Zustand des entsprechenden lokalen Docker-Containers aus.
wait_for_deployment

Fragt die ausgeführte LocalWebservice-Bereitstellung ab.

delete

Löscht diesen LocalWebservice vom lokalen Computer.

Dieser Funktionsaufruf ist nicht asynchron. Er wird ausgeführt, bis der Dienst gelöscht wird.

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

Parameter

Name Beschreibung
delete_cache
Erforderlich
bool

Gibt an, ob die für den Dienst zwischengespeicherten temporären Dateien gelöscht werden. (Standard: TRUE)
delete_image
Erforderlich
bool

Gibt an, ob das Docker-Image des Diensts gelöscht wird. (Standard: FALSE)
delete_volume
Erforderlich
bool

Gibt an, ob das Docker-Volume des Diensts gelöscht wird. (Standard: TRUE)

Ausnahmen

Typ Beschreibung
WebserviceException

deploy_configuration

Erstellt ein Konfigurationsobjekt für die Bereitstellung eines lokalen Webdiensts.

static deploy_configuration(port=None)

Parameter

Name Beschreibung
port
int

Der lokale Port, auf dem der HTTP-Endpunkt des Diensts verfügbar gemacht werden soll.

Standardwert: None

Gibt zurück

Typ Beschreibung
LocalWebserviceDeploymentConfiguration

Ein Konfigurationsobjekt, das beim Bereitstellen eines Webdienstobjekts verwendet werden soll.

Ausnahmen

Typ Beschreibung
WebserviceException

deploy_to_cloud

Stellt einen Webdienst basierend auf der LocalWebservice-Konfiguration bereit.

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

Parameter

Name Beschreibung
name
str

Der Name, der dem bereitgestellten Dienst zugewiesen werden soll. Muss für den Arbeitsbereich eindeutig sein.

Standardwert: None
deployment_config
WebserviceDeploymentConfiguration

Eine WebserviceDeploymentConfiguration, die zum Konfigurieren des Webdiensts verwendet wird. Wenn keine Konfiguration angegeben wird, wird basierend auf dem gewünschten Ziel ein leeres Konfigurationsobjekt verwendet.

Standardwert: None
deployment_target
ComputeTarget

Ein ComputeTarget, an dem der Webdienst bereitgestellt werden soll. Da ACI nicht über ein zugeordnetes ComputeTarget verfügt, übernehmen Sie für diesen Parameter den Wert None, um ihn für die ACI bereitzustellen.

Standardwert: None

Gibt zurück

Typ Beschreibung
Webservice

Ein Webservice-Objekt, das dem bereitgestellten Webdienst entspricht.

Ausnahmen

Typ Beschreibung
WebserviceException

deserialize

Konvertiert ein JSON-Objekt einer Modellverwaltungsdienstantwort in ein Webdienstobjekt.

Hinweis

Wird für LocalWebservice nicht unterstützt.

deserialize(workspace, webservice_payload)

Parameter

Name Beschreibung
cls
Erforderlich
workspace
Erforderlich
Workspace

Das Arbeitsbereichsobjekt, unter dem der Webdienst registriert ist.
webservice_payload
Erforderlich
dict

Ein JSON-Objekt, das in ein Webdienstobjekt konvertiert werden soll.

Ausnahmen

Typ Beschreibung
azureml.exceptions.NotImplementedError

get_keys

Ruft die Authentifizierungsschlüssel für diesen Webdienst ab.

Hinweis

Wird für LocalWebservice nicht unterstützt.

get_keys()

Gibt zurück

Typ Beschreibung

Die Authentifizierungsschlüssel für diesen Webdienst.

Ausnahmen

Typ Beschreibung
azureml.exceptions.NotImplementedError

get_logs

Ruft die Protokolle für diesen LocalWebservice ab.

get_logs(num_lines=5000, raw=False)

Parameter

Name Beschreibung
num_lines
Erforderlich
int

Die maximale Anzahl der abzurufenden Protokollzeilen. (Standard: 5.000)
raw
Erforderlich
bool

Gibt die unformatierte Docker-Containerausgabe zurück, ohne zu versuchen, sie zu formatieren. (Standard: FALSE)

Gibt zurück

Typ Beschreibung
str

Die Protokolle für diesen LocalWebservice.

Ausnahmen

Typ Beschreibung
WebserviceException

get_token

Ruft das Authentifizierungstoken für diesen Webdienst ab, das auf den aktuellen Benutzer beschränkt ist.

Hinweis

Wird für LocalWebservice nicht unterstützt.

get_token()

Gibt zurück

Typ Beschreibung
str, datetime

Das Authentifizierungstoken für diesen Webdienst und nach welcher Zeit es aktualisiert werden soll.

Ausnahmen

Typ Beschreibung
azureml.exceptions.NotImplementedError

list

Listet die LocalWebservices auf, die dem entsprechenden Arbeitsbereich zugeordnet sind.

Die zurückgegebenen Ergebnisse können mithilfe von Parametern gefiltert werden.

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

Parameter

Name Beschreibung
workspace
Erforderlich
Workspace

Das Arbeitsberichtobjekt, das LocalWebservices zugeordnet ist.
model_name
str

Filtert die Liste so, dass sie nur LocalWebservices enthält, die mit dem spezifischen Modellnamen bereitgestellt wurden.

Standardwert: None
model_id
str

Filtert die Liste so, dass sie nur LocalWebservices enthält, die mit der spezifischen Modell-ID bereitgestellt wurden.

Standardwert: None
all
bool

Zeigt alle Dienste an. Standardmäßig werden nur ausgeführte Dienste angezeigt.

Standardwert: None

Gibt zurück

Typ Beschreibung
list[LocalWebservice]

Eine gefilterte Liste von LocalWebservices, die dem bereitgestellten Arbeitsbereich zugeordnet sind.

Ausnahmen

Typ Beschreibung
WebserviceException

regen_key

Generiert einen der Schlüssel des Webdiensts erneut.

Hinweis

Wird für LocalWebservice nicht unterstützt.

regen_key(key)

Parameter

Name Beschreibung
key
Erforderlich
str

Gibt an, welcher Schlüssel erneut generiert werden soll. Die Optionen lauten „Primary“ (Primär) oder „Secondary“ (Sekundär).

Ausnahmen

Typ Beschreibung
NotImplementedError

reload

Lädt das Ausführungsskript und die Abhängigkeiten des LocalWebservice erneut.

Dadurch wird der Container des Diensts mit Kopien aktualisierter Ressourcen neu gestartet, einschließlich des Ausführungsskripts und lokaler Abhängigkeiten. Das zugrunde liegende Image wird jedoch nicht neu erstellt. Entsprechend werden Änderungen an conda-/pip-Abhängigkeiten oder benutzerdefinierten Docker-Schritten nicht im neu geladenen LocalWebservice angewandt. Um diese Änderungen anzuwenden, rufen Sie stattdessen die update-Methode auf.

reload(wait=False)

Parameter

Name Beschreibung
wait
Erforderlich
bool

Wartet, bis der Container des Diensts einen fehlerfreien Zustand erreicht hat. (Standard: FALSE)

Ausnahmen

Typ Beschreibung
WebserviceException

run

Ruft diesen LocalWebservice mit der bereitgestellten Eingabe auf.

run(input_data)

Parameter

Name Beschreibung
input_data
Erforderlich
<xref:varies>

Die Eingabe, mit der der LocalWebservice aufgerufen werden soll.

Gibt zurück

Typ Beschreibung
<xref:varies>

Das Ergebnis des Aufrufs des LocalWebservice.

Ausnahmen

Typ Beschreibung
WebserviceException

serialize

Konvertiert dieses Webdienstobjekt in ein serialisiertes JSON-Wörterbuch.

serialize()

Gibt zurück

Typ Beschreibung
dict

Serialisierte Darstellung des Webdienstobjekts.

Ausnahmen

Typ Beschreibung
WebserviceException

update

Aktualisiert den LocalWebservice mit den bereitgestellten Eigenschaften.

Werte, für die None angegeben werden, bleiben in diesem LocalWebservice unverändert.

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

Parameter

Name Beschreibung
models
Erforderlich
list[Model]

Eine neue Liste von Modellen, die im LocalWebservice enthalten sind.
image_config
Erforderlich
ContainerImageConfig

Imagekonfigurationsoptionen, die auf den LocalWebservice angewandt werden sollen.
deployment_config
Erforderlich
LocalWebserviceDeploymentConfiguration

Bereitstellungskonfigurationsoptionen, die auf den LocalWebservice angewandt werden sollen.
inference_config
Erforderlich
InferenceConfig

Ein InferenceConfig-Objekt, das zum Bereitstellen der erforderlichen Eigenschaften zur Modellimplementierung verwendet wird.
wait
Erforderlich
bool

Wartet, bis der Container des Diensts einen fehlerfreien Zustand erreicht hat. (Standard: FALSE)

Gibt zurück

Typ Beschreibung
None

Ausnahmen

Typ Beschreibung
WebserviceException

update_deployment_state

Aktualisiert den aktuellen Zustand des In-Memory-Objekts.

Führt ein direktes Updates der Eigenschaften des Objekts basierend auf dem aktuellen Zustand des entsprechenden lokalen Docker-Containers aus.

update_deployment_state(must_exist=False)

Parameter

Name Beschreibung
must_exist
bool

Gibt an, ob der Webdienst beim Erstellen des In-Memory-Objekts bereits vorhanden sein muss.

Standardwert: False

Ausnahmen

Typ Beschreibung
WebserviceException

wait_for_deployment

Fragt die ausgeführte LocalWebservice-Bereitstellung ab.

wait_for_deployment(show_output=False)

Parameter

Name Beschreibung
show_output
Erforderlich
bool

Option für eine ausführlichere Ausgabe. (Standard: FALSE)

Ausnahmen

Typ Beschreibung
WebserviceException

Attribute

port

Ruft den lokalen Webdienstport ab.

Gibt zurück

Typ Beschreibung
int

Portnummer

scoring_uri

Ruft den Bewertungs-URI des lokalen Webdiensts ab.

Gibt zurück

Typ Beschreibung
str

Bewertungs-URI.

swagger_uri

Ruft den Swagger-URI des lokalen Webdiensts ab.

Gibt zurück

Typ Beschreibung
str

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'