Webservice Osztály

Referencia

Meghatározza a modellek webszolgáltatás-végpontként való üzembe helyezésének alapfunkcióit az Azure Machine Learningben.

A webszolgáltatás-konstruktor a megadott munkaterülethez társított webszolgáltatási objektum felhőbeli ábrázolásának lekérésére szolgál. Egy gyermekosztály egy példányát adja vissza, amely megfelel a lekért webszolgáltatás-objektum adott típusának. A Webservice osztály lehetővé teszi gépi tanulási modellek üzembe helyezését egy Model vagy Image objektumból.

A webszolgáltatással kapcsolatos további információkért lásd: Modellek üzembe helyezése az Azure Machine Learning használatával.

Inicializálja a Webservice-példányt.

A Webszolgáltatás-konstruktor lekéri a megadott munkaterülethez társított webszolgáltatás-objektum felhőbeli ábrázolását. Egy gyermekosztály egy példányát adja vissza, amely megfelel a lekért webszolgáltatás-objektum adott típusának.

Öröklődés: ABC

Webservice

Konstruktor

Webservice(workspace, name)

Paraméterek

workspace: Workspace

Kötelező

A lekérni kívánt Webservice objektumot tartalmazó munkaterület-objektum.

name: str

Kötelező

A lekérni kívánt Webservice objektum neve.

workspace: Workspace

Kötelező

A lekérni kívánt Webservice objektumot tartalmazó munkaterület-objektum.

name: str

Kötelező

A lekérni kívánt Webservice objektum neve.

Megjegyzések

Az alábbi minta az ajánlott üzembehelyezési mintát mutatja be, ahol először létre kell hoznia egy konfigurációs objektumot a deploy_configuration Webservice gyermekosztályának metódusával (ebben az esetbenAksWebservice), majd a konfigurációt az Modeldeploy osztály metódusával kell használnia.


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

A teljes minta a következő forrásból érhető el: https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/production-deploy-to-aks/production-deploy-to-aks.ipynb

Az alábbi minta bemutatja, hogyan kereshet meg egy meglévőt AciWebservice egy munkaterületen, és törölheti, ha létezik, hogy a név újra felhasználható legyen.


   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)

A modellek webszolgáltatásként többféleképpen is üzembe helyezhetők, többek között az alábbiakkal:

deploy metódusát a Model munkaterületen már regisztrált modellek esetében.
deploy_from_image metódust Webservice a modellből már létrehozott képekhez.
deploy_from_model metódust Webservice a munkaterületen már regisztrált modellek esetében. Ez a metódus létrehoz egy lemezképet.
deploy metódusa Webservice, amely regisztrál egy modellt, és létrehoz egy rendszerképet.

A webszolgáltatások használatával kapcsolatos információkért lásd:

A Változók szakasz a felhőalapú webszolgáltatás-objektum helyi reprezentációjának attribútumait sorolja fel. Ezeket a változókat írásvédettnek kell tekinteni. Az értékek módosítása nem jelenik meg a megfelelő felhőobjektumban.

Változók

auth_enabled: bool

Azt jelzi, hogy a webszolgáltatás engedélyezve van-e.

compute_type: str

Milyen típusú számítási feladatokra van üzembe helyezve a webszolgáltatás.

created_time: datetime

A webszolgáltatás létrehozásakor.

azureml.core.Webservice.description

A Webservice objektum leírása.

azureml.core.Webservice.tags

A Webservice objektum címkéinek szótára.

azureml.core.Webservice.name

A webszolgáltatás neve.

azureml.core.Webservice.properties

A webszolgáltatás kulcsérték-tulajdonságainak szótára. Ezek a tulajdonságok az üzembe helyezés után nem módosíthatók, de új kulcsértékpárok is hozzáadhatók.

created_by: str

A webszolgáltatást létrehozó felhasználó.

error: str

Ha a webszolgáltatás üzembe helyezése nem sikerült, ez a hibaüzenetet fogja tartalmazni a sikertelenség okával kapcsolatban.

azureml.core.Webservice.state

A webszolgáltatás aktuális állapota.

updated_time: datetime

A webszolgáltatás legutóbbi frissítésének időpontja.

azureml.core.Webservice.workspace

A webszolgáltatást tartalmazó Azure Machine Learning-munkaterület.

token_auth_enabled: bool

Azt jelzi, hogy a webszolgáltatásban engedélyezve van-e a jogkivonat-hitelesítés.

Metódusok

check_for_existing_webservice	Ellenőrizze, hogy létezik-e webszolgáltatás.
delete	Törölje ezt a webszolgáltatást a társított munkaterületről. Ez a függvényhívás nem aszinkron. A hívás az erőforrás törléséig fut. A WebserviceException akkor merül fel, ha probléma merül fel a modell a Modellkezelési szolgáltatásból való törlésekor.
deploy	Webszolgáltatás üzembe helyezése nulla vagy több Model objektumból. Ez a függvény regisztrálja a megadott modellfájlokat, és létrehoz egy rendszerképet a folyamatban, amelyek mindegyike a megadotthoz Workspacevan társítva. Ezt a függvényt akkor használja, ha olyan modellek könyvtárával rendelkezik, amelyeket korábban még nem regisztráltak. Az eredményként kapott webszolgáltatás egy valós idejű végpont, amely következtetési kérelmekhez használható. További információ: Webszolgáltatásként üzembe helyezett modell felhasználása.
deploy_from_image	Webszolgáltatás üzembe helyezése objektumból Image . Akkor használja ezt a függvényt, ha már létrehozott egy Kép objektumot egy modellhez. Az eredményként kapott webszolgáltatás egy valós idejű végpont, amely következtetési kérelmekhez használható. További információ: Webszolgáltatásként üzembe helyezett modell felhasználása.
deploy_from_model	Webszolgáltatás üzembe helyezése nulla vagy több Model objektumból. Ez a függvény hasonló a függvényhez, deployde nem regisztrálja a modelleket. Ezt a függvényt akkor használja, ha már regisztrált modellobjektumokkal rendelkezik. Ezzel létrehoz egy rendszerképet a folyamatban, amely a megadott munkaterülethez van társítva. Az eredményként kapott webszolgáltatás egy valós idejű végpont, amely következtetési kérelmekhez használható. További információ: Webszolgáltatásként üzembe helyezett modell felhasználása.
deploy_local_from_model	Buildelés és üzembe helyezés LocalWebservice teszteléshez. A Docker telepítését és konfigurálását igényli.
deserialize	Modellkezelési szolgáltatás válasz JSON-objektumának átalakítása webszolgáltatás-objektummá. Sikertelen lesz, ha a megadott munkaterület nem az a munkaterület, amely alatt a webszolgáltatás regisztrálva van.
get_keys	Kérje le a webszolgáltatás hitelesítési kulcsait.
get_logs	A webszolgáltatás naplóinak lekérése.
get_token	Kérje le a webszolgáltatás hitelesítési jogkivonatát, amely az aktuális felhasználóra terjed ki.
list	Listázhatja a megfelelő Workspacewebszolgáltatáshoz társított webszolgáltatásokat. A visszaadott eredmények paraméterekkel szűrhetők.
regen_key	Hozza létre újra a webszolgáltatás egyik kulcsát, az "Elsődleges" vagy a "Másodlagos" kulcsot. Az A WebserviceException akkor jön létre, ha `key` nincs megadva, vagy nem "Elsődleges" vagy "Másodlagos".
run	Hívja meg ezt a webszolgáltatást a megadott bemenettel. A gyermekosztályai Webserviceáltal implementált absztrakt metódus.
serialize	Konvertálja ezt a webszolgáltatás-objektumot JSON szerializált szótárlá. A használatával deserialize visszaalakulhat webszolgáltatás-objektummá.
update	Frissítse a webszolgáltatás paramétereit. Ez egy absztrakt metódus, amelyet a gyermekosztályai implementálnak Webservice. A lehetséges frissítési paraméterek a webszolgáltatás gyermektípusától függően változhatnak. Például Azure Container Instances webszolgáltatások esetében tekintse meg update az adott paramétereket.
update_deployment_state	Frissítse a memóriában lévő objektum aktuális állapotát. Végezze el az objektum tulajdonságainak helyben történő frissítését a megfelelő felhőobjektum aktuális állapota alapján. Elsősorban a létrehozási állapot manuális lekérdezéséhez hasznos.
wait_for_deployment	Automatikus lekérdezés a futó webszolgáltatás-üzembe helyezésről. Várjon, amíg a webszolgáltatás eléri a terminálállapotot. Egy hibát ad, WebserviceException ha nem sikeres terminálállapotba kerül, vagy túllépi a megadott időtúllépést.

check_for_existing_webservice

Ellenőrizze, hogy létezik-e webszolgáltatás.

static check_for_existing_webservice(workspace, name, overwrite=False, request_func=None, check_func=None)

Paraméterek

workspace: Workspace

Kötelező

name: str

Kötelező

overwrite: bool

alapértelmezett érték: False

request_func: <xref:function>

alapértelmezett érték: None

függvény a szolgáltatás kéréséhez annak ellenőrzéséhez, hogy létezik-e szolgáltatásnév

check_func: <xref:function>

alapértelmezett érték: None

függvény a request_func választartalmának ellenőrzéséhez

Kivételek

WebserviceException

delete

Törölje ezt a webszolgáltatást a társított munkaterületről.

Ez a függvényhívás nem aszinkron. A hívás az erőforrás törléséig fut. A WebserviceException akkor merül fel, ha probléma merül fel a modell a Modellkezelési szolgáltatásból való törlésekor.

delete()

Kivételek

WebserviceException

deploy

Webszolgáltatás üzembe helyezése nulla vagy több Model objektumból.

Ez a függvény regisztrálja a megadott modellfájlokat, és létrehoz egy rendszerképet a folyamatban, amelyek mindegyike a megadotthoz Workspacevan társítva. Ezt a függvényt akkor használja, ha olyan modellek könyvtárával rendelkezik, amelyeket korábban még nem regisztráltak.

Az eredményként kapott webszolgáltatás egy valós idejű végpont, amely következtetési kérelmekhez használható. További információ: Webszolgáltatásként üzembe helyezett modell felhasználása.

static deploy(workspace, name, model_paths, image_config, deployment_config=None, deployment_target=None, overwrite=False)

Paraméterek

workspace: Workspace

Kötelező

Egy munkaterület-objektum, amellyel társítani szeretné a webszolgáltatást.

name: str

Kötelező

Az üzembe helyezett szolgáltatás nevét adja meg. A munkaterületnek egyedinek kell lennie, csak kisbetűkből, számokból vagy kötőjelekből kell állnia, betűvel kell kezdődnie, és 3–32 karakter hosszúságúnak kell lennie.

model_paths: list[str]

Kötelező

A modellfájlok vagy mappák lemezen lévő elérési útjainak listája. Lehet egy üres lista.

image_config: ImageConfig

Kötelező

A szükséges képtulajdonságok meghatározására használt ImageConfig objektum.

deployment_config: WebserviceDeploymentConfiguration

alapértelmezett érték: None

A webszolgáltatás konfigurálásához használt WebserviceDeploymentConfiguration. Ha nincs megadva, a rendszer egy üres konfigurációs objektumot használ a kívánt cél alapján.

deployment_target: ComputeTarget

alapértelmezett érték: None

A ComputeTarget a webszolgáltatás üzembe helyezéséhez. Mivel Azure Container Instances nincs társítvaComputeTarget, hagyja ezt a paramétert Nincs értéken a Azure Container Instances üzembe helyezéséhez.

overwrite: bool

alapértelmezett érték: False

Írja felül a meglévő szolgáltatást, ha a nevű szolgáltatás már létezik.

Válaszok

Az üzembe helyezett webszolgáltatásnak megfelelő webszolgáltatási objektum.

Visszatérési típus

Webservice

Kivételek

WebserviceException

deploy_from_image

Webszolgáltatás üzembe helyezése objektumból Image .

Akkor használja ezt a függvényt, ha már létrehozott egy Kép objektumot egy modellhez.

static deploy_from_image(workspace, name, image, deployment_config=None, deployment_target=None, overwrite=False)

Paraméterek

workspace: Workspace

Kötelező

Egy munkaterület-objektum, amellyel társítani szeretné a webszolgáltatást.

name: str

Kötelező

image: Image

Kötelező

Üzembe Image helyezendő objektum.

deployment_config: WebserviceDeploymentConfiguration

alapértelmezett érték: None

A webszolgáltatás konfigurálásához használt WebserviceDeploymentConfiguration. Ha nincs megadva, a rendszer egy üres konfigurációs objektumot használ a kívánt cél alapján.

deployment_target: ComputeTarget

alapértelmezett érték: None

overwrite: bool

alapértelmezett érték: False

Írja felül a meglévő szolgáltatást, ha a nevű szolgáltatás már létezik.

Válaszok

Az üzembe helyezett webszolgáltatásnak megfelelő webszolgáltatási objektum.

Visszatérési típus

Webservice

Kivételek

WebserviceException

deploy_from_model

Webszolgáltatás üzembe helyezése nulla vagy több Model objektumból.

Ez a függvény hasonló a függvényhez, deployde nem regisztrálja a modelleket. Ezt a függvényt akkor használja, ha már regisztrált modellobjektumokkal rendelkezik. Ezzel létrehoz egy rendszerképet a folyamatban, amely a megadott munkaterülethez van társítva.

static deploy_from_model(workspace, name, models, image_config, deployment_config=None, deployment_target=None, overwrite=False)

Paraméterek

workspace: Workspace

Kötelező

Egy munkaterület-objektum, amellyel társítani szeretné a webszolgáltatást.

name: str

Kötelező

models: list[Model]

Kötelező

Modellobjektumok listája. Lehet egy üres lista.

image_config: ImageConfig

Kötelező

A szükséges képtulajdonságok meghatározására használt ImageConfig objektum.

deployment_config: WebserviceDeploymentConfiguration

alapértelmezett érték: None

A webszolgáltatás konfigurálásához használt WebserviceDeploymentConfiguration. Ha nincs megadva, a rendszer egy üres konfigurációs objektumot használ a kívánt cél alapján.

deployment_target: ComputeTarget

alapértelmezett érték: None

A ComputeTarget a webszolgáltatás üzembe helyezéséhez. Mivel az ACI nincs társítva ComputeTarget, hagyja ezt a paramétert Nincs értéken az ACI-ben való üzembe helyezéshez.

overwrite: bool

alapértelmezett érték: False

Írja felül a meglévő szolgáltatást, ha a nevű szolgáltatás már létezik.

Válaszok

Az üzembe helyezett webszolgáltatásnak megfelelő webszolgáltatási objektum.

Visszatérési típus

Webservice

Kivételek

WebserviceException

deploy_local_from_model

Buildelés és üzembe helyezés LocalWebservice teszteléshez.

A Docker telepítését és konfigurálását igényli.

static deploy_local_from_model(workspace, name, models, image_config, deployment_config=None, wait=False)

Paraméterek

workspace: Workspace

Kötelező

Egy munkaterület-objektum, amellyel társítani kell a webszolgáltatást.

name: str

Kötelező

Az üzembe helyezett szolgáltatás nevét adja meg. A helyi gépen egyedinek kell lennie.

models: list[Model]

Kötelező

Modellobjektumok listája. Lehet egy üres lista.

image_config: ImageConfig

Kötelező

A szükséges szolgáltatásrendszerkép-tulajdonságok meghatározására használt ImageConfig objektum.

deployment_config: LocalWebserviceDeploymentConfiguration

alapértelmezett érték: None

A webszolgáltatás konfigurálásához használt LocalWebserviceDeploymentConfiguration. Ha nincs megadva, a rendszer egy üres konfigurációs objektumot használ.

wait: bool

alapértelmezett érték: False

Várjon-e, amíg a LocalWebservice Docker-tárolója kifogástalan állapotúként jelent. Kivételt jelez, ha a tároló összeomlik. Az alapértelmezett érték a Hamis.

Visszatérési típus

LocalWebservice

Kivételek

WebserviceException

deserialize

Modellkezelési szolgáltatás válasz JSON-objektumának átalakítása webszolgáltatás-objektummá.

Sikertelen lesz, ha a megadott munkaterület nem az a munkaterület, amely alatt a webszolgáltatás regisztrálva van.

deserialize(workspace, webservice_payload)

Paraméterek

cls

Kötelező

Azt jelzi, hogy ez egy osztálymetódus.

workspace: Workspace

Kötelező

A webszolgáltatás által regisztrált munkaterület-objektum.

webservice_payload: dict

Kötelező

Egy webszolgáltatás-objektummá konvertálandó JSON-objektum.

Válaszok

A megadott JSON-objektum webszolgáltatás-ábrázolása.

Visszatérési típus

Webservice

Kivételek

WebserviceException

get_keys

Kérje le a webszolgáltatás hitelesítési kulcsait.

get_keys()

Válaszok

A webszolgáltatás hitelesítési kulcsai.

Visszatérési típus

(str, str)

Kivételek

WebserviceException

get_logs

A webszolgáltatás naplóinak lekérése.

get_logs(num_lines=5000, init=False)

Paraméterek

num_lines: int

alapértelmezett érték: 5000

A beolvasandó naplósorok maximális száma.

init: bool

alapértelmezett érték: False

Az Init-tároló naplóinak lekérése

Válaszok

A webszolgáltatás naplói.

Visszatérési típus

str

Kivételek

WebserviceException

get_token

Kérje le a webszolgáltatás hitelesítési jogkivonatát, amely az aktuális felhasználóra terjed ki.

get_token()

Válaszok

A webszolgáltatás hitelesítési jogkivonata, és azt követően, hogy mikor kell frissíteni.

Visszatérési típus

str, datetime

Kivételek

WebserviceException

list

Listázhatja a megfelelő Workspacewebszolgáltatáshoz társított webszolgáltatásokat.

A visszaadott eredmények paraméterekkel szűrhetők.

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)

Paraméterek

workspace: Workspace

Kötelező

A webszolgáltatások listázásához használandó Workspace objektum.

compute_type: str

alapértelmezett érték: None

Szűrés csak bizonyos webszolgáltatás-típusok listázásához. A beállítások a következők: "ACI", "AKS".

image_name: str

alapértelmezett érték: None

Szűrőlista, amely csak az adott rendszerképnévvel üzembe helyezett webszolgáltatásokat tartalmazza.

image_id: str

alapértelmezett érték: None

Szűrőlista, amely csak az adott rendszerkép-azonosítóval üzembe helyezett webszolgáltatásokat tartalmazza.

model_name: str

alapértelmezett érték: None

Szűrőlista, amely csak az adott modellnévvel üzembe helyezett webszolgáltatásokat tartalmazza.

model_id: str

alapértelmezett érték: None

Szűrőlista, amely csak az adott modellazonosítóval üzembe helyezett webszolgáltatásokat tartalmazza.

tags: list

alapértelmezett érték: None

Szűrjön a megadott lista alapján a "key" vagy a "[key, value]" alapján. Pl. .key', ['key2', 'key2 value]]

properties: list

alapértelmezett érték: None

Szűrjön a megadott lista alapján a "key" vagy a "[key, value]" alapján. Pl. .key', ['key2', 'key2 value]]

image_digest: str

alapértelmezett érték: None

Szűrőlista, amely csak az adott rendszerkép-kivonattal üzembe helyezett webszolgáltatásokat tartalmazza.

Válaszok

A webszolgáltatások szűrt listája a megadott munkaterületen.

Visszatérési típus

list[Webservice]

Kivételek

WebserviceException

regen_key

Hozza létre újra a webszolgáltatás egyik kulcsát, az "Elsődleges" vagy a "Másodlagos" kulcsot.

Az A WebserviceException akkor jön létre, ha key nincs megadva, vagy nem "Elsődleges" vagy "Másodlagos".

regen_key(key, set_key=None)

Paraméterek

key: str

Kötelező

Az újragenerálandó kulcs. A beállítások az "Elsődleges" vagy a "Másodlagos".

set_key: str

alapértelmezett érték: None

Egy felhasználó által megadott érték, amely lehetővé teszi a kulcs értékének manuális meghatározását

Kivételek

WebserviceException

run

Hívja meg ezt a webszolgáltatást a megadott bemenettel.

A gyermekosztályai Webserviceáltal implementált absztrakt metódus.

abstract run(input)

Paraméterek

input: <xref:varies>

Kötelező

A webszolgáltatás meghívásához szükséges bemeneti adatok. Ez az adat, amelyet a gépi tanulási modell az előrejelzések futtatásának bemeneteként vár.

Válaszok

A webszolgáltatás meghívásának eredménye. Ez a gépi tanulási modellből futtatott előrejelzéseket ad vissza.

Visszatérési típus

dict

Kivételek

WebserviceException

serialize

Konvertálja ezt a webszolgáltatás-objektumot JSON szerializált szótárlá.

A használatával deserialize visszaalakulhat webszolgáltatás-objektummá.

serialize()

Válaszok

A webszolgáltatás JSON-reprezentációja.

Visszatérési típus

dict

Kivételek

WebserviceException

update

Frissítse a webszolgáltatás paramétereit.

Ez egy absztrakt metódus, amelyet a gyermekosztályai implementálnak Webservice. A lehetséges frissítési paraméterek a webszolgáltatás gyermektípusától függően változhatnak. Például Azure Container Instances webszolgáltatások esetében tekintse meg update az adott paramétereket.

abstract update(*args)

Paraméterek

args: <xref:varies>

Kötelező

Frissítendő értékek.

Kivételek

WebserviceException

update_deployment_state

Frissítse a memóriában lévő objektum aktuális állapotát.

Végezze el az objektum tulajdonságainak helyben történő frissítését a megfelelő felhőobjektum aktuális állapota alapján. Elsősorban a létrehozási állapot manuális lekérdezéséhez hasznos.

update_deployment_state()

Kivételek

WebserviceException

wait_for_deployment

Automatikus lekérdezés a futó webszolgáltatás-üzembe helyezésről.

Várjon, amíg a webszolgáltatás eléri a terminálállapotot. Egy hibát ad, WebserviceException ha nem sikeres terminálállapotba kerül, vagy túllépi a megadott időtúllépést.

wait_for_deployment(show_output=False, timeout_sec=None)

Paraméterek

show_output: bool

alapértelmezett érték: False

Azt jelzi, hogy részletesebb kimenetet szeretne-e nyomtatni.

timeout_sec: float

alapértelmezett érték: None

Kivételt jelez, ha az üzembe helyezés túllépi a megadott időtúllépést.

Kivételek

WebserviceException

Webservice Osztály

Konstruktor

Paraméterek

Megjegyzések

Változók

Metódusok

check_for_existing_webservice

Paraméterek

Kivételek

delete

Kivételek

deploy

Paraméterek

Válaszok

Visszatérési típus

Kivételek

deploy_from_image

Paraméterek

Válaszok

Visszatérési típus

Kivételek

deploy_from_model

Paraméterek

Válaszok

Visszatérési típus

Kivételek

deploy_local_from_model

Paraméterek

Visszatérési típus

Kivételek

deserialize

Paraméterek

Válaszok

Visszatérési típus

Kivételek

get_keys

Válaszok

Visszatérési típus

Kivételek

get_logs

Paraméterek

Válaszok

Visszatérési típus

Kivételek

get_token

Válaszok

Visszatérési típus

Kivételek

list

Paraméterek

Válaszok

Visszatérési típus

Kivételek

regen_key

Paraméterek

Kivételek

run

Paraméterek

Válaszok

Visszatérési típus

Kivételek

serialize

Válaszok

Visszatérési típus

Kivételek

update

Paraméterek

Kivételek

update_deployment_state

Kivételek

wait_for_deployment

Paraméterek

Kivételek

Visszajelzés

Visszajelzés

További források