LocalWebservice Klasa

Reprezentuje model uczenia maszynowego wdrożony jako lokalny punkt końcowy usługi internetowej.

Lokalne wdrażanie usług internetowych jest przydatne w przypadku scenariuszy debugowania i testowania.

Lokalny konstruktor usługi internetowej.

Konstruktor LocalWebservice służy do pobierania lokalnej reprezentacji obiektu LocalWebservice skojarzonego z podanym obszarem roboczym.

Dziedziczenie

Webservice

LocalWebservice

Konstruktor

LocalWebservice(*args, **kwargs)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obiekt obszaru roboczego zawierający wszystkie obiekty modelu, które zostaną pobrane.
name Wymagane	str Nazwa obiektu webservice do pobrania.
must_exist Wymagane	bool Czy usługa internetowa musi już istnieć podczas tworzenia obiektu w pamięci.
workspace Wymagane	Workspace Obiekt obszaru roboczego zawierający wszystkie obiekty modelu, które zostaną pobrane.
name Wymagane	str Nazwa obiektu LocalWebservice do pobrania.
must_exist Wymagane	bool Czy usługa internetowa musi już istnieć podczas tworzenia obiektu w pamięci.

Uwagi

Poniższe przykłady kodu pokazują, jak utworzyć lokalną usługę internetową platformy Docker. Aby uzyskać więcej informacji, zobacz link notesu.

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

Pełna próbka jest dostępna w witrynie https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb

Metody

delete	Usuń tę usługę LocalWebservice z komputera lokalnego. To wywołanie funkcji nie jest asynchroniczne; jest uruchamiana do momentu usunięcia usługi.
deploy_configuration	Utwórz obiekt konfiguracji na potrzeby wdrażania lokalnej usługi sieci Web.
deploy_to_cloud	Wdróż usługę internetową na podstawie konfiguracji localWebservice.
deserialize	Przekonwertuj obiekt JSON odpowiedzi usługi zarządzania modelami na obiekt usługi sieci Web. Uwaga Nieobsługiwane w przypadku usługi LocalWebservice.
get_keys	Pobierz klucze uwierzytelniania dla tej usługi sieci Web. Uwaga Nieobsługiwane w przypadku usługi LocalWebservice.
get_logs	Pobierz dzienniki dla tej usługi LocalWebservice.
get_token	Pobierz token uwierzytelniania dla tej usługi sieci Web z zakresem bieżącego użytkownika. Uwaga Nieobsługiwane w przypadku usługi LocalWebservice.
list	Wyświetl listę localWebservices skojarzonych z odpowiednim obszarem roboczym. Zwrócone wyniki można filtrować przy użyciu parametrów.
regen_key	Wygeneruj ponownie jeden z kluczy usługi internetowej. Uwaga Nieobsługiwane w przypadku usługi LocalWebservice.
reload	Załaduj ponownie skrypt wykonywania i zależności usługi LocalWebservice. Spowoduje to ponowne uruchomienie kontenera usługi z kopiami zaktualizowanych zasobów, w tym skryptu wykonywania i zależności lokalnych, ale nie powoduje ponownego skompilowania obrazu bazowego. W związku z tym zmiany zależności conda/pip lub niestandardowe kroki platformy Docker nie zostaną odzwierciedlone w ponownie załadowanej usłudze LocalWebservice. Aby obsłużyć te zmiany, należy zamiast tego wywołać metodę update .
run	Wywołaj tę usługę LocalWebservice przy użyciu podanych danych wejściowych.
serialize	Przekonwertuj ten obiekt usługi internetowej na słownik serializowany w formacie JSON.
update	Zaktualizuj wartość LocalWebservice za pomocą podanych właściwości. Wartości pozostawione jako Brak pozostaną niezmienione w tej lokalnej usłudzeWebservice.
update_deployment_state	Odśwież bieżący stan obiektu w pamięci. Przeprowadź aktualizację w miejscu właściwości obiektu na podstawie bieżącego stanu odpowiedniego lokalnego kontenera platformy Docker.
wait_for_deployment	Sonduj uruchomione wdrożenie LocalWebservice.

delete

Usuń tę usługę LocalWebservice z komputera lokalnego.

To wywołanie funkcji nie jest asynchroniczne; jest uruchamiana do momentu usunięcia usługi.

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

Parametry

Nazwa	Opis
delete_cache Wymagane	bool Czy usunąć pliki tymczasowe buforowane dla usługi. (Wartość domyślna: Prawda)
delete_image Wymagane	bool Czy usunąć obraz platformy Docker usługi. (Wartość domyślna: Fałsz)
delete_volume Wymagane	bool Czy usunąć wolumin platformy Docker usługi. (Wartość domyślna: Prawda)

Wyjątki

Typ	Opis
WebserviceException

deploy_configuration

Utwórz obiekt konfiguracji na potrzeby wdrażania lokalnej usługi sieci Web.

static deploy_configuration(port=None)

Parametry

Nazwa	Opis
port	int Port lokalny, na którym można uwidocznić punkt końcowy HTTP usługi. Domyślna wartość: None

Zwraca

Typ	Opis
LocalWebserviceDeploymentConfiguration	Obiekt konfiguracji, który ma być używany podczas wdrażania obiektu usługi sieci Web.

Wyjątki

Typ	Opis
WebserviceException

deploy_to_cloud

Wdróż usługę internetową na podstawie konfiguracji localWebservice.

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

Parametry

Nazwa	Opis
name	str Nazwa, która ma nadać wdrożonej usłudze. Musi być unikatowa dla obszaru roboczego. Domyślna wartość: None
deployment_config	WebserviceDeploymentConfiguration WebserviceDeploymentConfiguration używana do konfigurowania usługi internetowej. Jeśli go nie podano, pusty obiekt konfiguracji zostanie użyty na podstawie żądanego obiektu docelowego. Domyślna wartość: None
deployment_target	ComputeTarget A ComputeTarget , do którego ma zostać wdrożona usługa sieci Web. Ponieważ usługa ACI nie ma skojarzonego ComputeTargetparametru , pozostaw ten parametr jako Brak, aby wdrożyć go w usłudze ACI. Domyślna wartość: None

Zwraca

Typ	Opis
Webservice	Obiekt usługi sieci Web odpowiadający wdrożonej usłudze internetowej.

Wyjątki

Typ	Opis
WebserviceException

deserialize

Przekonwertuj obiekt JSON odpowiedzi usługi zarządzania modelami na obiekt usługi sieci Web.

Uwaga

Nieobsługiwane w przypadku usługi LocalWebservice.

deserialize(workspace, webservice_payload)

Parametry

Nazwa	Opis
cls Wymagane
workspace Wymagane	Workspace Obiekt obszaru roboczego, w ramach których zarejestrowano usługę internetową.
webservice_payload Wymagane	dict Obiekt JSON do konwersji na obiekt usługi internetowej.

Wyjątki

Typ	Opis
azureml.exceptions.NotImplementedError

get_keys

Pobierz klucze uwierzytelniania dla tej usługi sieci Web.

Uwaga

Nieobsługiwane w przypadku usługi LocalWebservice.

get_keys()

Zwraca

Typ	Opis
	Klucze uwierzytelniania dla tej usługi sieci Web.

Wyjątki

Typ	Opis
azureml.exceptions.NotImplementedError

get_logs

Pobierz dzienniki dla tej usługi LocalWebservice.

get_logs(num_lines=5000, raw=False)

Parametry

Nazwa	Opis
num_lines Wymagane	int Maksymalna liczba wierszy dziennika do pobrania. (Ustawienie domyślne: 5000)
raw Wymagane	bool Zwraca nieprzetworzone dane wyjściowe kontenera platformy Docker bez próby jego sformatowania. (Wartość domyślna: Fałsz)

Zwraca

Typ	Opis
str	Dzienniki dla tej usługi LocalWebservice.

Wyjątki

Typ	Opis
WebserviceException

get_token

Pobierz token uwierzytelniania dla tej usługi sieci Web z zakresem bieżącego użytkownika.

Uwaga

Nieobsługiwane w przypadku usługi LocalWebservice.

get_token()

Zwraca

Typ	Opis
str, datetime	Token uwierzytelniania dla tej usługi internetowej i kiedy należy go odświeżyć po.

Wyjątki

Typ	Opis
azureml.exceptions.NotImplementedError

list

Wyświetl listę localWebservices skojarzonych z odpowiednim obszarem roboczym.

Zwrócone wyniki można filtrować przy użyciu parametrów.

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

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obiekt Workspace skojarzony z usługą LocalWebservices.
model_name	str Filtruj listę, aby uwzględnić tylko usługi LocalWebservices wdrożone z określoną nazwą modelu. Domyślna wartość: None
model_id	str Filtruj listę, aby uwzględnić tylko usługi LocalWebservices wdrożone przy użyciu określonego identyfikatora modelu. Domyślna wartość: None
all	bool Pokaż wszystkie usługi. Domyślnie wyświetlane są tylko uruchomione usługi. Domyślna wartość: None

Zwraca

Typ	Opis
list[LocalWebservice]	Filtrowana lista localWebservices skojarzona z podanym obszarem roboczym.

Wyjątki

Typ	Opis
WebserviceException

regen_key

Wygeneruj ponownie jeden z kluczy usługi internetowej.

Uwaga

Nieobsługiwane w przypadku usługi LocalWebservice.

regen_key(key)

Parametry

Nazwa	Opis
key Wymagane	str Który klucz do ponownego wygenerowania. Opcje to "Primary" lub "Secondary"

Wyjątki

Typ	Opis
NotImplementedError

reload

Załaduj ponownie skrypt wykonywania i zależności usługi LocalWebservice.

Spowoduje to ponowne uruchomienie kontenera usługi z kopiami zaktualizowanych zasobów, w tym skryptu wykonywania i zależności lokalnych, ale nie powoduje ponownego skompilowania obrazu bazowego. W związku z tym zmiany zależności conda/pip lub niestandardowe kroki platformy Docker nie zostaną odzwierciedlone w ponownie załadowanej usłudze LocalWebservice. Aby obsłużyć te zmiany, należy zamiast tego wywołać metodę update .

reload(wait=False)

Parametry

Nazwa	Opis
wait Wymagane	bool Poczekaj, aż kontener usługi osiągnie stan dobrej kondycji. (Wartość domyślna: Fałsz)

Wyjątki

Typ	Opis
WebserviceException

run

Wywołaj tę usługę LocalWebservice przy użyciu podanych danych wejściowych.

run(input_data)

Parametry

Nazwa	Opis
input_data Wymagane	<xref:varies> Dane wejściowe, za pomocą których ma być wywoływana usługa LocalWebservice.

Zwraca

Typ	Opis
<xref:varies>	Wynik wywołania localWebservice.

Wyjątki

Typ	Opis
WebserviceException

serialize

Przekonwertuj ten obiekt usługi internetowej na słownik serializowany w formacie JSON.

serialize()

Zwraca

Typ	Opis
dict	Serializowana reprezentacja obiektu usługi internetowej.

Wyjątki

Typ	Opis
WebserviceException

update

Zaktualizuj wartość LocalWebservice za pomocą podanych właściwości.

Wartości pozostawione jako Brak pozostaną niezmienione w tej lokalnej usłudzeWebservice.

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

Parametry

Nazwa	Opis
models Wymagane	list[Model] Nowa lista modeli zawartych w usłudze LocalWebservice.
image_config Wymagane	ContainerImageConfig Opcje konfiguracji obrazu, które mają być stosowane do usługi LocalWebservice.
deployment_config Wymagane	LocalWebserviceDeploymentConfiguration Opcje konfiguracji wdrożenia, które mają być stosowane do usługi LocalWebservice.
inference_config Wymagane	InferenceConfig Obiekt InferenceConfig używany do dostarczania wymaganych właściwości wdrożenia modelu.
wait Wymagane	bool Poczekaj, aż kontener usługi osiągnie stan dobrej kondycji. (Wartość domyślna: Fałsz)

Zwraca

Typ	Opis
None

Wyjątki

Typ	Opis
WebserviceException

update_deployment_state

Odśwież bieżący stan obiektu w pamięci.

Przeprowadź aktualizację w miejscu właściwości obiektu na podstawie bieżącego stanu odpowiedniego lokalnego kontenera platformy Docker.

update_deployment_state(must_exist=False)

Parametry

Nazwa	Opis
must_exist	bool Czy usługa internetowa musi już istnieć podczas tworzenia obiektu w pamięci. Domyślna wartość: False

Wyjątki

Typ	Opis
WebserviceException

wait_for_deployment

Sonduj uruchomione wdrożenie LocalWebservice.

wait_for_deployment(show_output=False)

Parametry

Nazwa	Opis
show_output Wymagane	bool Opcja drukowania bardziej pełnych danych wyjściowych. (Wartość domyślna: Fałsz)

Wyjątki

Typ	Opis
WebserviceException

Atrybuty

port

Pobierz lokalny port usługi internetowej.

Zwraca

Typ	Opis
int	Numer portu.

scoring_uri

Pobierz identyfikator URI oceniania lokalnej usługi internetowej.

Zwraca

Typ	Opis
str	Identyfikator URI oceniania.

swagger_uri

Pobierz identyfikator URI lokalnej usługi internetowej struktury Swagger.

Zwraca

Typ	Opis
str	Identyfikator URI struktury Swagger.

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'