google.cloud.gcp_mlengine_version 模块 – 创建 GCP 版本

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定：google.cloud.gcp_mlengine_version。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在未解决的健全性测试失败。有关更多信息，请参阅讨论主题。

概要 

每个版本都是部署在云中的已训练模型，可以处理预测请求。一个模型可以有多个版本。

要求 

执行此模块的主机需要以下要求。

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
auto_scaling 字典	根据流量的增减自动调整用于为模型提供服务的节点数量。应注意根据模型的扩展能力逐步增加流量，否则您将开始看到延迟增加和 429 响应代码。
min_nodes 整数	为此模式分配的最小节点数。
deployment_uri 字符串 / 必需	用于创建版本的已训练模型的 Cloud Storage 位置。
description 字符串	创建版本时指定的描述。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此值。这只会更改任何 API 请求的用户代理字符串。
framework 字符串	AI Platform 用于训练此模型版本的机器学习框架。一些有效的选项包括：“FRAMEWORK_UNSPECIFIED”、“TENSORFLOW”、“SCIKIT_LEARN”、“XGBOOST”
is_default 别名：default 布尔值	如果为 true，则此版本将用于处理未指定版本的预测请求。选项 `false` `true`
labels 字典	您可以添加的一个或多个标签，用于组织您的模型版本。
machine_type 字符串	用于为模型提供服务的机器类型。目前仅适用于在线预测服务。一些有效的选项包括：“mls1-c1-m2”、“mls1-c4-m2”
manual_scaling 字典	手动选择用于为模型提供服务的节点数。您通常应该使用带有适当 minNodes 的 autoScaling，但如果您想要更可预测的计费，则可以使用此选项。请注意，如果流量超过系统根据所选节点数提供服务的能力，则延迟和错误率会增加。
nodes 整数	为此模型分配的节点数。这些节点始终处于启动状态，从模型部署时开始。
model 字典 / 必需	此版本所属的模型。此字段表示指向 GCP 中模型资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为“name”且值为资源名称的字典。或者，您可以将 `register: name-of-resource` 添加到 gcp_mlengine_model 任务，然后将此模型字段设置为“{{ name-of-resource }}”
name 字符串 / 必需	创建版本时指定的名称。版本名称在创建它的模型中必须唯一。
prediction_class 字符串	实现此参考字段中描述的 Predictor 接口的类的完全限定名称 (module_name.class_name)。包含此类的模块应包含在提供给 packageUris 字段的包中。
project 字符串	要使用的 Google Cloud Platform 项目。
python_version 字符串	在预测中使用的 Python 版本。如果未设置，则默认版本为“2.7”。当 runtimeVersion 设置为“1.4”及更高版本时，可以使用 Python“3.5”。Python“2.7”适用于所有受支持的运行时版本。一些有效的选项包括：“2.7”、“3.5”
runtime_version 字符串	为此部署使用的 AI Platform 运行时版本。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account 字符串	指定用于资源访问控制的服务帐户。
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应该存在于 GCP 中选项 `"present"` ← (默认) `"absent"`

示例 

- 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 复杂类型	手动选择用于为模型提供服务的节点数。您通常应该使用带有适当 minNodes 的 autoScaling，但如果您想要更可预测的计费，则可以使用此选项。请注意，如果流量超过系统根据所选节点数提供服务的能力，则延迟和错误率会增加。返回：成功
nodes 整数	为此模型分配的节点数。这些节点始终处于启动状态，从模型部署时开始。返回：成功
model 字典	此版本所属的模型。返回：成功
name 字符串	创建版本时指定的名称。版本名称在创建它的模型中必须唯一。返回：成功
packageUris 列表 / 元素=字符串	自定义预测例程或带有自定义代码的 scikit-learn 管道的 Cloud Storage 路径 (gs://…)。返回：成功
predictionClass 字符串	实现此参考字段中描述的 Predictor 接口的类的完全限定名称 (module_name.class_name)。包含此类的模块应包含在提供给 packageUris 字段的包中。返回：成功
pythonVersion 字符串	在预测中使用的 Python 版本。如果未设置，则默认版本为“2.7”。当 runtimeVersion 设置为“1.4”及更高版本时，可以使用 Python“3.5”。Python“2.7”适用于所有受支持的运行时版本。返回：成功
运行时版本字符串	为此部署使用的 AI Platform 运行时版本。返回：成功
服务账号字符串	指定用于资源访问控制的服务帐户。返回：成功
state 字符串	版本的狀態。返回：成功

作者

谷歌公司 (@googlecloudplatform)