Webservice Klas
Definieert basisfunctionaliteit voor het implementeren van modellen als webservice-eindpunten in Azure Machine Learning.
Webserviceconstructor wordt gebruikt om een cloudweergave op te halen van een webserviceobject dat is gekoppeld aan de opgegeven werkruimte. Retourneert een exemplaar van een onderliggende klasse die overeenkomt met het specifieke type van het opgehaalde webserviceobject. Met de webserviceklasse kunt u machine learning-modellen implementeren vanuit een Model of Image een object.
Zie Modellen implementeren met Azure Machine Learning voor meer informatie over het werken met webservice.
Initialiseer het webservice-exemplaar.
De webserviceconstructor haalt een cloudweergave op van een webserviceobject dat is gekoppeld aan de opgegeven werkruimte. Er wordt een exemplaar van een onderliggende klasse geretourneerd dat overeenkomt met het specifieke type van het opgehaalde webserviceobject.
Constructor
Webservice(workspace, name)Parameters
| Name | Description |
|---|---|
|
workspace
Vereist
|
Het werkruimteobject met het webserviceobject dat moet worden opgehaald. |
|
name
Vereist
|
De naam van het webserviceobject dat moet worden opgehaald. |
|
workspace
Vereist
|
Het werkruimteobject met het webserviceobject dat moet worden opgehaald. |
|
name
Vereist
|
De naam van het webserviceobject dat moet worden opgehaald. |
Opmerkingen
In het volgende voorbeeld ziet u het aanbevolen implementatiepatroon waarin u eerst een configuratieobject maakt met de methode van de deploy_configuration onderliggende klasse webservice (in dit geval AksWebservice) en vervolgens de configuratie gebruikt met de deploy methode van de Model klasse.
# Set the web service configuration (using default here)
aks_config = AksWebservice.deploy_configuration()
# # Enable token auth and disable (key) auth on the webservice
# aks_config = AksWebservice.deploy_configuration(token_auth_enabled=True, auth_enabled=False)
In het volgende voorbeeld ziet u hoe u een bestaande AciWebservice in een werkruimte kunt vinden en deze kunt verwijderen als deze bestaat, zodat de naam opnieuw kan worden gebruikt.
from azureml.core.model import InferenceConfig
from azureml.core.webservice import AciWebservice
service_name = 'my-custom-env-service'
inference_config = InferenceConfig(entry_script='score.py', environment=environment)
aci_config = AciWebservice.deploy_configuration(cpu_cores=1, memory_gb=1)
service = Model.deploy(workspace=ws,
name=service_name,
models=[model],
inference_config=inference_config,
deployment_config=aci_config,
overwrite=True)
service.wait_for_deployment(show_output=True)
Er zijn een aantal manieren om een model als webservice te implementeren, waaronder:
deploymethode van de Model voor modellen die al zijn geregistreerd in de werkruimte.deploy_from_imagemethode voor Webservice installatiekopieën die al zijn gemaakt op basis van een model.deploy_from_modelmethode voor Webservice modellen die al zijn geregistreerd in de werkruimte. Met deze methode maakt u een installatiekopieën.deploymethode van de Webservice, waarmee een model wordt geregistreerd en een installatiekopieën wordt gemaakt.
Zie voor meer informatie over het werken met webservices
De sectie Variabelen bevat kenmerken van een lokale weergave van het cloudwebserviceobject. Deze variabelen moeten als alleen-lezen worden beschouwd. Het wijzigen van de waarden wordt niet weergegeven in het bijbehorende cloudobject.
Variabelen
| Name | Description |
|---|---|
|
auth_enabled
|
Of de webservice al dan niet verificatie heeft ingeschakeld. |
|
compute_type
|
Op welk type berekening de webservice wordt geïmplementeerd. |
|
created_time
|
Toen de webservice werd gemaakt. |
|
azureml.core.Webservice.description
|
Een beschrijving van het webserviceobject. |
|
azureml.core.Webservice.tags
|
Een woordenlijst met tags voor het webserviceobject. |
|
azureml.core.Webservice.name
|
De naam van de webservice. |
|
azureml.core.Webservice.properties
|
Woordenlijst met sleutelwaarde-eigenschappen voor de webservice. Deze eigenschappen kunnen niet worden gewijzigd na de implementatie, maar nieuwe sleutelwaardeparen kunnen worden toegevoegd. |
|
created_by
|
De gebruiker die de webservice heeft gemaakt. |
|
error
|
Als de webservice niet kan worden geïmplementeerd, bevat dit het foutbericht waarom deze is mislukt. |
|
azureml.core.Webservice.state
|
De huidige status van de webservice. |
|
updated_time
|
De laatste keer dat de webservice is bijgewerkt. |
|
azureml.core.Webservice.workspace
|
De Azure Machine Learning-werkruimte die deze webservice bevat. |
|
token_auth_enabled
|
Of de webservice tokenverificatie al dan niet heeft ingeschakeld. |
Methoden
| check_for_existing_webservice |
Controleer of de webservice bestaat. |
| delete |
Verwijder deze webservice uit de bijbehorende werkruimte. Deze functieaanroep is niet asynchroon. De aanroep wordt uitgevoerd totdat de resource wordt verwijderd. Er WebserviceException wordt een gegenereerd als er een probleem is met het verwijderen van het model uit de Model Management-service. |
| deploy |
Implementeer een webservice van nul of meer Model objecten. Met deze functie worden alle modellenbestanden geregistreerd die worden geleverd en wordt er een installatiekopieën gemaakt in het proces, allemaal gekoppeld aan de opgegeven Workspace. Gebruik deze functie wanneer u een map met modellen hebt om te implementeren die nog niet eerder zijn geregistreerd. De resulterende webservice is een realtime-eindpunt dat kan worden gebruikt voor deductieaanvragen. Zie Een model gebruiken dat is geïmplementeerd als een webservice voor meer informatie. |
| deploy_from_image |
Een webservice implementeren vanuit een Image object. Gebruik deze functie als u al een afbeeldingsobject hebt gemaakt voor een model. De resulterende webservice is een realtime-eindpunt dat kan worden gebruikt voor deductieaanvragen. Zie Een model gebruiken dat is geïmplementeerd als een webservice voor meer informatie. |
| deploy_from_model |
Implementeer een webservice van nul of meer Model objecten. Deze functie is vergelijkbaar met deploy, maar registreert de modellen niet. Gebruik deze functie als u modelobjecten hebt die al zijn geregistreerd. Hiermee maakt u een installatiekopieën in het proces, gekoppeld aan de opgegeven werkruimte. De resulterende webservice is een realtime-eindpunt dat kan worden gebruikt voor deductieaanvragen. Zie Een model gebruiken dat is geïmplementeerd als een webservice voor meer informatie. |
| deploy_local_from_model |
Bouw en implementeer een LocalWebservice voor testdoeleinden. Vereist dat Docker is geïnstalleerd en geconfigureerd. |
| deserialize |
Converteer een JSON-antwoordobject van de Model Management Service naar een webserviceobject. Mislukt als de opgegeven werkruimte niet de werkruimte is waaronder de webservice is geregistreerd. |
| get_keys |
Verificatiesleutels voor deze webservice ophalen. |
| get_logs |
Haal logboeken op voor deze webservice. |
| get_token |
Haal het verificatietoken voor deze webservice op, met het bereik van de huidige gebruiker. |
| list |
Vermeld de webservices die zijn gekoppeld aan de bijbehorende Workspace. De geretourneerde resultaten kunnen worden gefilterd met behulp van parameters. |
| regen_key |
Genereer een van de sleutels van de webservice opnieuw, ofwel de primaire of secundaire sleutel. Een WebserviceException wordt gegenereerd als |
| run |
Roep deze webservice aan met de opgegeven invoer. Abstracte methode geïmplementeerd door onderliggende klassen van Webservice. |
| serialize |
Converteer dit webserviceobject naar een geserialiseerde JSON-woordenlijst. Hiermee deserialize kunt u terug converteren naar een webserviceobject. |
| update |
Werk de webserviceparameters bij. Dit is een abstracte methode die wordt geïmplementeerd door onderliggende klassen van Webservice. Mogelijke parameters voor het bijwerken variëren op basis van het onderliggende type webservice. Zie bijvoorbeeld voor azure Container Instances-webservices update voor specifieke parameters. |
| 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 het bijbehorende cloudobject. Voornamelijk handig voor handmatige polling van de aanmaakstatus. |
| wait_for_deployment |
Peil automatisch naar de actieve webservice-implementatie. Wacht totdat de webservice een terminalstatus heeft bereikt. Genereert een WebserviceException als deze een niet-geslaagde terminalstatus bereikt of de opgegeven time-out overschrijdt. |
check_for_existing_webservice
Controleer of de webservice bestaat.
static check_for_existing_webservice(workspace, name, overwrite=False, request_func=None, check_func=None)Parameters
| Name | Description |
|---|---|
|
workspace
Vereist
|
|
|
name
Vereist
|
|
|
overwrite
|
Default value: False
|
|
request_func
|
<xref:function>
om de service aan te vragen om te controleren of de servicenaam bestaat Default value: None
|
|
check_func
|
<xref:function>
functie om de antwoordinhoud van request_func te controleren Default value: None
|
Uitzonderingen
| Type | Description |
|---|---|
delete
Verwijder deze webservice uit de bijbehorende werkruimte.
Deze functieaanroep is niet asynchroon. De aanroep wordt uitgevoerd totdat de resource wordt verwijderd. Er WebserviceException wordt een gegenereerd als er een probleem is met het verwijderen van het model uit de Model Management-service.
delete()Uitzonderingen
| Type | Description |
|---|---|
deploy
Implementeer een webservice van nul of meer Model objecten.
Met deze functie worden alle modellenbestanden geregistreerd die worden geleverd en wordt er een installatiekopieën gemaakt in het proces, allemaal gekoppeld aan de opgegeven Workspace. Gebruik deze functie wanneer u een map met modellen hebt om te implementeren die nog niet eerder zijn geregistreerd.
De resulterende webservice is een realtime-eindpunt dat kan worden gebruikt voor deductieaanvragen. Zie Een model gebruiken dat is geïmplementeerd als een webservice voor meer informatie.
static deploy(workspace, name, model_paths, image_config, deployment_config=None, deployment_target=None, overwrite=False)Parameters
| Name | Description |
|---|---|
|
workspace
Vereist
|
Een werkruimteobject waaraan de webservice moet worden gekoppeld. |
|
name
Vereist
|
De naam die de geïmplementeerde service moet geven. Moet uniek zijn voor de werkruimte, alleen bestaan uit kleine letters, cijfers of streepjes, beginnen met een letter en tussen de 3 en 32 tekens lang zijn. |
|
model_paths
Vereist
|
Een lijst met paden op schijf om bestanden of mappen te modelleren. Kan een lege lijst zijn. |
|
image_config
Vereist
|
Een ImageConfig-object dat wordt gebruikt om de vereiste eigenschappen van de installatiekopieën te bepalen. |
|
deployment_config
|
Een WebserviceDeploymentConfiguration die wordt gebruikt om de webservice te configureren. Als er geen configuratieobject wordt opgegeven, wordt er een leeg configuratieobject gebruikt op basis van het gewenste doel. Default value: None
|
|
deployment_target
|
Een ComputeTarget voor het implementeren van de webservice. Aangezien Azure Container Instances geen gekoppelde ComputeTargetparameter heeft, laat u deze parameter staan als Geen om te implementeren in Azure Container Instances. Default value: None
|
|
overwrite
|
Overschrijf de bestaande service als de service met de naam al bestaat. Default value: False
|
Retouren
| Type | Description |
|---|---|
|
Een webserviceobject dat overeenkomt met de geïmplementeerde webservice. |
Uitzonderingen
| Type | Description |
|---|---|
deploy_from_image
Een webservice implementeren vanuit een Image object.
Gebruik deze functie als u al een afbeeldingsobject hebt gemaakt voor een model.
De resulterende webservice is een realtime-eindpunt dat kan worden gebruikt voor deductieaanvragen. Zie Een model gebruiken dat is geïmplementeerd als een webservice voor meer informatie.
static deploy_from_image(workspace, name, image, deployment_config=None, deployment_target=None, overwrite=False)Parameters
| Name | Description |
|---|---|
|
workspace
Vereist
|
Een werkruimteobject waaraan de webservice moet worden gekoppeld. |
|
name
Vereist
|
De naam die de geïmplementeerde service moet geven. Moet uniek zijn voor de werkruimte, alleen bestaan uit kleine letters, cijfers of streepjes, beginnen met een letter en tussen de 3 en 32 tekens lang zijn. |
|
image
Vereist
|
Een Image object dat moet worden geïmplementeerd. |
|
deployment_config
|
Een WebserviceDeploymentConfiguration die wordt gebruikt om de webservice te configureren. Als er geen configuratieobject wordt opgegeven, wordt er een leeg configuratieobject gebruikt op basis van het gewenste doel. Default value: None
|
|
deployment_target
|
Een ComputeTarget voor het implementeren van de webservice. Aangezien Azure Container Instances geen gekoppelde ComputeTargetparameter heeft, laat u deze parameter staan als Geen om te implementeren in Azure Container Instances. Default value: None
|
|
overwrite
|
Overschrijf de bestaande service als de service met de naam al bestaat. Default value: False
|
Retouren
| Type | Description |
|---|---|
|
Een webserviceobject dat overeenkomt met de geïmplementeerde webservice. |
Uitzonderingen
| Type | Description |
|---|---|
deploy_from_model
Implementeer een webservice van nul of meer Model objecten.
Deze functie is vergelijkbaar met deploy, maar registreert de modellen niet. Gebruik deze functie als u modelobjecten hebt die al zijn geregistreerd. Hiermee maakt u een installatiekopieën in het proces, gekoppeld aan de opgegeven werkruimte.
De resulterende webservice is een realtime-eindpunt dat kan worden gebruikt voor deductieaanvragen. Zie Een model gebruiken dat is geïmplementeerd als een webservice voor meer informatie.
static deploy_from_model(workspace, name, models, image_config, deployment_config=None, deployment_target=None, overwrite=False)Parameters
| Name | Description |
|---|---|
|
workspace
Vereist
|
Een werkruimteobject waaraan de webservice moet worden gekoppeld. |
|
name
Vereist
|
De naam die de geïmplementeerde service moet geven. Moet uniek zijn voor de werkruimte, alleen bestaan uit kleine letters, cijfers of streepjes, beginnen met een letter en tussen de 3 en 32 tekens lang zijn. |
|
models
Vereist
|
Een lijst met modelobjecten. Kan een lege lijst zijn. |
|
image_config
Vereist
|
Een ImageConfig-object dat wordt gebruikt om de vereiste eigenschappen van de installatiekopieën te bepalen. |
|
deployment_config
|
Een WebserviceDeploymentConfiguration die wordt gebruikt om de webservice te configureren. Als er geen configuratieobject wordt opgegeven, wordt er een leeg configuratieobject gebruikt op basis van het gewenste doel. Default value: None
|
|
deployment_target
|
Een ComputeTarget voor het implementeren van de webservice. Als ACI geen gekoppelde ComputeTargetparameter heeft, laat u deze parameter staan als Geen om te implementeren in ACI. Default value: None
|
|
overwrite
|
Overschrijf de bestaande service als de service met de naam al bestaat. Default value: False
|
Retouren
| Type | Description |
|---|---|
|
Een webserviceobject dat overeenkomt met de geïmplementeerde webservice. |
Uitzonderingen
| Type | Description |
|---|---|
deploy_local_from_model
Bouw en implementeer een LocalWebservice voor testdoeleinden.
Vereist dat Docker is geïnstalleerd en geconfigureerd.
static deploy_local_from_model(workspace, name, models, image_config, deployment_config=None, wait=False)Parameters
| Name | Description |
|---|---|
|
workspace
Vereist
|
Een werkruimteobject waarmee de webservice moet worden gekoppeld. |
|
name
Vereist
|
De naam die de geïmplementeerde service moet geven. Moet uniek zijn op de lokale computer. |
|
models
Vereist
|
Een lijst met modelobjecten. Kan een lege lijst zijn. |
|
image_config
Vereist
|
Een ImageConfig-object dat wordt gebruikt om de vereiste eigenschappen van de service-installatiekopieën te bepalen. |
|
deployment_config
|
Een LocalWebserviceDeploymentConfiguration die wordt gebruikt om de webservice te configureren. Als er geen configuratieobject wordt opgegeven, wordt er een leeg configuratieobject gebruikt. Default value: None
|
|
wait
|
Of moet worden gewacht totdat de Docker-container van de LocalWebservice in orde is. Genereert een uitzondering als de container vastloopt. De standaardwaarde is Onwaar. Default value: False
|
Retouren
| Type | Description |
|---|---|
Uitzonderingen
| Type | Description |
|---|---|
deserialize
Converteer een JSON-antwoordobject van de Model Management Service naar een webserviceobject.
Mislukt als de opgegeven werkruimte niet de werkruimte is waaronder de webservice is geregistreerd.
deserialize(workspace, webservice_payload)Parameters
| Name | Description |
|---|---|
|
cls
Vereist
|
Geeft aan dat dit een klassemethode is. |
|
workspace
Vereist
|
Het werkruimteobject waaronder de webservice is geregistreerd. |
|
webservice_payload
Vereist
|
Een JSON-object dat moet worden geconverteerd naar een webserviceobject. |
Retouren
| Type | Description |
|---|---|
|
De webserviceweergave van het opgegeven JSON-object. |
get_keys
Verificatiesleutels voor deze webservice ophalen.
get_keys()Retouren
| Type | Description |
|---|---|
|
De verificatiesleutels voor deze webservice. |
Uitzonderingen
| Type | Description |
|---|---|
get_logs
Haal logboeken op voor deze webservice.
get_logs(num_lines=5000, init=False)Parameters
| Name | Description |
|---|---|
|
num_lines
|
Het maximum aantal logboekregels dat moet worden opgehaald. Default value: 5000
|
|
init
|
Logboeken van init-container ophalen Default value: False
|
Retouren
| Type | Description |
|---|---|
|
De logboeken voor deze webservice. |
Uitzonderingen
| Type | Description |
|---|---|
get_token
Haal het verificatietoken voor deze webservice op, met het bereik van de huidige gebruiker.
get_token()Retouren
| Type | Description |
|---|---|
|
Het verificatietoken voor deze webservice en wanneer het moet worden vernieuwd. |
Uitzonderingen
| Type | Description |
|---|---|
list
Vermeld de webservices die zijn gekoppeld aan de bijbehorende Workspace.
De geretourneerde resultaten kunnen worden gefilterd met behulp van parameters.
static list(workspace, compute_type=None, image_name=None, image_id=None, model_name=None, model_id=None, tags=None, properties=None, image_digest=None)Parameters
| Name | Description |
|---|---|
|
workspace
Vereist
|
Het werkruimteobject waarin de webservices worden weergegeven. |
|
compute_type
|
Filter om alleen specifieke webservicetypen weer te geven. Opties zijn ACI, AKS. Default value: None
|
|
image_name
|
Filterlijst om alleen webservices op te nemen die zijn geïmplementeerd met de specifieke installatiekopienaam. Default value: None
|
|
image_id
|
Filterlijst om alleen webservices op te nemen die zijn geïmplementeerd met de specifieke installatiekopie-id. Default value: None
|
|
model_name
|
Filterlijst om alleen webservices op te nemen die zijn geïmplementeerd met de specifieke modelnaam. Default value: None
|
|
model_id
|
Filterlijst om alleen webservices op te nemen die zijn geïmplementeerd met de specifieke model-id. Default value: None
|
|
tags
|
Filter op basis van de opgegeven lijst op basis van 'sleutel' of '[sleutel, waarde]'. Bijvoorbeeld: ['key', ['key2', 'key2 value']] Default value: None
|
|
properties
|
Filter op basis van de opgegeven lijst op basis van 'sleutel' of '[sleutel, waarde]'. Bijvoorbeeld: ['key', ['key2', 'key2 value']] Default value: None
|
|
image_digest
|
Filterlijst om alleen webservices op te nemen die zijn geïmplementeerd met de specifieke samenvatting van de installatiekopie. Default value: None
|
Retouren
| Type | Description |
|---|---|
|
Een gefilterde lijst met webservices in de opgegeven werkruimte. |
Uitzonderingen
| Type | Description |
|---|---|
regen_key
Genereer een van de sleutels van de webservice opnieuw, ofwel de primaire of secundaire sleutel.
Een WebserviceException wordt gegenereerd als key deze niet is opgegeven of niet 'Primair' of 'Secundair'.
regen_key(key, set_key=None)Parameters
| Name | Description |
|---|---|
|
key
Vereist
|
De sleutel om opnieuw te genereren. Opties zijn Primair of Secundair. |
|
set_key
|
Een door de gebruiker opgegeven waarde die handmatige specificatie van de waarde van de sleutel toestaat Default value: None
|
Uitzonderingen
| Type | Description |
|---|---|
run
Roep deze webservice aan met de opgegeven invoer.
Abstracte methode geïmplementeerd door onderliggende klassen van Webservice.
abstract run(input)Parameters
| Name | Description |
|---|---|
|
input
Vereist
|
<xref:varies>
De invoergegevens waarmee de webservice moet worden aangeroepen. Dit zijn de gegevens die uw Machine Learning-model verwacht als invoer voor het uitvoeren van voorspellingen. |
Retouren
| Type | Description |
|---|---|
|
Het resultaat van het aanroepen van de webservice. Hiermee worden voorspellingen geretourneerd die worden uitgevoerd vanuit uw Machine Learning-model. |
Uitzonderingen
| Type | Description |
|---|---|
serialize
Converteer dit webserviceobject naar een geserialiseerde JSON-woordenlijst.
Hiermee deserialize kunt u terug converteren naar een webserviceobject.
serialize()Retouren
| Type | Description |
|---|---|
|
De JSON-weergave van deze webservice. |
update
Werk de webserviceparameters bij.
Dit is een abstracte methode die wordt geïmplementeerd door onderliggende klassen van Webservice. Mogelijke parameters voor het bijwerken variëren op basis van het onderliggende type webservice. Zie bijvoorbeeld voor azure Container Instances-webservices update voor specifieke parameters.
abstract update(*args)Parameters
| Name | Description |
|---|---|
|
args
Vereist
|
<xref:varies>
Waarden die moeten worden bijgewerkt. |
Uitzonderingen
| Type | Description |
|---|---|
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 het bijbehorende cloudobject. Voornamelijk handig voor handmatige polling van de aanmaakstatus.
update_deployment_state()wait_for_deployment
Peil automatisch naar de actieve webservice-implementatie.
Wacht totdat de webservice een terminalstatus heeft bereikt. Genereert een WebserviceException als deze een niet-geslaagde terminalstatus bereikt of de opgegeven time-out overschrijdt.
wait_for_deployment(show_output=False, timeout_sec=None)Parameters
| Name | Description |
|---|---|
|
show_output
|
Geeft aan of u uitgebreidere uitvoer wilt afdrukken. Default value: False
|
|
timeout_sec
|
Een uitzondering genereren als de implementatie de opgegeven time-out overschrijdt. Default value: None
|
Uitzonderingen
| Type | Description |
|---|---|