google.cloud.gcp_mlengine_version – Создаёт версию GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_mlengine_version.
Обзор
- Каждая версия — это обученная модель, развернутая в облаке и готовая обрабатывать запросы на прогнозирование. Одна модель может иметь несколько версий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 словарь | Ручное определение количества узлов для предоставления модели. Обычно следует использовать autoScaling с соответствующим minNodes, но этот параметр доступен, если вам нужно более предсказуемое выставление счетов. Следует учитывать, что задержки и показатели ошибок возрастут, если трафик превысит возможности системы по обслуживанию на основе выбранного числа узлов. | ||
| nodes целое число | Количество узлов, выделяемых для данной модели. Эти узлы всегда активны с момента развертывания модели. | ||
| model словарь / обязательно | Модель, к которой относится данная версия. Это поле представляет ссылку на ресурс модели в GCP. Его можно указать двумя способами. Во-первых, можно поместить словарь с ключом 'name' и значением имени вашего ресурса. В качестве альтернативы вы можете добавить `register: имя_ресурса` в задачу gcp_mlengine_model и установить это поле модели на "{{ имя_ресурса }}" | ||
| name строка / обязательно | Имя, указанное для версии при её создании. Имя версии должно быть уникальным в рамках модели, в которой оно создаётся. | ||
| prediction_class строка | Полное квалифицированное имя (имя_модуля.имя_класса) класса, реализующего интерфейс 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 строка | Версия среды выполнения AI Platform для использования при этом развертывании. | ||
| scopes список / элементы=строка | Массив используемых областей. | ||
| service_account строка | Указывает учётную запись службы для контроля доступа к ресурсам. | ||
| service_account_contents jsonarg | Содержание файла JSON учётной записи службы, представленное либо в виде словаря, либо в виде строки JSON. | ||
| service_account_email строка | Необязательный адрес электронной почты учётной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учётной записи службы, если тип выбран как serviceaccount. | ||
| state строка |
| Нужно ли данному объекту существовать в GCP | |
Примеры
- name: create a model
google.cloud.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
google.cloud.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 сложный тип | успех | Автоматически масштабирует количество узлов, используемых для обработки модели, в ответ на увеличение и уменьшение трафика. Следует проявлять осторожность при наращивании трафика в соответствии со способностью модели к масштабированию, иначе вы начнете наблюдать увеличение задержки и коды ответов 429. | |
| minNodes целое число | успех | Минимальное количество узлов для выделения в этом режиме. | |
| createTime строка | успех | Время создания версии. | |
| deploymentUri строка | успех | Расположение в Cloud Storage обученной модели, используемой для создания версии. | |
| description строка | успех | Описание, указанное для версии при ее создании. | |
| errorMessage строка | успех | Подробности о сбое или отмене. | |
| framework строка | успех | Фреймворк машинного обучения, используемый AI Platform для обучения этой версии модели. | |
| isDefault булево | успех | Если true, эта версия будет использоваться для обработки запросов предсказания, которые не указывают версию. | |
| labels словарь | успех | Один или несколько меток, которые вы можете добавить для организации ваших версий моделей. | |
| lastUseTime строка | успех | Время последнего использования версии для предсказания. | |
| machineType строка | успех | Тип машины, на которой должна обрабатываться модель. В настоящее время применяется только к онлайн-службе предсказаний. | |
| manualScaling сложный тип | успех | Вручную выбирается количество узлов для обработки модели. В целом, следует использовать autoScaling с соответствующим minNodes, но этот вариант доступен, если вам нужен более предсказуемый расчет. Имейте в виду, что задержка и показатели ошибок увеличатся, если трафик превысит возможности системы по его обработке на основе выбранного количества узлов. | |
| nodes целое число | успех | Количество узлов, выделяемых для этой модели. Эти узлы всегда активны, начиная с момента развертывания модели. | |
| model словарь | успех | Модель, к которой принадлежит эта версия. | |
| name строка | успех | Имя, указанное для версии при ее создании. Имя версии должно быть уникальным в рамках модели, в которой оно создается. | |
| packageUris список / элементы=строка | успех | Пути в Cloud Storage (gs://…) пакетов для пользовательских процедур предсказания или scikit-learn конвейеров с пользовательским кодом. | |
| predictionClass строка | успех | Полное квалифицированное имя (имя_модуля.имя_класса) класса, реализующего интерфейс Predictor, описанный в этом поле справки. Модуль, содержащий этот класс, должен быть включен в пакет, предоставленный в поле packageUris. | |
| pythonVersion строка | успех | Версия Python, используемая для предсказания. Если не указано, используется версия по умолчанию '2.7'. Python '3.5' доступен, когда runtimeVersion установлен на '1.4' и выше. Python '2.7' работает со всеми поддерживаемыми версиями runtime. | |
| runtimeVersion строка | успех | Версия среды выполнения AI Platform, используемая для этого развертывания. | |
| serviceAccount строка | успех | Указывает учетную запись службы для контроля доступа к ресурсам. | |
| state строка | успех | Состояние версии. | |
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_mlengine_version_module.html
