LocalWebservice Klass

  • Referens

Representerar en maskininlärningsmodell som distribuerats som en lokal webbtjänstslutpunkt.

Att distribuera webbtjänster lokalt är användbart för felsökning och testning.

Lokal webbtjänstkonstruktor.

LocalWebservice-konstruktorn används för att hämta en lokal representation av ett LocalWebservice-objekt som är associerat med den angivna arbetsytan.

Arv
Webservice
LocalWebservice

Konstruktor

LocalWebservice(*args, **kwargs)

Parametrar

Name Description
workspace
Obligatorisk
Workspace

Arbetsyteobjektet som innehåller alla modellobjekt som ska hämtas.
name
Obligatorisk
str

Namnet på webbtjänstobjektet som ska hämtas.
must_exist
Obligatorisk
bool

Om webbtjänsten redan måste finnas när du skapar det minnesinterna objektet.
workspace
Obligatorisk
Workspace

Arbetsyteobjektet som innehåller alla modellobjekt som ska hämtas.
name
Obligatorisk
str

Namnet på det LocalWebservice-objekt som ska hämtas.
must_exist
Obligatorisk
bool

Om webbtjänsten redan måste finnas när du skapar det minnesinterna objektet.

Kommentarer

Följande kodexempel visar hur du skapar en lokal Docker-webbtjänst. Mer information finns i notebook-länken.


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

Fullständigt exempel är tillgängligt från https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb

Metoder

delete

Ta bort den här LocalWebservice från den lokala datorn.

Det här funktionsanropet är inte asynkront. den körs tills tjänsten tas bort.
deploy_configuration

Skapa ett konfigurationsobjekt för att distribuera en lokal webbtjänst.
deploy_to_cloud

Distribuera en webbtjänst baserat på LocalWebservices konfiguration.
deserialize

Konvertera ett JSON-objekt för modellhanteringstjänstens svar till ett webbtjänstobjekt.

Anteckning

Stöds inte för LocalWebservice.
get_keys

Hämta autentiseringsnycklar för den här webbtjänsten.

Anteckning

Stöds inte för LocalWebservice.
get_logs

Hämta loggar för den här LocalWebservice.
get_token

Hämta autentiseringstoken för den här webbtjänsten, begränsad till den aktuella användaren.

Anteckning

Stöds inte för LocalWebservice.
list

Ange de LocalWebservices som är associerade med motsvarande arbetsyta.

Resultaten som returneras kan filtreras med hjälp av parametrar.
regen_key

Återskapa en av webbtjänstens nycklar.

Anteckning

Stöds inte för LocalWebservice.
reload

Läsa in LocalWebservices körningsskript och beroenden igen.

Detta startar om tjänstens container med kopior av uppdaterade tillgångar, inklusive körningsskriptet och lokala beroenden, men den återskapar inte den underliggande avbildningen. Därför återspeglas inte ändringar i Conda/pip-beroenden eller anpassade Docker-steg i den omlästa LocalWebservice. Om du vill hantera dessa ändringar anropar du update metoden i stället.
run

Anropa den här LocalWebservice med angivna indata.
serialize

Konvertera det här webbtjänstobjektet till en JSON-serialiserad ordlista.
update

Uppdatera LocalWebservice med angivna egenskaper.

Värden kvar som Ingen förblir oförändrade i den här LocalWebservice.
update_deployment_state

Uppdatera det aktuella tillståndet för det minnesinterna objektet.

Utför en uppdatering på plats av egenskaperna för objektet baserat på aktuellt tillstånd för motsvarande lokala Docker-container.
wait_for_deployment

Avsök localwebservice-distributionen som körs.

delete

Ta bort den här LocalWebservice från den lokala datorn.

Det här funktionsanropet är inte asynkront. den körs tills tjänsten tas bort.

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

Parametrar

Name Description
delete_cache
Obligatorisk
bool

Om du vill ta bort temporära filer som cachelagrats för tjänsten. (Standard: Sant)
delete_image
Obligatorisk
bool

Om tjänstens Docker-avbildning ska tas bort. (Standard: Falskt)
delete_volume
Obligatorisk
bool

Om tjänstens Docker-volym ska tas bort. (Standard: Sant)

Undantag

Typ Description
WebserviceException

deploy_configuration

Skapa ett konfigurationsobjekt för att distribuera en lokal webbtjänst.

static deploy_configuration(port=None)

Parametrar

Name Description
port
int

Den lokala porten som tjänstens HTTP-slutpunkt ska exponeras på.

Standardvärde: None

Returer

Typ Description
LocalWebserviceDeploymentConfiguration

Ett konfigurationsobjekt som ska användas när ett webbtjänstobjekt distribueras.

Undantag

Typ Description
WebserviceException

deploy_to_cloud

Distribuera en webbtjänst baserat på LocalWebservices konfiguration.

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

Parametrar

Name Description
name
str

Namnet på den distribuerade tjänsten. Måste vara unikt för arbetsytan.

Standardvärde: None
deployment_config
WebserviceDeploymentConfiguration

En WebserviceDeploymentConfiguration som används för att konfigurera webbtjänsten. Om inget anges används ett tomt konfigurationsobjekt baserat på önskat mål.

Standardvärde: None
deployment_target
ComputeTarget

En ComputeTarget som webbtjänsten ska distribueras till. Eftersom ACI inte har någon associerad ComputeTargetlämnar du den här parametern som Ingen att distribuera till ACI.

Standardvärde: None

Returer

Typ Description
Webservice

Ett webbtjänstobjekt som motsvarar den distribuerade webbtjänsten.

Undantag

Typ Description
WebserviceException

deserialize

Konvertera ett JSON-objekt för modellhanteringstjänstens svar till ett webbtjänstobjekt.

Anteckning

Stöds inte för LocalWebservice.

deserialize(workspace, webservice_payload)

Parametrar

Name Description
cls
Obligatorisk
workspace
Obligatorisk
Workspace

Arbetsyteobjektet som webbtjänsten är registrerad under.
webservice_payload
Obligatorisk
dict

Ett JSON-objekt som ska konverteras till ett webbtjänstobjekt.

Undantag

Typ Description
azureml.exceptions.NotImplementedError

get_keys

Hämta autentiseringsnycklar för den här webbtjänsten.

Anteckning

Stöds inte för LocalWebservice.

get_keys()

Returer

Typ Description

Autentiseringsnycklarna för den här webbtjänsten.

Undantag

Typ Description
azureml.exceptions.NotImplementedError

get_logs

Hämta loggar för den här LocalWebservice.

get_logs(num_lines=5000, raw=False)

Parametrar

Name Description
num_lines
Obligatorisk
int

Det maximala antalet loggrader som ska hämtas. (Standard: 5000)
raw
Obligatorisk
bool

Returnera dockercontainerns råutdata utan att försöka formatera den. (Standard: Falskt)

Returer

Typ Description
str

Loggarna för den här LocalWebservice.

Undantag

Typ Description
WebserviceException

get_token

Hämta autentiseringstoken för den här webbtjänsten, begränsad till den aktuella användaren.

Anteckning

Stöds inte för LocalWebservice.

get_token()

Returer

Typ Description
str, datetime

Autentiseringstoken för den här webbtjänsten och när den ska uppdateras efter.

Undantag

Typ Description
azureml.exceptions.NotImplementedError

list

Ange de LocalWebservices som är associerade med motsvarande arbetsyta.

Resultaten som returneras kan filtreras med hjälp av parametrar.

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

Parametrar

Name Description
workspace
Obligatorisk
Workspace

Arbetsyteobjektet som är associerat med LocalWebservices.
model_name
str

Filterlista för att endast inkludera LocalWebservices som distribuerats med det specifika modellnamnet.

Standardvärde: None
model_id
str

Filterlista för att endast inkludera LocalWebservices som distribuerats med det specifika modell-ID:t.

Standardvärde: None
all
bool

Visa alla tjänster. Endast tjänster som körs visas som standard.

Standardvärde: None

Returer

Typ Description
list[LocalWebservice]

En filtrerad lista över LocalWebservices som är associerade med den angivna arbetsytan.

Undantag

Typ Description
WebserviceException

regen_key

Återskapa en av webbtjänstens nycklar.

Anteckning

Stöds inte för LocalWebservice.

regen_key(key)

Parametrar

Name Description
key
Obligatorisk
str

Vilken nyckel som ska återskapas. Alternativen är "Primär" eller "Sekundär"

Undantag

Typ Description
NotImplementedError

reload

Läsa in LocalWebservices körningsskript och beroenden igen.

Detta startar om tjänstens container med kopior av uppdaterade tillgångar, inklusive körningsskriptet och lokala beroenden, men den återskapar inte den underliggande avbildningen. Därför återspeglas inte ändringar i Conda/pip-beroenden eller anpassade Docker-steg i den omlästa LocalWebservice. Om du vill hantera dessa ändringar anropar du update metoden i stället.

reload(wait=False)

Parametrar

Name Description
wait
Obligatorisk
bool

Vänta tills tjänstens container når ett felfritt tillstånd. (Standard: Falskt)

Undantag

Typ Description
WebserviceException

run

Anropa den här LocalWebservice med angivna indata.

run(input_data)

Parametrar

Name Description
input_data
Obligatorisk
<xref:varies>

De indata som localwebservice ska anropas med.

Returer

Typ Description
<xref:varies>

Resultatet av att anropa LocalWebservice.

Undantag

Typ Description
WebserviceException

serialize

Konvertera det här webbtjänstobjektet till en JSON-serialiserad ordlista.

serialize()

Returer

Typ Description
dict

Serialiserad representation av webbtjänstobjektet.

Undantag

Typ Description
WebserviceException

update

Uppdatera LocalWebservice med angivna egenskaper.

Värden kvar som Ingen förblir oförändrade i den här LocalWebservice.

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

Parametrar

Name Description
models
Obligatorisk
list[Model]

En ny lista över modeller som finns i LocalWebservice.
image_config
Obligatorisk
ContainerImageConfig

Bildkonfigurationsalternativ som ska tillämpas på LocalWebservice.
deployment_config
Obligatorisk
LocalWebserviceDeploymentConfiguration

Distributionskonfigurationsalternativ som ska tillämpas på LocalWebservice.
inference_config
Obligatorisk
InferenceConfig

Ett InferenceConfig-objekt som används för att tillhandahålla de nödvändiga modelldistributionsegenskaperna.
wait
Obligatorisk
bool

Vänta tills tjänstens container har ett felfritt tillstånd. (Standard: Falskt)

Returer

Typ Description
None

Undantag

Typ Description
WebserviceException

update_deployment_state

Uppdatera det aktuella tillståndet för det minnesinterna objektet.

Utför en uppdatering på plats av egenskaperna för objektet baserat på aktuellt tillstånd för motsvarande lokala Docker-container.

update_deployment_state(must_exist=False)

Parametrar

Name Description
must_exist
bool

Om webbtjänsten redan måste finnas när du skapar det minnesinterna objektet.

Standardvärde: False

Undantag

Typ Description
WebserviceException

wait_for_deployment

Avsök localwebservice-distributionen som körs.

wait_for_deployment(show_output=False)

Parametrar

Name Description
show_output
Obligatorisk
bool

Alternativ för att skriva ut mer utförliga utdata. (Standard: Falskt)

Undantag

Typ Description
WebserviceException

Attribut

port

Hämta den lokala webbtjänstporten.

Returer

Typ Description
int

Portnummer.

scoring_uri

Hämta den lokala webbtjänstbedömnings-URI:n.

Returer

Typ Description
str

Bedömnings-URI.

swagger_uri

Hämta den lokala webbtjänstens Swagger-URI.

Returer

Typ Description
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'