AksWebservice Класс

Представляет модель машинного обучения, развернутую в качестве конечной точки веб-службы в службе Azure Kubernetes.

Развернутая служба создается из модели, скрипта и связанных файлов. Полученная веб-служба — это конечная точка HTTP с балансировкой нагрузки с помощью REST API. Вы можете отправлять данные в этот API и получать прогноз, возвращаемый моделью.

AksWebservice развертывает одну службу в одну конечную точку. Чтобы развернуть несколько служб в одной конечной точке AksEndpoint , используйте класс.

Дополнительные сведения см. в статье "Развертывание модели в кластере службы Azure Kubernetes".

Инициализация экземпляра веб-службы.

Конструктор веб-службы получает облачное представление объекта веб-службы, связанного с предоставленной рабочей областью. Он вернет экземпляр дочернего класса, соответствующего конкретному типу извлеченного объекта веб-службы.

Конструктор

AksWebservice(workspace, name)

Параметры

Имя	Описание
workspace Обязательно	Workspace Объект рабочей области, содержащий объект веб-службы для извлечения.
name Обязательно	str Имя извлекаемого объекта веб-службы.

Рекомендуемый шаблон развертывания — создать объект конфигурации развертывания с deploy_configuration методом, а затем использовать его с deploy методом Model класса, как показано ниже.


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

Существует несколько способов развертывания модели в качестве веб-службы, в том числе с помощью следующих способов:

deploy Метод для моделей Model , уже зарегистрированных в рабочей области.
deploy_from_image Webserviceметод .
deploy_from_model Метод для моделей Webservice , уже зарегистрированных в рабочей области. Этот метод создаст изображение.
deploy Webserviceметод , который будет регистрировать модель и создавать изображение.

Сведения о работе с веб-службами см. в разделе

В разделе "Переменные" перечислены атрибуты локального представления объекта Cloud AksWebservice. Эти переменные должны рассматриваться только для чтения. Изменение их значений не будет отражено в соответствующем облачном объекте.

Переменные

Имя	Описание
enable_app_insights	bool Включена ли ведение журнала AppInsights для веб-службы.
autoscaler	AutoScaler Объект Автомасштабирования для веб-службы.
compute_name	str Имя ComputeTarget, в который развернута веб-служба.
container_resource_requirements	ContainerResourceRequirements Требования к ресурсу контейнера для веб-службы.
liveness_probe_requirements	LivenessProbeRequirements Требования к пробе активности для веб-службы.
data_collection	DataCollection Объект DataCollection для веб-службы.
max_concurrent_requests_per_container	int Максимальное количество одновременных запросов на контейнер для веб-службы.
max_request_wait_time	int Максимальное время ожидания запроса для веб-службы в миллисекундах.
num_replicas	int Количество реплик для веб-службы. Каждая реплика соответствует модулем POD AKS.
scoring_timeout_ms	int Время ожидания оценки для веб-службы в миллисекундах.
azureml.core.webservice.AksWebservice.scoring_uri	str Конечная точка оценки для веб-службы
is_default	bool Если веб-служба является версией по умолчанию для родительского aksEndpoint.
traffic_percentile	int Какой процент трафика для маршрутизации в веб-службу в родительском элементе AksEndpoint.
version_type	VersionType Тип версии веб-службы в родительском aksEndpoint.
token_auth_enabled	bool Включена ли проверка подлинности маркера для веб-службы.
environment	Environment Объект Среды, используемый для создания веб-службы.
azureml.core.webservice.AksWebservice.models	list[Model] Список моделей, развернутых в веб-службе.
deployment_status	str Состояние развертывания веб-службы.
namespace	str Пространство имен AKS веб-службы.
azureml.core.webservice.AksWebservice.swagger_uri	str Конечная точка swagger для веб-службы.

Методы

add_properties	Добавьте пары значений ключа в словарь свойств этой веб-службы.
add_tags	Добавьте пары значений ключа в словарь тегов веб-службы. WebserviceExceptionВызывает .
deploy_configuration	Создайте объект конфигурации для развертывания в целевом объекте вычислений AKS.
get_access_token	Получение маркера проверки подлинности для этой веб-службы.
get_token	УСТАРЕВШИЕ. Вместо этого используйте `get_access_token` метод. Получение маркера проверки подлинности для этой веб-службы.
remove_tags	Удалите указанные ключи из словаря тегов этой веб-службы.
run	Вызовите эту веб-службу с предоставленными входными данными.
serialize	Преобразуйте эту веб-службу в сериализованный словарь JSON.
update	Обновите веб-службу с предоставленными свойствами. Значения, оставленные как None, останутся неизменными в этой веб-службе.

add_properties

Добавьте пары значений ключа в словарь свойств этой веб-службы.

add_properties(properties)

Параметры

Имя	Описание
properties Обязательно	dict[str, str] Словарь добавляемых свойств.

add_tags

Добавьте пары значений ключа в словарь тегов веб-службы.

WebserviceExceptionВызывает .

add_tags(tags)

Параметры

Имя	Описание
tags Обязательно	dict[str, str] Словарь добавляемых тегов.

Исключения

Тип	Описание
WebserviceException

deploy_configuration

Создайте объект конфигурации для развертывания в целевом объекте вычислений 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)

Параметры

Имя	Описание
autoscale_enabled	bool Следует ли включить автоматическое масштабирование для этой веб-службы. По умолчанию значение True, если num_replicas — Нет. Default value: None
autoscale_min_replicas	int Минимальное количество контейнеров, используемых при автомасштабировании этой веб-службы. По умолчанию равен 1. Default value: None
autoscale_max_replicas	int Максимальное количество контейнеров, используемых при автомасштабировании этой веб-службы. Значение по умолчанию равно 10. Default value: None
autoscale_refresh_seconds	int Как часто автомасштабирование должно пытаться масштабировать эту веб-службу. По умолчанию равен 1. Default value: None
autoscale_target_utilization	int Целевое использование (в процентах от 100) автомасштабирование должно попытаться сохранить для этой веб-службы. Значение по умолчанию — 70. Default value: None
collect_model_data	bool Следует ли включить сбор данных модели для этой веб-службы. По умолчанию False. Default value: None
auth_enabled	bool Следует ли включить проверку подлинности ключа для этой веб-службы. Значение по умолчанию — True. Default value: None
cpu_cores	float Количество ядер ЦП, выделяемых для этой веб-службы. Может быть десятичным. Значение по умолчанию — 0.1. Соответствует запросу ядра pod, а не ограничению в службе Azure Kubernetes. Default value: None
memory_gb	float Объем памяти (в ГБ) для этой веб-службы. Может быть десятичным. Значение по умолчанию — 0.5. Соответствует запросу памяти pod, а не ограничению в службе Azure Kubernetes. Default value: None
enable_app_insights	bool Следует ли включить ведение журнала Application Insights для этой веб-службы. По умолчанию False. Default value: None
scoring_timeout_ms	int Время ожидания для принудительного применения вызовов оценки для этой веб-службы. По умолчанию — 60000. Default value: None
replica_max_concurrent_requests	int Максимальное число одновременных запросов на реплику для этой веб-службы. По умолчанию равен 1. Не изменяйте этот параметр с значения по умолчанию 1, если не указано технической поддержкой Майкрософт или членом группы машинного обучения Azure. Default value: None
max_request_wait_time	int Максимальное время, когда запрос останется в очереди (в миллисекундах), прежде чем возвращать ошибку 503. Значение по умолчанию — 500. Default value: None
num_replicas	int Количество контейнеров, выделяемых для этой веб-службы. Значение по умолчанию, если этот параметр не задан, автомасштабирование включается по умолчанию. Default value: None
primary_key	str Первичный ключ проверки подлинности, используемый для этой веб-службы. Default value: None
secondary_key	str Дополнительный ключ проверки подлинности, используемый для этой веб-службы. Default value: None
tags	dict[str, str] Словарь тегов значений ключа для предоставления этой веб-службы. Default value: None
properties	dict[str, str] Словарь свойств значений ключа для предоставления этой веб-службы. Эти свойства нельзя изменить после развертывания, однако можно добавить новые пары значений ключей. Default value: None
description	str Описание для предоставления этой веб-службы. Default value: None
gpu_cores	int Количество ядер GPU, выделяемых для этой веб-службы. Значение по умолчанию — 0. Default value: None
period_seconds	int Частота (в секундах) выполнения пробы активности. По умолчанию — 10 секунд. Минимальное значение равно 1. Default value: None
initial_delay_seconds	int Количество секунд после запуска контейнера до запуска проб активности. Значение по умолчанию — 310. Default value: None
timeout_seconds	int Количество секунд, после которого время ожидания пробы активности истекает. Значение по умолчанию — 2 секунды. Минимальное значение равно 1. Default value: None
success_threshold	int Минимальные последовательные успехи для пробы активности, которые будут считаться успешными после неудачи. По умолчанию равен 1. Минимальное значение равно 1. Default value: None
failure_threshold	int Количество попыток (failureThreshold), выполняемых Kubernetes, до их полного прекращения в случае запуска pod, но сбоя пробы активности. Значение по умолчанию — 3. Минимальное значение равно 1. Default value: None
namespace	str Пространство имен Kubernetes, в котором развертывается эта веб-служба: до 63 строчных буквенно-цифровых символов ('a'-'z", '0'-'9') и дефиса ('-') символов. Первые и последние символы не могут быть дефисами. Default value: None
token_auth_enabled	bool Следует ли включить проверку подлинности маркера для этой веб-службы. Если это включено, пользователи могут получить доступ к этой веб-службе, выбрав маркер доступа с помощью учетных данных Azure Active Directory. По умолчанию False. Default value: None
compute_target_name	str Имя целевого объекта вычислений для развертывания в Default value: None
cpu_cores_limit	float Максимальное количество ядер ЦП, которые могут использоваться веб-службой. Может быть десятичным. Default value: None
memory_gb_limit	float Максимальный объем памяти (в ГБ) этой веб-службы разрешено использовать. Может быть десятичным. Default value: None
blobfuse_enabled	bool Следует ли включить blobfuse для загрузки модели для этой веб-службы. Значение True по умолчанию Default value: None

Возвращаемое значение

Тип	Описание
AksServiceDeploymentConfiguration	Объект конфигурации, используемый при развертывании AksWebservice.

Исключения

Тип	Описание
WebserviceException

get_access_token

Получение маркера проверки подлинности для этой веб-службы.

get_access_token()

Возвращаемое значение

Тип	Описание
AksServiceAccessToken	Объект, описывающий маркер проверки подлинности для этой веб-службы.

Исключения

Тип	Описание
WebserviceException

get_token

УСТАРЕВШИЕ. Вместо этого используйте get_access_token метод.

Получение маркера проверки подлинности для этой веб-службы.

get_token()

Возвращаемое значение

Тип	Описание
str, datetime	Маркер проверки подлинности для этой веб-службы и когда его необходимо обновить.

Исключения

Тип	Описание
WebserviceException

remove_tags

Удалите указанные ключи из словаря тегов этой веб-службы.

remove_tags(tags)

Параметры

Имя	Описание
tags Обязательно	list[str] Список ключей для удаления

run

Вызовите эту веб-службу с предоставленными входными данными.

run(input_data)

Параметры

Имя	Описание
input_data Обязательно	<xref:varies> Входные данные для вызова веб-службы с

Возвращаемое значение

Тип	Описание
dict	Результат вызова веб-службы

Исключения

Тип	Описание
WebserviceException

serialize

Преобразуйте эту веб-службу в сериализованный словарь JSON.

serialize()

Возвращаемое значение

Тип	Описание
dict	Представление JSON этой веб-службы.

update

Обновите веб-службу с предоставленными свойствами.

Значения, оставленные как None, останутся неизменными в этой веб-службе.

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)

Параметры

Имя	Описание
image	Image Новый образ для развертывания в веб-службе Default value: None
autoscale_enabled	bool Включение или отключение автомасштабирования этой веб-службы Default value: None
autoscale_min_replicas	int Минимальное количество контейнеров, используемых при автомасштабировании этой веб-службы Default value: None
autoscale_max_replicas	int Максимальное количество контейнеров, используемых при автомасштабировании этой веб-службы Default value: None
autoscale_refresh_seconds	int Как часто автомасштабирование должно пытаться масштабировать эту веб-службу. Default value: None
autoscale_target_utilization	int Целевое использование (в процентах от 100) автомасштабирование должно попытаться сохранить для этой веб-службы. Default value: None
collect_model_data	bool Включение или отключение сбора данных модели для этой веб-службы Default value: None
auth_enabled	bool Включение проверки подлинности для этой веб-службы Default value: None
cpu_cores	float Количество ядер ЦП, выделяемых для этой веб-службы. Может быть десятичным Default value: None
memory_gb	float Объем памяти (в ГБ) для этой веб-службы. Может быть десятичным Default value: None
enable_app_insights	bool Включение ведения журнала Application Insights для этой веб-службы Default value: None
scoring_timeout_ms	int Время ожидания для принудительного выполнения вызовов оценки для этой веб-службы Default value: None
replica_max_concurrent_requests	int Максимальное число одновременных запросов на реплику для этой веб-службы. Default value: None
max_request_wait_time	int Максимальное время, когда запрос останется в очереди (в миллисекундах) перед возвратом ошибки 503 Default value: None
num_replicas	int Количество контейнеров, выделенных для этой веб-службы Default value: None
tags	dict[str, str] Словарь тегов значений ключа для предоставления этой веб-службы. Заменит существующие теги. Default value: None
properties	dict[str, str] Словарь свойств значения ключа для добавления в существующий словарь свойств Default value: None
description	str Описание для предоставления этой веб-службы Default value: None
models	list[Model] Список объектов модели для упаковки с обновленной службой Default value: None
inference_config	InferenceConfig Объект InferenceConfig, используемый для предоставления необходимых свойств развертывания модели. Default value: None
gpu_cores	int Количество ядер gpu, выделяемых для этой веб-службы Default value: None
period_seconds	int Частота (в секундах) выполнения пробы активности. По умолчанию — 10 секунд. Минимальное значение равно 1. Default value: None
initial_delay_seconds	int Количество секунд после запуска контейнера до запуска проб активности. Default value: None
timeout_seconds	int Количество секунд, после которого время ожидания пробы активности истекает. По умолчанию используется значение 1 секунды. Минимальное значение равно 1. Default value: None
success_threshold	int Минимальное число последовательных успешных попыток пробы активности после сбоя, после которых проба будет считаться успешной. По умолчанию равен 1. Минимальное значение равно 1. Default value: None
failure_threshold	int Количество попыток (failureThreshold), выполняемых Kubernetes, до их полного прекращения в случае запуска pod, но сбоя пробы активности. Значение по умолчанию — 3. Минимальное значение равно 1. Default value: None
namespace	str Пространство имен Kubernetes, в котором развертывается эта веб-служба: до 63 строчных буквенно-цифровых символов ('a'-'z", '0'-'9') и дефиса ('-') символов. Первые и последние символы не могут быть дефисами. Default value: None
token_auth_enabled	bool Следует ли включить проверку подлинности маркера для этой веб-службы. Если это включено, пользователи могут получить доступ к этой веб-службе, извлекая маркер доступа с помощью учетных данных Azure Active Directory. Значение по умолчанию — False. Default value: None
cpu_cores_limit	float Максимальное количество ядер ЦП, которые могут использоваться веб-службой. Может быть десятичным. Default value: None
memory_gb_limit	float Максимальный объем памяти (в ГБ) этой веб-службы разрешено использовать. Может быть десятичным. Default value: None
kwargs Обязательно	<xref:varies> включите парамы для поддержки миграции веб-службы AKS в конечную точку и развертывание Kubernetes в Сети. is_migration=True\|False, compute_target=<целевой объект вычислений с расширением AzureML, установленным для размещения перенесенной конечной точки и развертывания> Kubernetes online.

Исключения

Тип	Описание
WebserviceException

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

Конструктор

Параметры

Комментарии

Переменные

add_properties

Параметры

add_tags

Параметры

Исключения

deploy_configuration

Параметры

Возвращаемое значение

Исключения

get_access_token

Возвращаемое значение

Исключения

get_token

Возвращаемое значение

Исключения

remove_tags

Параметры

run

Параметры

Возвращаемое значение

Исключения

serialize

Возвращаемое значение

update

Параметры

Исключения