LocalWebservice Класс

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

Развертывание веб-служб локально полезно для отладки и тестирования сценариев.

Конструктор локальной веб-службы.

Конструктор LocalWebservice используется для получения локального представления объекта LocalWebservice, связанного с предоставленной рабочей областью.

Конструктор

LocalWebservice(*args, **kwargs)

Параметры

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

Комментарии

В следующих примерах кода показано, как создать локальную веб-службу Docker. Дополнительные сведения см. по ссылке записной книжки.

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

Методы

delete	Удалите эту службу LocalWebservice с локального компьютера. Этот вызов функции не является асинхронным; он запускается, пока служба не будет удалена.
deploy_configuration	Создайте объект конфигурации для развертывания локальной веб-службы.
deploy_to_cloud	Разверните веб-службу на основе конфигурации LocalWebservice.
deserialize	Преобразуйте объект JSON ответа службы управления моделями в объект webservice. Замечание Не поддерживается для LocalWebservice.
get_keys	Получение ключей проверки подлинности для этой веб-службы. Замечание Не поддерживается для LocalWebservice.
get_logs	Извлеките журналы для этой службы LocalWebservice.
get_token	Получение маркера проверки подлинности для этой веб-службы, заданного текущим пользователем. Замечание Не поддерживается для LocalWebservice.
list	Список служб LocalWebservices, связанных с соответствующей рабочей областью. Возвращаемые результаты можно фильтровать с помощью параметров.
regen_key	Повторно создайте один из ключей веб-службы. Замечание Не поддерживается для LocalWebservice.
reload	Перезагрузите скрипт выполнения и зависимости LocalWebservice. Это перезапускает контейнер службы с копиями обновленных ресурсов, включая скрипт выполнения и локальные зависимости, но не перестраивает базовый образ. Соответственно, изменения зависимостей Conda/pip или пользовательские шаги Docker не будут отражены в перезагрузленной службе LocalWebservice. Чтобы обработать эти изменения, вместо этого вызовите update метод.
run	Вызовите эту службу LocalWebservice с предоставленными входными данными.
serialize	Преобразуйте этот объект веб-службы в сериализованный в json-сериализованный словарь.
update	Обновите localWebservice с предоставленными свойствами. Значения, оставленные как None, останутся неизменными в этой службе LocalWebservice.
update_deployment_state	Обновите текущее состояние объекта в памяти. Выполните обновление на месте свойств объекта на основе текущего состояния соответствующего локального контейнера Docker.
wait_for_deployment	Опрос выполняющихся развертываний LocalWebservice.

delete

Удалите эту службу LocalWebservice с локального компьютера.

Этот вызов функции не является асинхронным; он запускается, пока служба не будет удалена.

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

Параметры

Имя	Описание
delete_cache Обязательно	bool Следует ли удалять временные файлы, кэшированные для службы. (по умолчанию: true)
delete_image Обязательно	bool Удаление образа Docker службы. (Значение по умолчанию: False)
delete_volume Обязательно	bool Удаление тома Docker службы. (по умолчанию: true)

Исключения

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

deploy_configuration

Создайте объект конфигурации для развертывания локальной веб-службы.

static deploy_configuration(port=None)

Параметры

Имя	Описание
port	int Локальный порт, на который будет предоставляться конечная точка HTTP службы. Default value: None

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

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

Исключения

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

deploy_to_cloud

Разверните веб-службу на основе конфигурации LocalWebservice.

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

Параметры

Имя	Описание
name	str Имя для предоставления развернутой службы. Должен быть уникальным для рабочей области. Default value: None
deployment_config	WebserviceDeploymentConfiguration Служба WebserviceDeploymentConfiguration, используемая для настройки веб-службы. Если он не указан, пустой объект конфигурации будет использоваться на основе требуемого целевого объекта. Default value: None
deployment_target	ComputeTarget A ComputeTarget , в который необходимо развернуть веб-службу. Так как ACI не связан ComputeTarget, оставьте этот параметр как None для развертывания в ACI. Default value: None

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

Тип	Описание
Webservice	Объект веб-службы, соответствующий развернутой веб-службе.

Исключения

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

deserialize

Преобразуйте объект JSON ответа службы управления моделями в объект webservice.

Замечание

Не поддерживается для LocalWebservice.

deserialize(workspace, webservice_payload)

Параметры

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

Исключения

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

get_keys

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

Замечание

Не поддерживается для LocalWebservice.

get_keys()

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

Тип	Описание
	Ключи проверки подлинности для этой веб-службы.

Исключения

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

get_logs

Извлеките журналы для этой службы LocalWebservice.

get_logs(num_lines=5000, raw=False)

Параметры

Имя	Описание
num_lines Обязательно	int Максимальное количество строк журнала для получения. (По умолчанию: 5000)
raw Обязательно	bool Возвращает необработанные выходные данные контейнера Docker без попытки отформатировать его. (Значение по умолчанию: False)

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

Тип	Описание
str	Журналы для этой службы LocalWebservice.

Исключения

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

get_token

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

Замечание

Не поддерживается для LocalWebservice.

get_token()

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

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

Исключения

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

list

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

Возвращаемые результаты можно фильтровать с помощью параметров.

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

Параметры

Имя	Описание
workspace Обязательно	Workspace Объект Workspace, связанный с localWebservices.
model_name	str Список фильтров для включения только LocalWebservices, развернутых с определенным именем модели. Default value: None
model_id	str Список фильтров для включения только LocalWebservices, развернутых с определенным идентификатором модели. Default value: None
all	bool Показать все службы. По умолчанию отображаются только запущенные службы. Default value: None

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

Тип	Описание
list[LocalWebservice]	Отфильтрованный список служб LocalWebservices, связанных с предоставленной рабочей областью.

Исключения

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

regen_key

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

Замечание

Не поддерживается для LocalWebservice.

regen_key(key)

Параметры

Имя	Описание
key Обязательно	str Какой ключ необходимо повторно создать. Параметры : "Основной" или "Вторичный"

Исключения

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

reload

Перезагрузите скрипт выполнения и зависимости LocalWebservice.

Это перезапускает контейнер службы с копиями обновленных ресурсов, включая скрипт выполнения и локальные зависимости, но не перестраивает базовый образ. Соответственно, изменения зависимостей Conda/pip или пользовательские шаги Docker не будут отражены в перезагрузленной службе LocalWebservice. Чтобы обработать эти изменения, вместо этого вызовите update метод.

reload(wait=False)

Параметры

Имя	Описание
wait Обязательно	bool Подождите, пока контейнер службы достигнет работоспособного состояния. (Значение по умолчанию: False)

Исключения

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

run

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

run(input_data)

Параметры

Имя	Описание
input_data Обязательно	<xref:varies> Входные данные, с помощью которых необходимо вызвать LocalWebservice.

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

Тип	Описание
<xref:varies>	Результат вызова LocalWebservice.

Исключения

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

serialize

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

serialize()

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

Тип	Описание
dict	Сериализованное представление объекта веб-службы.

update

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

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

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

Параметры

Имя	Описание
models Обязательно	list[Model] Новый список моделей, содержащихся в LocalWebservice.
image_config Обязательно	ContainerImageConfig Параметры конфигурации образа для применения к LocalWebservice.
deployment_config Обязательно	LocalWebserviceDeploymentConfiguration Параметры конфигурации развертывания для применения к LocalWebservice.
inference_config Обязательно	InferenceConfig Объект InferenceConfig, используемый для предоставления необходимых свойств развертывания модели.
wait Обязательно	bool Подождите, пока контейнер службы достигнет работоспособного состояния. (Значение по умолчанию: False)

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

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

Исключения

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

update_deployment_state

Обновите текущее состояние объекта в памяти.

Выполните обновление на месте свойств объекта на основе текущего состояния соответствующего локального контейнера Docker.

update_deployment_state(must_exist=False)

Параметры

Имя	Описание
must_exist	bool Должна ли веб-служба уже существовать при создании объекта в памяти. Default value: False

wait_for_deployment

Опрос выполняющихся развертываний LocalWebservice.

wait_for_deployment(show_output=False)

Параметры

Имя	Описание
show_output Обязательно	bool Параметр для печати более подробных выходных данных. (Значение по умолчанию: False)

Исключения

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

Атрибуты

port

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

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

Тип	Описание
int	Номер порта.

scoring_uri

URI оценки локальной веб-службы.

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

Тип	Описание
str	URI оценки.

swagger_uri

URI локальной веб-службы Swagger.

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

Тип	Описание
str	Универсальный код ресурса (URI 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'