ml1 命令行界面（CLI）允许您在终端中舒适地使用 Google Cloud Machine Learning Engine 服务的几乎所有功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其直接重定向到文件，而不依赖于您的 shell 功能。错误将打印到标准错误，并导致程序的退出代码不为零。

如果请求数据结构，则这些结构将以漂亮的打印 JSON 返回，以便作为其他工具的输入。

有关云机器学习引擎 API 的其他所有信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-ml1-cli

在GitHub上查找源代码。

用法

本文档是从修订版 20240127 的 云机器学习引擎 API 生成的。CLI 版本为 5.0.4。

ml1 [options]
        projects
                explain <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get-config <name> [-p <v>]... [-o <out>]
                jobs-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-get <name> [-p <v>]... [-o <out>]
                jobs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                jobs-list <parent> [-p <v>]... [-o <out>]
                jobs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <parent> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-studies-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-studies-delete <name> [-p <v>]... [-o <out>]
                locations-studies-get <name> [-p <v>]... [-o <out>]
                locations-studies-list <parent> [-p <v>]... [-o <out>]
                locations-studies-trials-add-measurement <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-studies-trials-check-early-stopping-state <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-studies-trials-complete <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-studies-trials-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-studies-trials-delete <name> [-p <v>]... [-o <out>]
                locations-studies-trials-get <name> [-p <v>]... [-o <out>]
                locations-studies-trials-list <parent> [-p <v>]... [-o <out>]
                locations-studies-trials-list-optimal-trials <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-studies-trials-stop <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-studies-trials-suggest <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                models-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                models-delete <name> [-p <v>]... [-o <out>]
                models-get <name> [-p <v>]... [-o <out>]
                models-get-iam-policy <resource> [-p <v>]... [-o <out>]
                models-list <parent> [-p <v>]... [-o <out>]
                models-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                models-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                models-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                models-versions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                models-versions-delete <name> [-p <v>]... [-o <out>]
                models-versions-get <name> [-p <v>]... [-o <out>]
                models-versions-list <parent> [-p <v>]... [-o <out>]
                models-versions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                models-versions-set-default <name> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-cancel <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
                operations-list <name> [-p <v>]... [-o <out>]
                predict <name> (-r <kv>)... [-p <v>]... [-o <out>]
  ml1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将在 ~/.google-service-cli 目录中存储所有持久数据，该目录以 ml1- 为前缀的 JSON 文件中。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

以下段落中提供了有关各种类型持久数据的更多信息。

身份验证

大多数 API 需要用户对任何请求进行身份验证。如果是这种情况，则 作用域 确定了授予的权限集。这些通常不超过 只读 或 完全访问。

如果没有设置，系统将自动选择最小的可行作用域，例如，当调用只读方法时，它只会请求只读作用域。您可以使用 --scope 标志直接指定作用域。所有适用的作用域在相应方法的 CLI 文档中都有记录。

首次使用作用域时，会询问用户权限。按照 CLI 提供的说明进行授权或拒绝。

如果用户已对作用域进行认证，相关信息将作为 JSON 存储在配置目录中，例如 ~/.google-service-cli/ml1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用 Google 服务，需要使用 Google 开发者控制台 进行注册。应用程序可能使用的 API 将逐一启用。大多数 API 可免费使用，并设有每日配额。

为了在不强制用户注册自己的应用程序的情况下更舒适地使用 CLI，CLI 配置了默认的应用程序密钥。这也意味着全球范围内的重度使用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题：~/.google-service-cli/ml1-secret.json，假设已为它启用了所需的 ml API。此类密钥文件可以在 Google 开发者控制台 的 APIs & auth -> Credentials -> Download JSON 下载并直接使用。

有关如何设置 Google 项目和启用 API 的更多信息，请参阅官方文档。

调试

尽管 CLI 尽力提供可用的错误消息，但有时可能希望了解导致特定问题的确切原因。这是通过允许将所有客户端-服务器通信输出到标准错误 原样 来实现的。

使用 --debug 标志将使用 Debug 表示法将错误打印到标准错误。

您可以考虑将标准错误重定向到文件以方便使用，例如 ml1 --debug <resource> <method> [options] 2>debug.txt。