LocalWebservice Класс

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

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

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

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

Наследование
LocalWebservice

Конструктор

LocalWebservice(*args, **kwargs)

Параметры

workspace
Workspace
Обязательно

Объект Workspace, содержащий любые объекты Model, которые будут извлечены.

name
str
Обязательно

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

must_exist
bool
Обязательно

Указывает, должен ли существовать объект WebService при создании объекта в памяти.

workspace
Workspace
Обязательно

Объект Workspace, содержащий любые объекты Model, которые будут извлечены.

name
str
Обязательно

Имя извлекаемого объекта LocalWebservice.

must_exist
bool
Обязательно

Указывает, должен ли существовать объект 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
bool
Обязательно

Следует ли удалять временные файлы, кэшированные для службы. (Значение по умолчанию — True.)

delete_image
bool
Обязательно

Указывает, следует ли удалить образ Docker службы. (Значение по умолчанию: False)

delete_volume
bool
Обязательно

Указывает, следует ли удалить том Docker службы. (Значение по умолчанию — True.)

Исключения

deploy_configuration

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

static deploy_configuration(port=None)

Параметры

port
int
значение по умолчанию: None

Локальный порт, на который будет предоставляться конечная точка HTTP службы.

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

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

Возвращаемый тип

Исключения

deploy_to_cloud

Развертывание объекта WebService на основе конфигурации объекта LocalWebservice.

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

Параметры

name
str
значение по умолчанию: None

Имя для предоставления развернутой службы. Должно быть уникальным для рабочей области.

deployment_config
WebserviceDeploymentConfiguration
значение по умолчанию: None

Значение WebserviceDeploymentConfiguration, используемое для настройки веб-службы. Если оно не указано, будет использоваться пустой объект конфигурации, основанный на нужном целевом объекте.

deployment_target
ComputeTarget
значение по умолчанию: None

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

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

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

Возвращаемый тип

Исключения

deserialize

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

Примечание

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

deserialize(workspace, webservice_payload)

Параметры

cls
Обязательно
workspace
Workspace
Обязательно

Объект рабочей области, в котором зарегистрирован объект WebService.

webservice_payload
dict
Обязательно

Объект 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
int
Обязательно

Максимальное число извлекаемых строк журнала. (По умолчанию: 5000.)

raw
bool
Обязательно

Возвращает выходные данные необработанного контейнера Docker без попытки его отформатировать. (Значение по умолчанию: False)

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

Журналы для этого объекта LocalWebservice.

Возвращаемый тип

str

Исключения

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
Обязательно

Объект Workspace, связанный с объектами LocalWebservice.

model_name
str
значение по умолчанию: None

Фильтрация списка для включения только тех объектов LocalWebservice, которые были развернуты с использованием указанного имени модели.

model_id
str
значение по умолчанию: None

Фильтрация списка для включения только тех объектов LocalWebservice, которые были развернуты с использованием указанного идентификатора модели.

all
bool
значение по умолчанию: None

Отображение всех служб. По умолчанию отображаются только выполняющиеся службы.

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

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

Возвращаемый тип

Исключения

regen_key

Повторное создание одного из ключей объекта WebService.

Примечание

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

regen_key(key)

Параметры

key
str
Обязательно

Ключ для повторного создания. Возможные варианты: "Primary" или "Secondary".

Исключения

reload

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

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

reload(wait=False)

Параметры

wait
bool
Обязательно

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

Исключения

run

Вызов этого объекта LocalWebservice с помощью предоставленных входных данных.

run(input_data)

Параметры

input_data
<xref:varies>
Обязательно

Входные данные, с помощью которых вызывается объект LocalWebservice.

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

Результат вызова объекта LocalWebservice.

Возвращаемый тип

<xref:varies>

Исключения

serialize

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

serialize()

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

Сериализованное представление объекта WebService.

Возвращаемый тип

Исключения

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)

Возвращаемый тип

Исключения

update_deployment_state

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

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

update_deployment_state(must_exist=False)

Параметры

must_exist
bool
значение по умолчанию: False

Указывает, должен ли существовать объект WebService при создании объекта в памяти.

Исключения

wait_for_deployment

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

wait_for_deployment(show_output=False)

Параметры

show_output
bool
Обязательно

Параметр для печати более подробных выходных данных. (Значение по умолчанию: False)

Исключения

Атрибуты

port

Получение порта локального объекта WebService.

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

Номер порта.

Возвращаемый тип

int

scoring_uri

Получение URI оценки локального объекта WebService.

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

Универсальный код ресурса (URI) оценки.

Возвращаемый тип

str

swagger_uri

Получение идентификатора URI Swagger локального объекта WebService.

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

Универсальный код ресурса (URI) Swagger.

Возвращаемый тип

str

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'