gcp_mlengine_version – Создаёт версию GCP
Новая в версии 2.9.
Описание
- Каждая версия — это обученная модель, развернутая в облаке и готовая обрабатывать запросы предсказания. Одна модель может иметь несколько версий.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| auto_scaling словарь | Автоматически масштабирует количество узлов, используемых для предоставления модели, в ответ на увеличение и уменьшение трафика. Следует с осторожностью увеличивать трафик в соответствии со способностью модели к масштабированию, иначе могут увеличиться задержка и коды ответов 429. | ||
| min_nodes целое число | Минимальное количество узлов для выделения для этой модели. | ||
| deployment_uri строка / обязательно | Расположение на Cloud Storage обученной модели, используемой для создания версии. | ||
| description строка | Описание, указанное для версии при её создании. | ||
| env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это только изменяет строку User-Agent для всех запросов к API. | ||
| framework строка | Фреймворк машинного обучения, который AI Platform использует для обучения этой версии модели. Некоторые допустимые значения: "FRAMEWORK_UNSPECIFIED", "TENSORFLOW", "SCIKIT_LEARN", "XGBOOST" | ||
| is_default логическое значение |
| Если значение true, эта версия будет использоваться для обработки запросов предсказания, которые не указывают версию. псевдонимы: default | |
| labels словарь | Один или несколько тегов, которые можно добавить для организации версий вашей модели. | ||
| machine_type строка | Тип машины, на которой должна предоставляться модель. В настоящее время относится только к онлайн-службе предсказания. Некоторые допустимые значения: "mls1-c1-m2", "mls1-c4-m2" | ||
| manual_scaling словарь | Вручную выбирается количество узлов, используемых для предоставления модели. Обычно следует использовать автомасштабирование с соответствующим minNodes, но этот параметр доступен, если вы хотите более предсказуемые расходы. Имейте в виду, что задержка и ошибки увеличатся, если трафик превысит возможности системы по предоставлению его в соответствии с выбранным количеством узлов. | ||
| nodes целое число | Количество узлов для выделения для этой модели. Эти узлы всегда активны, начиная с момента развертывания модели. | ||
| model словарь / обязательно | Модель, к которой принадлежит эта версия. Это поле представляет ссылку на ресурс модели в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_mlengine_model и затем установить это поле модели в "{{ name-of-resource }}" | ||
| name строка / обязательно | Имя, заданное для версии при её создании. Имя версии должно быть уникальным внутри модели, в которой оно создается. | ||
| prediction_class строка | Полное квалифицированное имя (module_name.class_name) класса, реализующего интерфейс Predictor, описанный в этом справочном поле. Модуль, содержащий этот класс, должен быть включён в пакет, предоставленный в поле packageUris. | ||
| project строка | Проект Google Cloud Platform, который нужно использовать. | ||
| python_version строка | Версия Python, используемая в предсказании. Если не задано, используется версия по умолчанию '2.7'. Версия Python '3.5' доступна, когда runtimeVersion установлена на '1.4' и выше. Python '2.7' работает со всеми поддерживаемыми версиями runtime. Некоторые допустимые значения: "2.7", "3.5" | ||
| runtime_version строка | Версия runtime AI Platform, которую нужно использовать для этого развертывания. | ||
| scopes список | Массив используемых областей видимости. | ||
| service_account строка | Указывает учетную запись службы для управления доступом к ресурсам. | ||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как JSON-строка, представляющая его. | ||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. | ||
| state строка |
| Существует ли указанный объект в GCP | |
Примечания
Примечание
- для аутентификации можно установить service_account_file с использованием переменной среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents с использованием переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email с использованием переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с использованием переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с использованием переменной среды
GCP_SCOPES. - значения переменных среды будут использоваться только в том случае, если значения в плейбуке не установлены.
- параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a model
gcp_mlengine_model:
name: model_version
description: My model
regions:
- us-central1
online_prediction_logging: 'true'
online_prediction_console_logging: 'true'
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: model
- name: create a version
gcp_mlengine_version:
name: "{{ resource_name | replace('-', '_') }}"
model: "{{ model }}"
runtime_version: 1.13
python_version: 3.5
is_default: 'true'
deployment_uri: gs://ansible-cloudml-bucket/
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — это поля, уникальные для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| autoScaling complex | success | Автоматически масштабирует количество узлов, используемых для обслуживания модели в ответ на увеличение и уменьшение трафика. Следует проявлять осторожность, увеличивая трафик в соответствии со способностью модели к масштабированию, иначе вы начнете замечать увеличение задержек и коды ответов 429. | |
| minNodes integer | success | Минимальное количество узлов для выделения в этом режиме. | |
| createTime string | success | Время создания версии. | |
| deploymentUri string | success | Расположение в Cloud Storage обученной модели, используемой для создания версии. | |
| description string | success | Описание, указанное для версии при ее создании. | |
| errorMessage string | success | Подробности сбоя или отмены. | |
| framework string | success | Фреймворк машинного обучения, используемый AI Platform для обучения этой версии модели. | |
| isDefault boolean | success | Если true, эта версия будет использоваться для обработки запросов предсказания, в которых не указана версия. | |
| labels dictionary | success | Один или несколько тегов, которые можно добавить для организации ваших версий моделей. | |
| lastUseTime string | success | Время последнего использования версии для предсказания. | |
| machineType string | success | Тип машины, на которой нужно обслуживать модель. В настоящее время относится только к онлайн-службе предсказания. | |
| manualScaling complex | success | Вручную выбирается количество узлов для использования при обслуживании модели. В целом, следует использовать autoScaling с соответствующим minNodes, но этот вариант доступен, если вам нужно более предсказуемое выставление счетов. Имейте в виду, что задержка и частота ошибок возрастут, если трафик превысит возможности системы по его обслуживанию на основе выбранного количества узлов. | |
| nodes integer | success | Количество узлов для выделения для этой модели. Эти узлы всегда активны, начиная с момента развертывания модели. | |
| model dictionary | success | Модель, к которой принадлежит эта версия. | |
| name string | success | Имя, указанное для версии при ее создании. Имя версии должно быть уникальным в рамках модели, в которой оно создается. | |
| packageUris list | success | Пути к облачным хранилищам (gs://…) пакетов для пользовательских процедур предсказания или scikit-learn конвейеров с пользовательским кодом. | |
| predictionClass string | success | Полное имя (имя_модуля.имя_класса) класса, реализующего интерфейс Predictor, описанный в этом поле справки. Модуль, содержащий этот класс, должен быть включен в пакет, предоставленный в поле packageUris. | |
| pythonVersion string | success | Версия Python, используемая в предсказании. Если не задано, используется версия по умолчанию '2.7'. Python '3.5' доступен, когда runtimeVersion установлен на '1.4' и выше. Python '2.7' работает со всеми поддерживаемыми версиями runtime. | |
| runtimeVersion string | success | Версия runtime AI Platform, которую следует использовать для этого развертывания. | |
| serviceAccount string | success | Указывает учетную запись сервиса для контроля доступа к ресурсам. | |
| state string | success | Состояние версии. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_mlengine_version_module.html
