Udostępnij za pośrednictwem

AksWebservice Klasa

  • Odwołanie

Reprezentuje model uczenia maszynowego wdrożony jako punkt końcowy usługi internetowej w Azure Kubernetes Service.

Wdrożona usługa jest tworzona na podstawie modelu, skryptu i skojarzonych plików. Wynikowa usługa internetowa to punkt końcowy HTTP o zrównoważonym obciążeniu z interfejsem API REST. Dane można wysyłać do tego interfejsu API i otrzymywać przewidywania zwrócone przez model.

Usługa AksWebservice wdraża pojedynczą usługę w jednym punkcie końcowym. Aby wdrożyć wiele usług w jednym punkcie końcowym, użyj AksEndpoint klasy .

Aby uzyskać więcej informacji, zobacz Wdrażanie modelu w klastrze Azure Kubernetes Service.

Zainicjuj wystąpienie usługi internetowej.

Konstruktor usługi internetowej pobiera reprezentację chmury obiektu usługi internetowej skojarzonego z podanym obszarem roboczym. Zwróci wystąpienie klasy podrzędnej odpowiadające określonemu typowi pobranego obiektu usługi sieci Web.

Dziedziczenie
Webservice
AksWebservice

Konstruktor

AksWebservice(workspace, name)

Parametry

Nazwa Opis
workspace
Wymagane
Workspace

Obiekt obszaru roboczego zawierający obiekt usługi sieci Web do pobrania.
name
Wymagane
str

Nazwa obiektu webservice do pobrania.

Uwagi

Zalecanym wzorcem wdrażania jest utworzenie obiektu konfiguracji wdrożenia za deploy_configuration pomocą metody , a następnie użycie go z deploy metodą Model klasy, jak pokazano poniżej.


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

Pełna próbka jest dostępna z witryny https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/production-deploy-to-aks/production-deploy-to-aks.ipynb

Istnieje wiele sposobów wdrażania modelu jako usługi internetowej, w tym następujących elementów:

  • deploy metoda dla modeli już zarejestrowanych Model w obszarze roboczym.

  • deploy_from_imagemetoda .Webservice

  • deploy_from_model metoda dla modeli już zarejestrowanych Webservice w obszarze roboczym. Ta metoda spowoduje utworzenie obrazu.

  • deploy Webservicemetoda , która zarejestruje model i utworzy obraz.

Aby uzyskać informacje na temat pracy z usługami internetowymi, zobacz

Sekcja Zmienne zawiera listę atrybutów lokalnej reprezentacji obiektu cloud AksWebservice. Te zmienne powinny być traktowane jako tylko do odczytu. Zmiana ich wartości nie zostanie odzwierciedlona w odpowiednim obiekcie chmury.

Zmienne

Nazwa Opis
enable_app_insights
bool

Niezależnie od tego, czy rejestrowanie usługi AppInsights jest włączone dla usługi internetowej.
autoscaler
AutoScaler

Obiekt autoskalatora dla usługi internetowej.
compute_name
str

Nazwa obiektu ComputeTarget, w ramach którego wdrożono usługę internetową.
container_resource_requirements
ContainerResourceRequirements

Wymagania dotyczące zasobów kontenera dla usługi internetowej.
liveness_probe_requirements
LivenessProbeRequirements

Wymagania sondy utrzymania dla usługi internetowej.
data_collection
DataCollection

Obiekt DataCollection dla usługi sieci Web.
max_concurrent_requests_per_container
int

Maksymalna liczba współbieżnych żądań na kontener dla usługi internetowej.
max_request_wait_time
int

Maksymalny czas oczekiwania żądania dla usługi internetowej (w milisekundach).
num_replicas
int

Liczba replik usługi sieci Web. Każda replika odpowiada zasobnikowi usługi AKS.
scoring_timeout_ms
int

Limit czasu oceniania dla usługi internetowej w milisekundach.
azureml.core.webservice.AksWebservice.scoring_uri
str

Punkt końcowy oceniania dla usługi internetowej
is_default
bool

Jeśli usługa sieci Web jest domyślną wersją nadrzędnego punktu końcowego AksEndpoint.
traffic_percentile
int

Jaki procent ruchu ma być kierowany do usługi internetowej w nadrzędnym elemencie AksEndpoint.
version_type
VersionType

Typ wersji usługi internetowej w nadrzędnym AksEndpoint.
token_auth_enabled
bool

Określa, czy dla usługi sieci Web jest włączone uwierzytelnianie tokenu.
environment
Environment

Obiekt Environment, który został użyty do utworzenia usługi sieci Web.
azureml.core.webservice.AksWebservice.models
list[Model]

Lista modeli wdrożonych w usłudze internetowej.
deployment_status
str

Stan wdrożenia usługi sieci Web.
namespace
str

Przestrzeń nazw usługi AKS usługi internetowej.
azureml.core.webservice.AksWebservice.swagger_uri
str

Punkt końcowy struktury Swagger dla usługi internetowej.

Metody

add_properties

Dodaj pary wartości klucza do słownika właściwości tej usługi sieci Web.
add_tags

Dodaj pary klucz-wartość do słownika tagów tej usługi sieci Web.

Wywołuje element WebserviceException.
deploy_configuration

Utwórz obiekt konfiguracji do wdrażania w docelowym obiekcie obliczeniowym usługi AKS.
get_access_token

Pobierz token uwierzytelniania dla tej usługi sieci Web.
get_token

PRZESTARZAŁE. Zamiast tego użyj get_access_token metody .

Pobierz token uwierzytelniania dla tej usługi sieci Web.
remove_tags

Usuń określone klucze ze słownika tagów tej usługi sieci Web.
run

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

Przekonwertuj tę usługę internetową na słownik serializacji JSON.
update

Zaktualizuj usługę sieci Web przy użyciu podanych właściwości.

Wartości pozostawione jako Brak pozostaną niezmienione w tej usłudze sieci Web.

add_properties

Dodaj pary wartości klucza do słownika właściwości tej usługi sieci Web.

add_properties(properties)

Parametry

Nazwa Opis
properties
Wymagane
dict[str, str]

Słownik właściwości do dodania.

add_tags

Dodaj pary klucz-wartość do słownika tagów tej usługi sieci Web.

Wywołuje element WebserviceException.

add_tags(tags)

Parametry

Nazwa Opis
tags
Wymagane
dict[str, str]

Słownik tagów do dodania.

Wyjątki

Typ Opis
WebserviceException

deploy_configuration

Utwórz obiekt konfiguracji do wdrażania w docelowym obiekcie obliczeniowym usługi AKS.

static deploy_configuration(autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, primary_key=None, secondary_key=None, tags=None, properties=None, description=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, compute_target_name=None, cpu_cores_limit=None, memory_gb_limit=None, blobfuse_enabled=None)

Parametry

Nazwa Opis
autoscale_enabled
bool

Określa, czy włączyć skalowanie automatyczne dla tej usługi sieci Web. Wartość domyślna to True, jeśli num_replicas to Brak.

Domyślna wartość: None
autoscale_min_replicas
int

Minimalna liczba kontenerów do użycia podczas skalowania automatycznego tej usługi sieci Web. Wartość domyślna to 1.

Domyślna wartość: None
autoscale_max_replicas
int

Maksymalna liczba kontenerów do użycia podczas skalowania automatycznego tej usługi sieci Web. Wartość domyślna to 10.

Domyślna wartość: None
autoscale_refresh_seconds
int

Jak często autoskalator powinien próbować skalować tę usługę internetową. Wartość domyślna to 1.

Domyślna wartość: None
autoscale_target_utilization
int

Docelowe wykorzystanie (w procentach na 100) autoskalator powinien podjąć próbę utrzymania dla tej usługi sieci Web. Wartość domyślna to 70.

Domyślna wartość: None
collect_model_data
bool

Określa, czy włączyć zbieranie danych modelu dla tej usługi sieci Web. Wartość domyślna to False.

Domyślna wartość: None
auth_enabled
bool

Określa, czy włączyć uwierzytelnianie klucza dla tej usługi sieci Web. Wartość domyślna to True.

Domyślna wartość: None
cpu_cores
float

Liczba rdzeni procesora cpu do przydzielenia dla tej usługi sieci Web. Może to być liczba dziesiętna. Wartość domyślna to 0.1. Odpowiada żądaniu rdzenia zasobnika, a nie limitowi w Azure Kubernetes Service.

Domyślna wartość: None
memory_gb
float

Ilość pamięci (w GB) do przydzielenia dla tej usługi sieci Web. Może to być liczba dziesiętna. Wartość domyślna to 0,5. Odpowiada żądaniu pamięci zasobnika, a nie limitowi w Azure Kubernetes Service.

Domyślna wartość: None
enable_app_insights
bool

Czy włączyć rejestrowanie usługi Application Insights dla tej usługi sieci Web. Wartość domyślna to False.

Domyślna wartość: None
scoring_timeout_ms
int

Limit czasu wymuszany dla wywołań oceniania do tej usługi sieci Web. Wartość domyślna to 60000.

Domyślna wartość: None
replica_max_concurrent_requests
int

Maksymalna liczba współbieżnych żądań na replikę w celu zezwolenia na tę usługę sieci Web. Wartość domyślna to 1. Nie zmieniaj tego ustawienia z wartości domyślnej 1, chyba że zostanie to poinstruowane przez pomoc techniczną firmy Microsoft lub członka zespołu usługi Azure Machine Learning.

Domyślna wartość: None
max_request_wait_time
int

Maksymalny czas oczekiwania żądania pozostanie w kolejce (w milisekundach) przed zwróceniem błędu 503. Wartość domyślna to 500.

Domyślna wartość: None
num_replicas
int

Liczba kontenerów do przydzielenia dla tej usługi sieci Web. Nie, jeśli ten parametr nie jest ustawiony, autoskalator jest domyślnie włączony.

Domyślna wartość: None
primary_key
str

Podstawowy klucz uwierzytelniania do użycia dla tej usługi sieci Web.

Domyślna wartość: None
secondary_key
str

Pomocniczy klucz uwierzytelniania do użycia dla tej usługi sieci Web.

Domyślna wartość: None
tags
dict[str, str]

Słownik tagów wartości klucza, aby nadać tej usłudze sieci Web.

Domyślna wartość: None
properties
dict[str, str]

Słownik właściwości wartości klucza, aby nadać tej usłudze sieci Web. Tych właściwości nie można zmienić po wdrożeniu, jednak można dodać nowe pary wartości klucza.

Domyślna wartość: None
description
str

Opis umożliwiający nadanie tej usłudze sieci Web.

Domyślna wartość: None
gpu_cores
int

Liczba rdzeni procesora GPU do przydzielenia dla tej usługi sieci Web. Wartość domyślna to 0.

Domyślna wartość: None
period_seconds
int

Jak często (w sekundach) wykonać sondę liveness. Wartość domyślna to 10 sekund. Wartość minimalna to 1.

Domyślna wartość: None
initial_delay_seconds
int

Liczba sekund po uruchomieniu kontenera przed zainicjowaniem sond dynamicznych. Wartość domyślna to 310.

Domyślna wartość: None
timeout_seconds
int

Liczba sekund, po których upłynął limit czasu sondy utrzymania. Wartość domyślna to 2 sekundy. Wartość minimalna to 1.

Domyślna wartość: None
success_threshold
int

Minimalna liczba kolejnych sukcesów dla sondy utrzymania, która ma zostać uznana za pomyślną po niepowieść. Wartość domyślna to 1. Wartość minimalna to 1.

Domyślna wartość: None
failure_threshold
int

Po uruchomieniu zasobnika i niepowodzeniu sondy aktualności platforma Kubernetes spróbuje użyć czasu niepowodzeniaThreshold przed rezygnacją. Wartość domyślna to 3. Wartość minimalna to 1.

Domyślna wartość: None
namespace
str

Przestrzeń nazw Kubernetes, w której ma zostać wdrożona ta usługa internetowa: maksymalnie 63 małe litery alfanumeryczne ('a'-'z', '0'-'9') i znaki łącznika ('-'). Pierwsze i ostatnie znaki nie mogą być łącznikami.

Domyślna wartość: None
token_auth_enabled
bool

Czy włączyć uwierzytelnianie tokenu dla tej usługi sieci Web. Jeśli ta opcja jest włączona, użytkownicy mogą uzyskiwać dostęp do tej usługi sieci Web, pobierając token dostępu przy użyciu poświadczeń usługi Azure Active Directory. Wartość domyślna to False.

Domyślna wartość: None
compute_target_name
str

Nazwa docelowego obiektu obliczeniowego do wdrożenia

Domyślna wartość: None
cpu_cores_limit
float

Maksymalna liczba rdzeni procesora cpu, z których może korzystać ta usługa sieci Web. Może to być liczba dziesiętna.

Domyślna wartość: None
memory_gb_limit
float

Maksymalna ilość pamięci (w GB) dozwolonej przez tę usługę sieci Web. Może to być liczba dziesiętna.

Domyślna wartość: None
blobfuse_enabled
bool

Czy włączyć blobfuse na potrzeby pobierania modelu dla tej usługi sieci Web. Wartość domyślna to True

Domyślna wartość: None

Zwraca

Typ Opis
AksServiceDeploymentConfiguration

Obiekt konfiguracji używany podczas wdrażania usługi AksWebservice.

Wyjątki

Typ Opis
WebserviceException

get_access_token

Pobierz token uwierzytelniania dla tej usługi sieci Web.

get_access_token()

Zwraca

Typ Opis
AksServiceAccessToken

Obiekt opisujący token uwierzytelniania dla tej usługi sieci Web.

Wyjątki

Typ Opis
WebserviceException

get_token

PRZESTARZAŁE. Zamiast tego użyj get_access_token metody .

Pobierz token uwierzytelniania dla tej usługi sieci Web.

get_token()

Zwraca

Typ Opis
str, datetime

Token uwierzytelniania dla tej usługi sieci Web i kiedy go odświeżyć.

Wyjątki

Typ Opis
WebserviceException

remove_tags

Usuń określone klucze ze słownika tagów tej usługi sieci Web.

remove_tags(tags)

Parametry

Nazwa Opis
tags
Wymagane
list[str]

Lista kluczy do usunięcia

run

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

run(input_data)

Parametry

Nazwa Opis
input_data
Wymagane
<xref:varies>

Dane wejściowe do wywołania usługi sieci Web za pomocą polecenia

Zwraca

Typ Opis
dict

Wynik wywołania usługi sieci Web

Wyjątki

Typ Opis
WebserviceException

serialize

Przekonwertuj tę usługę internetową na słownik serializacji JSON.

serialize()

Zwraca

Typ Opis
dict

Reprezentacja JSON tej usługi sieci Web.

update

Zaktualizuj usługę sieci Web przy użyciu podanych właściwości.

Wartości pozostawione jako Brak pozostaną niezmienione w tej usłudze sieci Web.

update(image=None, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, tags=None, properties=None, description=None, models=None, inference_config=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, cpu_cores_limit=None, memory_gb_limit=None, **kwargs)

Parametry

Nazwa Opis
image
Image

Nowy obraz do wdrożenia w usłudze internetowej

Domyślna wartość: None
autoscale_enabled
bool

Włączanie lub wyłączanie automatycznego skalowania tej usługi sieci Web

Domyślna wartość: None
autoscale_min_replicas
int

Minimalna liczba kontenerów do użycia podczas automatycznego skalowania tej usługi sieci Web

Domyślna wartość: None
autoscale_max_replicas
int

Maksymalna liczba kontenerów do użycia podczas automatycznego skalowania tej usługi sieci Web

Domyślna wartość: None
autoscale_refresh_seconds
int

Jak często program skalowania automatycznego powinien próbować skalować tę usługę internetową

Domyślna wartość: None
autoscale_target_utilization
int

Użycie docelowe (w procentach na 100) autoskalator powinien podjąć próbę utrzymania dla tej usługi sieci Web

Domyślna wartość: None
collect_model_data
bool

Włączanie lub wyłączanie zbierania danych modelu dla tej usługi sieci Web

Domyślna wartość: None
auth_enabled
bool

Czy włączyć uwierzytelnianie dla tej usługi sieci Web

Domyślna wartość: None
cpu_cores
float

Liczba rdzeni procesora, które mają być przydzielane dla tej usługi sieci Web. Może być dziesiętnym

Domyślna wartość: None
memory_gb
float

Ilość pamięci (w GB), która ma być przydzielana dla tej usługi sieci Web. Może być dziesiętnym

Domyślna wartość: None
enable_app_insights
bool

Czy włączyć rejestrowanie usługi Application Insights dla tej usługi sieci Web

Domyślna wartość: None
scoring_timeout_ms
int

Limit czasu wymuszania wywołań oceniania dla tej usługi sieci Web

Domyślna wartość: None
replica_max_concurrent_requests
int

Liczba maksymalnie współbieżnych żądań na replikę, która umożliwia korzystanie z tej usługi sieci Web.

Domyślna wartość: None
max_request_wait_time
int

Maksymalny czas, przez jaki żądanie pozostanie w kolejce (w milisekundach) przed zwróceniem błędu 503

Domyślna wartość: None
num_replicas
int

Liczba kontenerów do przydzielenia dla tej usługi sieci Web

Domyślna wartość: None
tags
dict[str, str]

Słownik tagów wartości klucza, aby nadać tej usłudze sieci Web. Zastąpi istniejące tagi.

Domyślna wartość: None
properties
dict[str, str]

Słownik właściwości wartości klucza do dodania do istniejącego słownika właściwości

Domyślna wartość: None
description
str

Opis umożliwiający nadanie tej usłudze sieci Web

Domyślna wartość: None
models
list[Model]

Lista obiektów modelu do spakowania za pomocą zaktualizowanej usługi

Domyślna wartość: None
inference_config
InferenceConfig

Obiekt InferenceConfig używany do udostępniania wymaganych właściwości wdrożenia modelu.

Domyślna wartość: None
gpu_cores
int

Liczba rdzeni procesora GPU do przydzielenia dla tej usługi sieci Web

Domyślna wartość: None
period_seconds
int

Jak często (w sekundach) wykonać sondę liveness. Wartość domyślna to 10 sekund. Wartość minimalna to 1.

Domyślna wartość: None
initial_delay_seconds
int

Liczba sekund po uruchomieniu kontenera przed zainicjowanymi sondami aktualności.

Domyślna wartość: None
timeout_seconds
int

Liczba sekund, po których upłynął limit czasu sondy liveness. Wartość domyślna to 1 sekunda. Wartość minimalna to 1.

Domyślna wartość: None
success_threshold
int

Minimalna liczba kolejnych sukcesów dla sondy liveness, która ma zostać uznana za pomyślną po nieudanej awarii. Wartość domyślna to 1. Wartość minimalna to 1.

Domyślna wartość: None
failure_threshold
int

Po uruchomieniu zasobnika i niepowodzeniu sondy liveness platforma Kubernetes spróbuje użyć czasu niepowodzeniaThreshold przed rezygnacją. Wartość domyślna to 3. Wartość minimalna to 1.

Domyślna wartość: None
namespace
str

Przestrzeń nazw platformy Kubernetes, w której ma zostać wdrożona ta usługa sieci Web: do 63 małych liter alfanumeryczne ('a'-'z', '0'-'9') i łącznika ('-'). Pierwsze i ostatnie znaki nie mogą być łącznikami.

Domyślna wartość: None
token_auth_enabled
bool

Czy włączyć uwierzytelnianie tokenu dla tej usługi sieci Web. Jeśli ta opcja jest włączona, użytkownicy mogą uzyskiwać dostęp do tej usługi sieci Web, pobierając token dostępu przy użyciu poświadczeń usługi Azure Active Directory. Wartości domyślne to False

Domyślna wartość: None
cpu_cores_limit
float

Maksymalna liczba rdzeni procesora cpu, z których może korzystać ta usługa sieci Web. Może to być liczba dziesiętna.

Domyślna wartość: None
memory_gb_limit
float

Maksymalna ilość pamięci (w GB) dozwolonej przez tę usługę sieci Web. Może to być liczba dziesiętna.

Domyślna wartość: None
kwargs
Wymagane
<xref:varies>

dołączanie parametrów do obsługi migrowania usługi internetowej AKS do punktu końcowego i wdrożenia online platformy Kubernetes. is_migration=True| False, compute_target=.

Wyjątki

Typ Opis
WebserviceException