Sdílet prostřednictvím

Webservice Třída

Definuje základní funkce pro nasazování modelů jako koncových bodů webové služby ve službě Azure Machine Learning.

Konstruktor webové služby slouží k načtení cloudové reprezentace objektu webové služby přidruženého k poskytnutému pracovnímu prostoru. Vrátí instanci podřízené třídy odpovídající určitému typu načteného objektu WebService. Třída Webservice umožňuje nasadit modely strojového učení z objektu nebo objektu ModelImage .

Další informace o práci s webovou službou najdete v tématu Nasazení modelů pomocí služby Azure Machine Learning.

Inicializuje instanci webové služby.

Konstruktor webservice načte cloudovou reprezentaci objektu webové služby přidruženého k poskytnutému pracovnímu prostoru. Vrátí instanci podřízené třídy odpovídající určitému typu načteného objektu webservice.

Konstruktor

Webservice(workspace, name)

Parametry

Name Description
workspace
Vyžadováno
Workspace

Objekt pracovního prostoru obsahující objekt webové služby, který se má načíst.
name
Vyžadováno
str

Název objektu webové služby, který se má načíst.
workspace
Vyžadováno
Workspace

Objekt pracovního prostoru obsahující objekt webové služby, který se má načíst.
name
Vyžadováno
str

Název objektu webové služby, který se má načíst.

Poznámky

Následující ukázka ukazuje doporučený vzor nasazení, ve kterém nejprve vytvoříte objekt konfigurace s deploy_configuration metodou podřízené třídy webservice (v tomto případě AksWebservice) a pak použijete konfiguraci s deploy metodou Model třídy.


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

Následující ukázka ukazuje, jak najít existující AciWebservice v pracovním prostoru a odstranit ho, pokud existuje, aby bylo možné název znovu použít.


   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)

Model můžete nasadit jako webovou službu několika způsoby, včetně následujících:

  • deploy metodu Model pro modely, které jsou již zaregistrovány v pracovním prostoru.

  • deploy_from_image Webservice metoda pro obrázky, které jsou již vytvořeny z modelu.

  • deploy_from_model Webservice metoda pro modely, které jsou již registrovány v pracovním prostoru. Tato metoda vytvoří image.

  • deploy Webservice, který zaregistruje model a vytvoří image.

Informace o práci s webovými službami najdete v tématu

Oddíl Variables uvádí atributy místní reprezentace objektu cloudové webové služby. Tyto proměnné by se měly považovat za jen pro čtení. Změna jejich hodnot se neprojeví v odpovídajícím cloudovém objektu.

Proměnné

Name Description
auth_enabled
bool

Bez ohledu na to, jestli má webová služba povolené ověřování.
compute_type
str

Do jakého typu výpočetní služby se webová služba nasadí.
created_time
datetime

Po vytvoření webové služby.
azureml.core.Webservice.description

Popis objektu webové služby.
azureml.core.Webservice.tags

Slovník značek pro objekt webové služby.
azureml.core.Webservice.name

Název webové služby.
azureml.core.Webservice.properties

Slovník vlastností hodnoty klíče pro webovou službu. Tyto vlastnosti nelze po nasazení změnit, ale je možné přidat nové páry klíč-hodnota.
created_by
str

Uživatel, který vytvořil webovou službu.
error
str

Pokud se webovou službu nepodařilo nasadit, bude obsahovat chybovou zprávu, proč selhala.
azureml.core.Webservice.state

Aktuální stav webové služby.
updated_time
datetime

Čas poslední aktualizace webové služby
azureml.core.Webservice.workspace

Pracovní prostor Služby Azure Machine Learning, který obsahuje tuto webovou službu.
token_auth_enabled
bool

Bez ohledu na to, jestli má webová služba povolené ověřování tokenů.

Metody

check_for_existing_webservice

Zkontrolujte, jestli webová služba existuje.
delete

Odstraňte tuto webovou službu z přidruženého pracovního prostoru.

Toto volání funkce není asynchronní. Volání se spustí, dokud se prostředek nespustí. Vyvolá WebserviceException se, pokud dojde k potížím s odstraněním modelu ze služby Správa modelů.
deploy

Nasaďte webovou službu z nuly nebo více Model objektů.

Tato funkce zaregistruje všechny soubory modelů, které jsou k dispozici, a vytvoří v procesu image, všechny přidružené k zadanému Workspace. Tuto funkci použijte, pokud máte adresář modelů k nasazení, který ještě nebyl zaregistrovaný.

Výsledná webová služba je koncový bod v reálném čase, který lze použít k odvozování požadavků. Další informace najdete v tématu Využití modelu nasazeného jako webová služba.
deploy_from_image

Nasaďte webovou službu z objektu Image .

Tuto funkci použijte, pokud už máte objekt Image vytvořený pro model.

Výsledná webová služba je koncový bod v reálném čase, který lze použít k odvozování požadavků. Další informace najdete v tématu Využití modelu nasazeného jako webová služba.
deploy_from_model

Nasaďte webovou službu z nuly nebo více Model objektů.

Tato funkce je podobná deploy, ale neregistruje modely. Tuto funkci použijte, pokud máte objekty modelu, které jsou již zaregistrovány. Tím se v procesu vytvoří image přidružená k zadanému pracovnímu prostoru.

Výsledná webová služba je koncový bod v reálném čase, který lze použít k odvozování požadavků. Další informace najdete v tématu Využití modelu nasazeného jako webová služba.
deploy_local_from_model

Sestavte a nasaďte testovací prostředí LocalWebservice .

Vyžaduje instalaci a konfiguraci Dockeru.
deserialize

Převeďte objekt JSON odpovědi služby Správa modelů na objekt webservice.

Pokud zadaný pracovní prostor není pracovním prostorem, ve které je webová služba zaregistrovaná, selže.
get_keys

Načtěte ověřovací klíče pro tuto webovou službu.
get_logs

Načtěte protokoly pro tuto webovou službu.
get_token

Načtěte ověřovací token pro tuto webovou službu s vymezeným aktuálním uživatelem.
list

Zobrazí seznam webových služeb přidružených k odpovídajícímu Workspace.

Vrácené výsledky lze filtrovat pomocí parametrů.
regen_key

Znovu vygenerujte jeden z klíčů webové služby, buď primární, nebo sekundární klíč.

A WebserviceException je vyvolána, pokud key není zadána nebo není "Primární" nebo "Sekundární".
run

Zavolejte tuto webovou službu se zadaným vstupem.

Abstraktní metoda implementovaná podřízenými třídami .Webservice
serialize

Převeďte tento objekt webové služby na serializovaný slovník JSON.

Slouží deserialize k převodu zpět na objekt webové služby.
update

Aktualizujte parametry webové služby.

Toto je abstraktní metoda implementovaná podřízenými třídami Webservice. Možné parametry, které se mají aktualizovat, se liší podle podřízeného typu webové služby. Například pro webové služby Azure Container Instances se podívejte update na konkrétní parametry.
update_deployment_state

Aktualizujte aktuální stav objektu v paměti.

Proveďte místní aktualizaci vlastností objektu na základě aktuálního stavu odpovídajícího cloudového objektu. Primárně užitečné pro ruční dotazování stavu vytváření.
wait_for_deployment

Automaticky se dotazuje na spuštěné nasazení webové služby.

Počkejte, až webová služba dosáhne stavu terminálu. Vyvolá chybu WebserviceException , pokud dosáhne stavu terminálu, který není úspěšný nebo překročí zadaný časový limit.

check_for_existing_webservice

Zkontrolujte, jestli webová služba existuje.

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

Parametry

Name Description
workspace
Vyžadováno
Workspace
name
Vyžadováno
str
overwrite
bool
Default value: False
request_func
<xref:function>

žádost o službu, aby zkontrolovala, jestli existuje název služby

Default value: None
check_func
<xref:function>

funkce ke kontrole obsahu odpovědi request_func

Default value: None

Výjimky

Typ Description
WebserviceException

delete

Odstraňte tuto webovou službu z přidruženého pracovního prostoru.

Toto volání funkce není asynchronní. Volání se spustí, dokud se prostředek nespustí. Vyvolá WebserviceException se, pokud dojde k potížím s odstraněním modelu ze služby Správa modelů.

delete()

Výjimky

Typ Description
WebserviceException

deploy

Nasaďte webovou službu z nuly nebo více Model objektů.

Tato funkce zaregistruje všechny soubory modelů, které jsou k dispozici, a vytvoří v procesu image, všechny přidružené k zadanému Workspace. Tuto funkci použijte, pokud máte adresář modelů k nasazení, který ještě nebyl zaregistrovaný.

Výsledná webová služba je koncový bod v reálném čase, který lze použít k odvozování požadavků. Další informace najdete v tématu Využití modelu nasazeného jako webová služba.

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

Parametry

Name Description
workspace
Vyžadováno
Workspace

Objekt pracovního prostoru pro přidružení webové služby.
name
Vyžadováno
str

Název, který má být nasazenou službou. Musí být jedinečný pro pracovní prostor, který se skládá jenom z malých písmen, číslic nebo pomlček, začíná písmenem a musí mít délku 3 až 32 znaků.
model_paths
Vyžadováno
list[str]

Seznam cest k diskům k modelovým souborům nebo složce Může to být prázdný seznam.
image_config
Vyžadováno
ImageConfig

Objekt ImageConfig sloužící k určení požadovaných vlastností image.
deployment_config
WebserviceDeploymentConfiguration

A WebserviceDeploymentConfiguration used to configure the webservice. Pokud ho nezadáte, použije se prázdný objekt konfigurace na základě požadovaného cíle.

Default value: None
deployment_target
ComputeTarget

A ComputeTarget pro nasazení webové služby do. Vzhledem k tomu, že služba Azure Container Instances nemá přidruženou žádnou instanci ComputeTarget, ponechte tento parametr jako None pro nasazení do služby Azure Container Instances.

Default value: None
overwrite
bool

Pokud již služba s názvem existuje, přepište stávající službu.

Default value: False

Návraty

Typ Description
Webservice

Objekt webové služby odpovídající nasazené webové službě.

Výjimky

Typ Description
WebserviceException

deploy_from_image

Nasaďte webovou službu z objektu Image .

Tuto funkci použijte, pokud už máte objekt Image vytvořený pro model.

Výsledná webová služba je koncový bod v reálném čase, který lze použít k odvozování požadavků. Další informace najdete v tématu Využití modelu nasazeného jako webová služba.

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

Parametry

Name Description
workspace
Vyžadováno
Workspace

Objekt pracovního prostoru pro přidružení webové služby.
name
Vyžadováno
str

Název, který má být nasazenou službou. Musí být jedinečný pro pracovní prostor, který se skládá jenom z malých písmen, číslic nebo pomlček, začíná písmenem a musí mít délku 3 až 32 znaků.
image
Vyžadováno
Image

Objekt Image , který se má nasadit.
deployment_config
WebserviceDeploymentConfiguration

A WebserviceDeploymentConfiguration used to configure the webservice. Pokud ho nezadáte, použije se prázdný objekt konfigurace na základě požadovaného cíle.

Default value: None
deployment_target
ComputeTarget

A ComputeTarget pro nasazení webové služby do. Vzhledem k tomu, že služba Azure Container Instances nemá přidruženou žádnou instanci ComputeTarget, ponechte tento parametr jako None pro nasazení do služby Azure Container Instances.

Default value: None
overwrite
bool

Pokud již služba s názvem existuje, přepište stávající službu.

Default value: False

Návraty

Typ Description
Webservice

Objekt webové služby odpovídající nasazené webové službě.

Výjimky

Typ Description
WebserviceException

deploy_from_model

Nasaďte webovou službu z nuly nebo více Model objektů.

Tato funkce je podobná deploy, ale neregistruje modely. Tuto funkci použijte, pokud máte objekty modelu, které jsou již zaregistrovány. Tím se v procesu vytvoří image přidružená k zadanému pracovnímu prostoru.

Výsledná webová služba je koncový bod v reálném čase, který lze použít k odvozování požadavků. Další informace najdete v tématu Využití modelu nasazeného jako webová služba.

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

Parametry

Name Description
workspace
Vyžadováno
Workspace

Objekt pracovního prostoru pro přidružení webové služby.
name
Vyžadováno
str

Název, který má být nasazenou službou. Musí být jedinečný pro pracovní prostor, který se skládá jenom z malých písmen, číslic nebo pomlček, začíná písmenem a musí mít délku 3 až 32 znaků.
models
Vyžadováno
list[Model]

Seznamobjektůch Může to být prázdný seznam.
image_config
Vyžadováno
ImageConfig

Objekt ImageConfig sloužící k určení požadovaných vlastností image.
deployment_config
WebserviceDeploymentConfiguration

A WebserviceDeploymentConfiguration used to configure the webservice. Pokud ho nezadáte, použije se prázdný objekt konfigurace na základě požadovaného cíle.

Default value: None
deployment_target
ComputeTarget

A ComputeTarget pro nasazení webové služby do. Vzhledem k tomu, že ACI nemá žádnou přidruženou funkci ComputeTarget, ponechte tento parametr jako None a nasaďte ho do ACI.

Default value: None
overwrite
bool

Pokud již služba s názvem existuje, přepište stávající službu.

Default value: False

Návraty

Typ Description
Webservice

Objekt webové služby odpovídající nasazené webové službě.

Výjimky

Typ Description
WebserviceException

deploy_local_from_model

Sestavte a nasaďte testovací prostředí LocalWebservice .

Vyžaduje instalaci a konfiguraci Dockeru.

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

Parametry

Name Description
workspace
Vyžadováno
Workspace

Objekt pracovního prostoru, ke kterému chcete přidružit webovou službu.
name
Vyžadováno
str

Název, který má být nasazenou službou. Na místním počítači musí být jedinečné.
models
Vyžadováno
list[Model]

Seznamobjektůch Může to být prázdný seznam.
image_config
Vyžadováno
ImageConfig

Objekt ImageConfig sloužící k určení požadovaných vlastností image služby.
deployment_config
LocalWebserviceDeploymentConfiguration

LocalWebserviceDeploymentConfiguration sloužící ke konfiguraci webové služby. Pokud ho nezadáte, použije se prázdný objekt konfigurace.

Default value: None
wait
bool

Určuje, jestli se má čekat, až se kontejner Dockeru služby LocalWebservice bude hlásit jako v pořádku. Vyvolá výjimku, pokud dojde k chybovému ukončení kontejneru. Výchozí hodnota je False.

Default value: False

Návraty

Typ Description
LocalWebservice

Výjimky

Typ Description
WebserviceException

deserialize

Převeďte objekt JSON odpovědi služby Správa modelů na objekt webservice.

Pokud zadaný pracovní prostor není pracovním prostorem, ve které je webová služba zaregistrovaná, selže.

deserialize(workspace, webservice_payload)

Parametry

Name Description
cls
Vyžadováno

Označuje, že se jedná o metodu třídy.
workspace
Vyžadováno
Workspace

Objekt pracovního prostoru, ve které je webová služba zaregistrovaná.
webservice_payload
Vyžadováno
dict

Objekt JSON, který se má převést na objekt webové služby.

Návraty

Typ Description
Webservice

Reprezentace webové služby poskytnutého objektu JSON.

get_keys

Načtěte ověřovací klíče pro tuto webovou službu.

get_keys()

Návraty

Typ Description
(str, str)

Ověřovací klíče pro tuto webovou službu.

Výjimky

Typ Description
WebserviceException

get_logs

Načtěte protokoly pro tuto webovou službu.

get_logs(num_lines=5000, init=False)

Parametry

Name Description
num_lines
int

Maximální počet řádků protokolu, které se mají načíst.

Default value: 5000
init
bool

Získání protokolů inicializačního kontejneru

Default value: False

Návraty

Typ Description
str

Protokoly pro tuto webovou službu.

Výjimky

Typ Description
WebserviceException

get_token

Načtěte ověřovací token pro tuto webovou službu s vymezeným aktuálním uživatelem.

get_token()

Návraty

Typ Description
str, datetime

Ověřovací token pro tuto webovou službu a kdy by se měl aktualizovat.

Výjimky

Typ Description
WebserviceException

list

Zobrazí seznam webových služeb přidružených k odpovídajícímu Workspace.

Vrácené výsledky lze filtrovat pomocí parametrů.

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)

Parametry

Name Description
workspace
Vyžadováno
Workspace

Objekt Pracovního prostoru pro výpis webových služeb v.
compute_type
str

Umožňuje filtrovat pouze konkrétní typy webových služeb. Možnosti jsou ACI, AKS.

Default value: None
image_name
str

Seznam filtrů tak, aby zahrnoval pouze webové služby nasazené s konkrétním názvem image.

Default value: None
image_id
str

Seznam filtrů tak, aby zahrnoval pouze webové služby nasazené s konkrétním ID image.

Default value: None
model_name
str

Seznam filtrů tak, aby zahrnoval pouze webové služby nasazené s konkrétním názvem modelu.

Default value: None
model_id
str

Seznam filtrů tak, aby zahrnoval pouze webové služby nasazené s konkrétním ID modelu.

Default value: None
tags
list

Filtrujte podle zadaného seznamu podle klíče nebo [klíče, hodnoty]. Příklad: ['key', ['key2', 'key2 value']]

Default value: None
properties
list

Filtrujte podle zadaného seznamu podle klíče nebo [klíče, hodnoty]. Příklad: ['key', ['key2', 'key2 value']]

Default value: None
image_digest
str

Seznam filtrů tak, aby zahrnoval pouze webové služby nasazené s konkrétní hodnotou hash image.

Default value: None

Návraty

Typ Description
list[Webservice]

Filtrovaný seznam webových služeb v zadaném pracovním prostoru.

Výjimky

Typ Description
WebserviceException

regen_key

Znovu vygenerujte jeden z klíčů webové služby, buď primární, nebo sekundární klíč.

A WebserviceException je vyvolána, pokud key není zadána nebo není "Primární" nebo "Sekundární".

regen_key(key, set_key=None)

Parametry

Name Description
key
Vyžadováno
str

Klíč, který se má znovu vygenerovat. Možnosti jsou Primární nebo Sekundární.
set_key
str

Uživatel zadal hodnotu, která umožňuje ruční specifikaci hodnoty klíče.

Default value: None

Výjimky

Typ Description
WebserviceException

run

Zavolejte tuto webovou službu se zadaným vstupem.

Abstraktní metoda implementovaná podřízenými třídami .Webservice

abstract run(input)

Parametry

Name Description
input
Vyžadováno
<xref:varies>

Vstupní data pro volání webové služby. Jedná se o data, která model strojového učení očekává jako vstup ke spouštění předpovědí.

Návraty

Typ Description
dict

Výsledek volání webové služby. Tím se vrátí předpovědi spuštěné z modelu strojového učení.

Výjimky

Typ Description
WebserviceException

serialize

Převeďte tento objekt webové služby na serializovaný slovník JSON.

Slouží deserialize k převodu zpět na objekt webové služby.

serialize()

Návraty

Typ Description
dict

Reprezentace této webové služby ve formátu JSON.

update

Aktualizujte parametry webové služby.

Toto je abstraktní metoda implementovaná podřízenými třídami Webservice. Možné parametry, které se mají aktualizovat, se liší podle podřízeného typu webové služby. Například pro webové služby Azure Container Instances se podívejte update na konkrétní parametry.

abstract update(*args)

Parametry

Name Description
args
Vyžadováno
<xref:varies>

Hodnoty, které chcete aktualizovat.

Výjimky

Typ Description
WebserviceException

update_deployment_state

Aktualizujte aktuální stav objektu v paměti.

Proveďte místní aktualizaci vlastností objektu na základě aktuálního stavu odpovídajícího cloudového objektu. Primárně užitečné pro ruční dotazování stavu vytváření.

update_deployment_state()

wait_for_deployment

Automaticky se dotazuje na spuštěné nasazení webové služby.

Počkejte, až webová služba dosáhne stavu terminálu. Vyvolá chybu WebserviceException , pokud dosáhne stavu terminálu, který není úspěšný nebo překročí zadaný časový limit.

wait_for_deployment(show_output=False, timeout_sec=None)

Parametry

Name Description
show_output
bool

Určuje, zda se má vytisknout více podrobného výstupu.

Default value: False
timeout_sec
float

Pokud nasazení překročí daný časový limit, vyvolá výjimku.

Default value: None

Výjimky

Typ Description
WebserviceException