LocalWebservice Класс
Представляет модель машинного обучения, развернутую в качестве конечной точки локальной веб-службы.
Локальное развертывание веб-служб полезно в сценариях отладки и тестирования.
Конструктор локальной веб-службы.
Конструктор LocalWebservice используется для получения локального представления объекта LocalWebservice, связанного с предоставленной рабочей областью.
- Наследование
-
LocalWebservice
Конструктор
LocalWebservice(*args, **kwargs)
Параметры
Имя | Описание |
---|---|
workspace
Обязательно
|
Объект Workspace, содержащий любые объекты Model, которые будут извлечены. |
name
Обязательно
|
Имя объекта WebService, который необходимо извлечь. |
must_exist
Обязательно
|
Указывает, должен ли существовать объект WebService при создании объекта в памяти. |
workspace
Обязательно
|
Объект Workspace, содержащий любые объекты Model, которые будут извлечены. |
name
Обязательно
|
Имя извлекаемого объекта LocalWebservice. |
must_exist
Обязательно
|
Указывает, должен ли существовать объект WebService при создании объекта в памяти. |
Комментарии
В следующих примерах кода показано, как создать локальную веб-службу 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()
Полный пример можно найти по адресу: https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb
Методы
delete |
Удаление этого объекта LocalWebservice с локального компьютера. Этот вызов функции не является асинхронным; он выполняется до тех пор, пока служба не будет удалена. |
deploy_configuration |
Создание объекта конфигурации для развертывания локального объекта WebService. |
deploy_to_cloud |
Развертывание объекта WebService на основе конфигурации объекта LocalWebservice. |
deserialize |
Преобразование объекта JSON ответа службы Управления моделями в объект WebService. Примечание Не поддерживается для LocalWebservice. |
get_keys |
Получение ключей проверки подлинности для этого объекта WebService. Примечание Не поддерживается для LocalWebservice. |
get_logs |
Получение журналов для этого объекта LocalWebservice. |
get_token |
Получение маркера проверки подлинности для этого объекта WebService, действие которого распространяется только на текущего пользователя. Примечание Не поддерживается для LocalWebservice. |
list |
Список объектов LocalWebservice, связанных с соответствующим объектом Workspace. Возвращаемые результаты можно фильтровать с помощью параметров. |
regen_key |
Повторное создание одного из ключей объекта WebService. Примечание Не поддерживается для LocalWebservice. |
reload |
Перезагрузка скрипта выполнения объекта LocalWebservice и его зависимостей. Перезапуск контейнера службы с копиями обновленных ресурсов, включая скрипт выполнения и локальные зависимости без перестроения базового образа. Соответственно, изменения зависимостей Conda/PIP или настраиваемых шагов Docker не будут отражены в перезагруженном объекте LocalWebservice. Для обработки этих изменений вызовите метод update. |
run |
Вызов этого объекта LocalWebservice с помощью предоставленных входных данных. |
serialize |
Преобразование этого объекта WebService в сериализованный словарь 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
Обязательно
|
Следует ли удалять временные файлы, кэшированные для службы. (Значение по умолчанию — True.) |
delete_image
Обязательно
|
Указывает, следует ли удалить образ Docker службы. (Значение по умолчанию: False) |
delete_volume
Обязательно
|
Указывает, следует ли удалить том Docker службы. (Значение по умолчанию — True.) |
Исключения
Тип | Описание |
---|---|
deploy_configuration
Создание объекта конфигурации для развертывания локального объекта WebService.
static deploy_configuration(port=None)
Параметры
Имя | Описание |
---|---|
port
|
Локальный порт, на который будет предоставляться конечная точка HTTP службы. Default value: None
|
Возвращаемое значение
Тип | Описание |
---|---|
Объект конфигурации, используемый при развертывании объекта WebService. |
Исключения
Тип | Описание |
---|---|
deploy_to_cloud
Развертывание объекта WebService на основе конфигурации объекта LocalWebservice.
deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)
Параметры
Имя | Описание |
---|---|
name
|
Имя для предоставления развернутой службы. Должно быть уникальным для рабочей области. Default value: None
|
deployment_config
|
Значение WebserviceDeploymentConfiguration, используемое для настройки веб-службы. Если оно не указано, будет использоваться пустой объект конфигурации, основанный на нужном целевом объекте. Default value: None
|
deployment_target
|
ComputeTarget, где будет развернут объект WebService. Поскольку ACI у нет связанного ComputeTarget, оставьте для этого параметра значение None, чтобы выполнить развертывание в ACI. Default value: None
|
Возвращаемое значение
Тип | Описание |
---|---|
Объект веб-службы, соответствующий развернутой веб-службе. |
Исключения
Тип | Описание |
---|---|
deserialize
Преобразование объекта JSON ответа службы Управления моделями в объект WebService.
Примечание
Не поддерживается для LocalWebservice.
deserialize(workspace, webservice_payload)
Параметры
Имя | Описание |
---|---|
cls
Обязательно
|
|
workspace
Обязательно
|
Объект рабочей области, в котором зарегистрирован объект WebService. |
webservice_payload
Обязательно
|
Объект JSON для преобразования в объект WebService. |
Исключения
Тип | Описание |
---|---|
azureml.exceptions.NotImplementedError
|
get_keys
Получение ключей проверки подлинности для этого объекта WebService.
Примечание
Не поддерживается для LocalWebservice.
get_keys()
Возвращаемое значение
Тип | Описание |
---|---|
Ключи проверки подлинности для этого объекта WebService. |
Исключения
Тип | Описание |
---|---|
azureml.exceptions.NotImplementedError
|
get_logs
Получение журналов для этого объекта LocalWebservice.
get_logs(num_lines=5000, raw=False)
Параметры
Имя | Описание |
---|---|
num_lines
Обязательно
|
Максимальное число извлекаемых строк журнала. (По умолчанию: 5000.) |
raw
Обязательно
|
Возвращает выходные данные необработанного контейнера Docker без попытки его отформатировать. (Значение по умолчанию: False) |
Возвращаемое значение
Тип | Описание |
---|---|
Журналы для этого объекта LocalWebservice. |
Исключения
Тип | Описание |
---|---|
get_token
Получение маркера проверки подлинности для этого объекта WebService, действие которого распространяется только на текущего пользователя.
Примечание
Не поддерживается для LocalWebservice.
get_token()
Возвращаемое значение
Тип | Описание |
---|---|
Маркер проверки подлинности для этого объекта WebService и время его последующего обновления. |
Исключения
Тип | Описание |
---|---|
azureml.exceptions.NotImplementedError
|
list
Список объектов LocalWebservice, связанных с соответствующим объектом Workspace.
Возвращаемые результаты можно фильтровать с помощью параметров.
static list(workspace, model_name=None, model_id=None, all=None)
Параметры
Имя | Описание |
---|---|
workspace
Обязательно
|
Объект Workspace, связанный с объектами LocalWebservice. |
model_name
|
Фильтрация списка для включения только тех объектов LocalWebservice, которые были развернуты с использованием указанного имени модели. Default value: None
|
model_id
|
Фильтрация списка для включения только тех объектов LocalWebservice, которые были развернуты с использованием указанного идентификатора модели. Default value: None
|
all
|
Отображение всех служб. По умолчанию отображаются только выполняющиеся службы. Default value: None
|
Возвращаемое значение
Тип | Описание |
---|---|
Отфильтрованный список объектов LocalWebservice, связанный с указанным объектом Workspace. |
Исключения
Тип | Описание |
---|---|
regen_key
Повторное создание одного из ключей объекта WebService.
Примечание
Не поддерживается для LocalWebservice.
regen_key(key)
Параметры
Имя | Описание |
---|---|
key
Обязательно
|
Ключ для повторного создания. Возможные варианты: "Primary" или "Secondary". |
Исключения
Тип | Описание |
---|---|
reload
Перезагрузка скрипта выполнения объекта LocalWebservice и его зависимостей.
Перезапуск контейнера службы с копиями обновленных ресурсов, включая скрипт выполнения и локальные зависимости без перестроения базового образа. Соответственно, изменения зависимостей Conda/PIP или настраиваемых шагов Docker не будут отражены в перезагруженном объекте LocalWebservice. Для обработки этих изменений вызовите метод update.
reload(wait=False)
Параметры
Имя | Описание |
---|---|
wait
Обязательно
|
Ожидание достижения контейнером службы работоспособного состояния. (Значение по умолчанию: False) |
Исключения
Тип | Описание |
---|---|
run
Вызов этого объекта LocalWebservice с помощью предоставленных входных данных.
run(input_data)
Параметры
Имя | Описание |
---|---|
input_data
Обязательно
|
<xref:varies>
Входные данные, с помощью которых вызывается объект LocalWebservice. |
Возвращаемое значение
Тип | Описание |
---|---|
<xref:varies>
|
Результат вызова объекта LocalWebservice. |
Исключения
Тип | Описание |
---|---|
serialize
Преобразование этого объекта WebService в сериализованный словарь JSON.
serialize()
Возвращаемое значение
Тип | Описание |
---|---|
Сериализованное представление объекта WebService. |
Исключения
Тип | Описание |
---|---|
update
Обновление объекта LocalWebservice с использованием предоставленных свойств.
Оставленные значения None будут отображаться в этом объекте LocalWebservice без изменений.
update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)
Параметры
Имя | Описание |
---|---|
models
Обязательно
|
Новый список моделей, содержащихся в объекте LocalWebservice. |
image_config
Обязательно
|
Параметры конфигурации образа, применяемые к LocalWebservice. |
deployment_config
Обязательно
|
Параметры конфигурации развертывания, применяемые к LocalWebservice. |
inference_config
Обязательно
|
Объект InferenceConfig, используемый для предоставления требуемых свойств развертывания модели. |
wait
Обязательно
|
Ожидание достижения контейнером службы работоспособного состояния. (Значение по умолчанию: False) |
Возвращаемое значение
Тип | Описание |
---|---|
Исключения
Тип | Описание |
---|---|
update_deployment_state
Обновление текущего состояния объекта в памяти.
Обновление свойств объекта на месте на основе текущего состояния соответствующего локального контейнера Docker.
update_deployment_state(must_exist=False)
Параметры
Имя | Описание |
---|---|
must_exist
|
Указывает, должен ли существовать объект WebService при создании объекта в памяти. Default value: False
|
Исключения
Тип | Описание |
---|---|
wait_for_deployment
Опрос выполняющегося развертывания LocalWebservice.
wait_for_deployment(show_output=False)
Параметры
Имя | Описание |
---|---|
show_output
Обязательно
|
Параметр для печати более подробных выходных данных. (Значение по умолчанию: False) |
Исключения
Тип | Описание |
---|---|
Атрибуты
port
scoring_uri
Получение URI оценки локального объекта WebService.
Возвращаемое значение
Тип | Описание |
---|---|
Универсальный код ресурса (URI) оценки. |
swagger_uri
Получение идентификатора URI Swagger локального объекта WebService.
Возвращаемое значение
Тип | Описание |
---|---|
Универсальный код ресурса (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'