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

AciWebservice Класс

  • Ссылка

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

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

Дополнительные сведения см. в статье Развертывание модели в экземплярах контейнеров Azure.

Инициализируйте экземпляр Webservice.

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

Наследование
Webservice
AciWebservice

Конструктор

AciWebservice(workspace, name)

Параметры

Имя Описание
workspace
Обязательно
Workspace

Объект рабочей области, содержащий извлекаемый объект Webservice.
name
Обязательно
str

Имя объекта WebService, который необходимо извлечь.

Комментарии

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


   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)

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

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

  • Метод deploy_from_image класса Webservice.

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

  • Метод deploy класса Webservice, который будет регистрировать модель и создавать образ.

См. сведения о работе с объектами WebService:

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

Переменные

Имя Описание
enable_app_insights
bool

Указывает, включено ли ведение журнала AppInsights для веб-службы.
cname
str

CNAME для веб-службы.
container_resource_requirements
ContainerResourceRequirements

Требования к ресурсам контейнера для веб-службы.
encryption_properties
EncryptionProperties

Свойства шифрования для веб-службы.
vnet_configuration
VnetConfiguration

Свойства виртуальной сети для веб-службы; конфигурация должна быть создана и предоставлена пользователем.
azureml.core.webservice.AciWebservice.location
str

Расположение, в котором развернута веб-служба.
public_ip
str

Общедоступный IP-адрес веб-службы.
azureml.core.webservice.AciWebservice.scoring_uri
str

Конечная точка оценки для веб-службы
ssl_enabled
bool

Включен ли протокол SSL для веб-службы
public_fqdn
str

Общедоступное FQDN для веб-службы
environment
Environment

Объект среды, который использовался для создания веб-службы
azureml.core.webservice.AciWebservice.models
list[Model]

Список моделей, развернутых для веб-службы
azureml.core.webservice.AciWebservice.swagger_uri
str

Конечная точка Swagger для веб-службы

Методы

add_properties

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

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

Создает объект конфигурации для развертывания AciWebservice.
get_token

Получение маркера проверки подлинности для этого объекта WebService, действие которого распространяется только на текущего пользователя.

Примечание

Не реализован.
remove_tags

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

Вызов этой веб-службы с помощью предоставленных входных данных.
serialize

Преобразует этот объект WebService в сериализованный словарь JSON.
update

Обновляет веб-службу с помощью предоставленных свойств.

Оставленные значения None будут отображаться в этой веб-службе без изменений.

add_properties

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

add_properties(properties)

Параметры

Имя Описание
properties
Обязательно
dict[str, str]

Словарь свойств для добавления.

add_tags

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

add_tags(tags)

Параметры

Имя Описание
tags
Обязательно
dict[str, str]

Словарь тегов для добавления.

Исключения

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

deploy_configuration

Создает объект конфигурации для развертывания AciWebservice.

static deploy_configuration(cpu_cores=None, memory_gb=None, tags=None, properties=None, description=None, location=None, auth_enabled=None, ssl_enabled=None, enable_app_insights=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, dns_name_label=None, primary_key=None, secondary_key=None, collect_model_data=None, cmk_vault_base_url=None, cmk_key_name=None, cmk_key_version=None, vnet_name=None, subnet_name=None)

Параметры

Имя Описание
cpu_cores
float

Количество ядер ЦП, выделяемых для этого объекта WebService. Может выражаться десятичным числом. Значение по умолчанию — 0,1

Default value: None
memory_gb
float

Объем памяти (в ГБ), выделяемой для этого объекта WebService. Может выражаться десятичным числом. Значение по умолчанию — 0,5

Default value: None
tags
dict[str, str]

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

Default value: None
properties
dict[str, str]

Словарь свойств значений ключа для предоставления этой веб-службе. Эти свойства нельзя изменить после развертывания, однако можно добавить новые пары "ключ-значение".

Default value: None
description
str

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

Default value: None
location
str

Регион Azure для развертывания этой веб-службы. Если не указать, будет использоваться расположение рабочей области. Дополнительные сведения о доступных регионах приведены в статье Продукты по регионам.

Default value: None
auth_enabled
bool

Указывает, следует ли включить проверку подлинности для этой веб-службы. Значение по умолчанию — False.

Default value: None
ssl_enabled
bool

Указывает, следует ли включить SSL для этой веб-службы. Значение по умолчанию — False.

Default value: None
enable_app_insights
bool

Указывает, следует ли включить AppInsights для этой веб-службы. Значение по умолчанию — False.

Default value: None
ssl_cert_pem_file
str

Файл сертификата, необходимый при включенном SSL.

Default value: None
ssl_key_pem_file
str

Файл ключа, необходимый при включенном SSL.

Default value: None
ssl_cname
str

CNAME, необходимый при включенном SSL.

Default value: None
dns_name_label
str

Метка DNS-имени для конечной точки оценки. Если она не указана, для данной конечной точки оценки будет создана уникальная метка DNS-имени.

Default value: None
primary_key
str

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

Default value: None
secondary_key
str

Вторичный ключ проверки подлинности, используемый для этой веб-службы.

Default value: None
collect_model_data
bool

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

Default value: None
cmk_vault_base_url
str

базовый URL-адрес хранилища ключей, управляемого клиентом

Default value: None
cmk_key_name
str

имя ключа, управляемого клиентом.

Default value: None
cmk_key_version
str

версия ключа, управляемого клиентом.

Default value: None
vnet_name
str

имя виртуальной сети.

Default value: None
subnet_name
str

имя подсети в виртуальной сети.

Default value: None

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

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

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

Исключения

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

get_token

Получение маркера проверки подлинности для этого объекта WebService, действие которого распространяется только на текущего пользователя.

Примечание

Не реализован.

get_token()

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

Тип Описание
str, datetime

Маркер проверки подлинности для этой веб-службы и время его последующего обновления.

Исключения

Тип Описание
azureml.exceptions.NotImplementedError

remove_tags

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

remove_tags(tags)

Параметры

Имя Описание
tags
Обязательно
list[str]

Список ключей для удаления.

run

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

run(input_data)

Параметры

Имя Описание
input_data
Обязательно
<xref:varies>

Входные данные для вызова веб-службы.

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

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

Результат вызова Вебслужбы.

Исключения

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

serialize

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

serialize()

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

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

Представление JSON этого объекта веб-службы.

update

Обновляет веб-службу с помощью предоставленных свойств.

Оставленные значения None будут отображаться в этой веб-службе без изменений.

update(image=None, tags=None, properties=None, description=None, auth_enabled=None, ssl_enabled=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, enable_app_insights=None, models=None, inference_config=None)

Параметры

Имя Описание
image
Image

Новый образ для развертывания в веб-службе.

Default value: None
tags
dict[str, str]

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

Default value: None
properties
dict[str, str]

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

Default value: None
description
str

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

Default value: None
auth_enabled
bool

Позволяет включить аутентификацию для этой веб-службы.

Default value: None
ssl_enabled
bool

Указывает, следует ли включить SSL для этой веб-службы.

Default value: None
ssl_cert_pem_file
str

Файл сертификата, необходимый при включенном SSL.

Default value: None
ssl_key_pem_file
str

Файл ключа, необходимый при включенном SSL.

Default value: None
ssl_cname
str

CNAME, необходимый при включенном SSL.

Default value: None
enable_app_insights
bool

Указывает, следует ли включить AppInsights для этой веб-службы.

Default value: None
models
list[Model]

Список объектов модели для упаковки в обновленную службу.

Default value: None
inference_config
InferenceConfig

Объект InferenceConfig, используемый для предоставления требуемых свойств развертывания модели.

Default value: None

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

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