LocalWebservice Klas

Vertegenwoordigt een machine learning-model dat is geïmplementeerd als een lokaal webservice-eindpunt.

Het lokaal implementeren van webservices is handig voor foutopsporing en testscenario's.

Lokale webserviceconstructor.

LocalWebservice-constructor wordt gebruikt om een lokale weergave op te halen van een LocalWebservice-object dat is gekoppeld aan de opgegeven werkruimte.

Overname

Webservice

LocalWebservice

Constructor

LocalWebservice(*args, **kwargs)

Parameters

Name	Description
workspace Vereist	Workspace Het werkruimteobject met modelobjecten die worden opgehaald.
name Vereist	str De naam van het webserviceobject dat moet worden opgehaald.
must_exist Vereist	bool Of de webservice al moet bestaan bij het maken van het object in het geheugen.
workspace Vereist	Workspace Het werkruimteobject met modelobjecten die worden opgehaald.
name Vereist	str De naam van het LocalWebservice-object dat moet worden opgehaald.
must_exist Vereist	bool Of de webservice al moet bestaan bij het maken van het object in het geheugen.

Opmerkingen

In de volgende codevoorbeelden ziet u hoe u een lokale Docker-webservice maakt. Zie de koppeling naar het notitieblok voor meer informatie.

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

Het volledige voorbeeld is beschikbaar via https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb

Methoden

delete	Verwijder deze LocalWebservice van de lokale computer. Deze functie-aanroep is niet asynchroon; deze wordt uitgevoerd totdat de service is verwijderd.
deploy_configuration	Maak een configuratieobject voor het implementeren van een lokale webservice.
deploy_to_cloud	Implementeer een webservice op basis van de configuratie van de LocalWebservice.
deserialize	Converteer een JSON-object van een Model Management Service-antwoord naar een webserviceobject. Notitie Niet ondersteund voor LocalWebservice.
get_keys	Verificatiesleutels ophalen voor deze webservice. Notitie Niet ondersteund voor LocalWebservice.
get_logs	Logboeken ophalen voor deze LocalWebservice.
get_token	Verificatietoken ophalen voor deze webservice, met het bereik van de huidige gebruiker. Notitie Niet ondersteund voor LocalWebservice.
list	Vermeld de LocalWebservices die zijn gekoppeld aan de bijbehorende werkruimte. De geretourneerde resultaten kunnen worden gefilterd met behulp van parameters.
regen_key	Genereer een van de sleutels van de webservice opnieuw. Notitie Niet ondersteund voor LocalWebservice.
reload	Laad het uitvoeringsscript en de afhankelijkheden van de LocalWebservice opnieuw. Hiermee wordt de container van de service opnieuw gestart met kopieën van bijgewerkte assets, waaronder het uitvoeringsscript en lokale afhankelijkheden, maar wordt de onderliggende installatiekopieën niet opnieuw opgebouwd. Wijzigingen in Conda/pip-afhankelijkheden of aangepaste Docker-stappen worden daarom niet doorgevoerd in de opnieuw geladen LocalWebservice. Als u deze wijzigingen wilt afhandelen, roept u in plaats daarvan de update methode aan.
run	Roep deze LocalWebservice aan met de opgegeven invoer.
serialize	Converteer dit webserviceobject naar een JSON-geserialiseerde woordenlijst.
update	Werk de LocalWebservice bij met de opgegeven eigenschappen. Waarden die worden achtergelaten als Geen, blijven ongewijzigd in deze LocalWebservice.
update_deployment_state	Vernieuw de huidige status van het object in het geheugen. Voer een in-place update uit van de eigenschappen van het object op basis van de huidige status van de bijbehorende lokale Docker-container.
wait_for_deployment	Peil de actieve LocalWebservice-implementatie.

delete

Verwijder deze LocalWebservice van de lokale computer.

Deze functie-aanroep is niet asynchroon; deze wordt uitgevoerd totdat de service is verwijderd.

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

Parameters

Name	Description
delete_cache Vereist	bool Of tijdelijke bestanden die voor de service in de cache zijn opgeslagen, moeten worden verwijderd. (Standaard: Waar)
delete_image Vereist	bool Of de Docker-installatiekopieën van de service moeten worden verwijderd. (Standaard: Onwaar)
delete_volume Vereist	bool Of het Docker-volume van de service moet worden verwijderd. (Standaard: Waar)

Uitzonderingen

Type	Description
WebserviceException

deploy_configuration

Maak een configuratieobject voor het implementeren van een lokale webservice.

static deploy_configuration(port=None)

Parameters

Name	Description
port	int De lokale poort waarop het HTTP-eindpunt van de service beschikbaar wordt gemaakt. Default value: None

Retouren

Type	Description
LocalWebserviceDeploymentConfiguration	Een configuratieobject dat moet worden gebruikt bij het implementeren van een webserviceobject.

Uitzonderingen

Type	Description
WebserviceException

deploy_to_cloud

Implementeer een webservice op basis van de configuratie van de LocalWebservice.

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

Parameters

Name	Description
name	str De naam voor de geïmplementeerde service. Moet uniek zijn voor de werkruimte. Default value: None
deployment_config	WebserviceDeploymentConfiguration Een WebserviceDeploymentConfiguration die wordt gebruikt om de webservice te configureren. Als er geen wordt opgegeven, wordt een leeg configuratieobject gebruikt op basis van het gewenste doel. Default value: None
deployment_target	ComputeTarget Een ComputeTarget waarop de webservice moet worden geïmplementeerd. Aangezien ACI geen gekoppeld ComputeTargetheeft, laat u deze parameter op Geen staan om te implementeren in ACI. Default value: None

Retouren

Type	Description
Webservice	Een webserviceobject dat overeenkomt met de geïmplementeerde webservice.

Uitzonderingen

Type	Description
WebserviceException

deserialize

Converteer een JSON-object van een Model Management Service-antwoord naar een webserviceobject.

Notitie

Niet ondersteund voor LocalWebservice.

deserialize(workspace, webservice_payload)

Parameters

Name	Description
cls Vereist
workspace Vereist	Workspace Het werkruimteobject waaronder de webservice is geregistreerd.
webservice_payload Vereist	dict Een JSON-object dat moet worden geconverteerd naar een webserviceobject.

Uitzonderingen

Type	Description
azureml.exceptions.NotImplementedError

get_keys

Verificatiesleutels ophalen voor deze webservice.

Notitie

Niet ondersteund voor LocalWebservice.

get_keys()

Retouren

Type	Description
	De verificatiesleutels voor deze webservice.

Uitzonderingen

Type	Description
azureml.exceptions.NotImplementedError

get_logs

Logboeken ophalen voor deze LocalWebservice.

get_logs(num_lines=5000, raw=False)

Parameters

Name	Description
num_lines Vereist	int Het maximum aantal logboekregels dat moet worden opgehaald. (Standaard: 5000)
raw Vereist	bool Retourneer de uitvoer van de onbewerkte Docker-container zonder deze te formatteren. (Standaard: Onwaar)

Retouren

Type	Description
str	De logboeken voor deze LocalWebservice.

Uitzonderingen

Type	Description
WebserviceException

get_token

Verificatietoken ophalen voor deze webservice, met het bereik van de huidige gebruiker.

Notitie

Niet ondersteund voor LocalWebservice.

get_token()

Retouren

Type	Description
str, datetime	Het verificatietoken voor deze webservice en wanneer het daarna moet worden vernieuwd.

Uitzonderingen

Type	Description
azureml.exceptions.NotImplementedError

list

Vermeld de LocalWebservices die zijn gekoppeld aan de bijbehorende werkruimte.

De geretourneerde resultaten kunnen worden gefilterd met behulp van parameters.

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

Parameters

Name	Description
workspace Vereist	Workspace Het werkruimteobject dat is gekoppeld aan de LocalWebservices.
model_name	str Filter de lijst om alleen LocalWebservices op te nemen die zijn geïmplementeerd met de specifieke modelnaam. Default value: None
model_id	str Filter de lijst om alleen LocalWebservices op te nemen die zijn geïmplementeerd met de specifieke model-id. Default value: None
all	bool Alle services weergeven. Standaard worden alleen actieve services weergegeven. Default value: None

Retouren

Type	Description
list[LocalWebservice]	Een gefilterde lijst met LocalWebservices die zijn gekoppeld aan de opgegeven werkruimte.

Uitzonderingen

Type	Description
WebserviceException

regen_key

Genereer een van de sleutels van de webservice opnieuw.

Notitie

Niet ondersteund voor LocalWebservice.

regen_key(key)

Parameters

Name	Description
key Vereist	str Welke sleutel moet opnieuw worden gegenereerd. Opties zijn 'Primair' of 'Secundair'

Uitzonderingen

Type	Description
NotImplementedError

reload

Laad het uitvoeringsscript en de afhankelijkheden van de LocalWebservice opnieuw.

Hiermee wordt de container van de service opnieuw gestart met kopieën van bijgewerkte assets, waaronder het uitvoeringsscript en lokale afhankelijkheden, maar wordt de onderliggende installatiekopieën niet opnieuw opgebouwd. Wijzigingen in Conda/pip-afhankelijkheden of aangepaste Docker-stappen worden daarom niet doorgevoerd in de opnieuw geladen LocalWebservice. Als u deze wijzigingen wilt afhandelen, roept u in plaats daarvan de update methode aan.

reload(wait=False)

Parameters

Name	Description
wait Vereist	bool Wacht tot de container van de service een goede status heeft bereikt. (Standaard: Onwaar)

Uitzonderingen

Type	Description
WebserviceException

run

Roep deze LocalWebservice aan met de opgegeven invoer.

run(input_data)

Parameters

Name	Description
input_data Vereist	<xref:varies> De invoer waarmee de LocalWebservice moet worden aangeroepen.

Retouren

Type	Description
<xref:varies>	Het resultaat van het aanroepen van de LocalWebservice.

Uitzonderingen

Type	Description
WebserviceException

serialize

Converteer dit webserviceobject naar een JSON-geserialiseerde woordenlijst.

serialize()

Retouren

Type	Description
dict	Geserialiseerde weergave van het webserviceobject.

Uitzonderingen

Type	Description
WebserviceException

update

Werk de LocalWebservice bij met de opgegeven eigenschappen.

Waarden die worden achtergelaten als Geen, blijven ongewijzigd in deze LocalWebservice.

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

Parameters

Name	Description
models Vereist	list[Model] Een nieuwe lijst met modellen in de LocalWebservice.
image_config Vereist	ContainerImageConfig Configuratieopties voor installatiekopieën die moeten worden toegepast op de LocalWebservice.
deployment_config Vereist	LocalWebserviceDeploymentConfiguration Implementatieconfiguratieopties die moeten worden toegepast op de LocalWebservice.
inference_config Vereist	InferenceConfig Een InferenceConfig-object dat wordt gebruikt om de vereiste modelimplementatie-eigenschappen te bieden.
wait Vereist	bool Wacht tot de container van de service een goede status heeft bereikt. (Standaard: Onwaar)

Retouren

Type	Description
None

Uitzonderingen

Type	Description
WebserviceException

update_deployment_state

Vernieuw de huidige status van het object in het geheugen.

Voer een in-place update uit van de eigenschappen van het object op basis van de huidige status van de bijbehorende lokale Docker-container.

update_deployment_state(must_exist=False)

Parameters

Name	Description
must_exist	bool Of de webservice al moet bestaan bij het maken van het object in het geheugen. Default value: False

Uitzonderingen

Type	Description
WebserviceException

wait_for_deployment

Peil de actieve LocalWebservice-implementatie.

wait_for_deployment(show_output=False)

Parameters

Name	Description
show_output Vereist	bool Optie om uitgebreidere uitvoer af te drukken. (Standaard: Onwaar)

Uitzonderingen

Type	Description
WebserviceException

Kenmerken

port

Haal de lokale webservicepoort op.

Retouren

Type	Description
int	Poortnummer.

scoring_uri

Haal de score-URI van de lokale webservice op.

Retouren

Type	Description
str	Score-URI.

swagger_uri

Haal de Swagger-URI van de lokale webservice op.

Retouren

Type	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'