列出模型

概览

本页面介绍如何在数据集中列出 BigQuery ML 模型。您可以通过以下方式列出 BigQuery ML 模型：

• 使用 Google Cloud 控制台。
• 在 bq 命令行工具中使用 bq ls 命令。
• 直接调用或使用客户端库调用 models.list API 方法。

所需权限

如需列出数据集中的模型，您必须拥有数据集的 READER 角色，或者必须拥有具备 bigquery.models.list 权限的项目级 Identity and Access Management (IAM) 角色。如果您拥有项目级的 bigquery.models.list 权限，则可以列出项目中任何数据集中的模型。以下预定义的项目级 IAM 角色具有 bigquery.models.list 权限：

• bigquery.dataViewer
• bigquery.dataEditor
• bigquery.dataOwner
• bigquery.metadataViewer
• bigquery.user
• bigquery.admin

如需详细了解 BigQuery ML 中的 IAM 角色和权限，请参阅访问权限控制。如需详细了解数据集级角色，请参阅数据集的基本角色。

列出模型

要列出数据集中的模型，请执行以下操作：

控制台

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   前往 BigQuery 页面

2. 在导航面板的资源部分，点击您的项目名称。

3. 在展开项目中的每个数据集时，模型将与数据集中的其他 BigQuery 资源一起列出。模型由模型图标 表示。

bq

发出带 --models 或 -m 标志的 bq ls 命令。--format 标志可用于控制输出。如果您要列出非默认项目中的模型，请按以下格式将相应项目 ID 添加到数据集中：[PROJECT_ID]:[DATASET]。

bq ls -m --format=pretty [PROJECT_ID]:[DATASET]

其中：

• [PROJECT_ID] 是您的项目 ID。
• [DATASET] 是数据集的名称。

使用 --format=pretty 标志时，命令输出如下所示。--format=pretty 生成带格式的表输出。Model Type 列显示模型类型，例如 KMEANS。

+-------------------------+------------+--------+-----------------+
|           Id            | Model Type | Labels |  Creation Time  |
+-------------------------+------------+--------+-----------------+
| mymodel                 | KMEANS     |        | 03 May 03:02:27 |
+-------------------------+------------+--------+-----------------+

示例：

输入以下命令可列出默认项目的数据集 mydataset 中的模型。

bq ls --models --format=pretty mydataset

输入以下命令可列出 myotherproject 的数据集 mydataset 中的模型。此命令使用 -m 快捷方式列出模型。

bq ls -m --format=pretty myotherproject:mydataset

API

要使用 API 列出模型，请调用 models.list 方法并提供 projectId 和 datasetId。

Go

试用此示例之前，请按照 BigQuery 快速入门：使用客户端库中的 Go 设置说明进行操作。如需了解详情，请参阅 BigQuery Go API 参考文档。

如需向 BigQuery 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为客户端库设置身份验证。

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/bigquery"
	"google.golang.org/api/iterator"
)

// listModels demonstrates iterating through the collection of ML models in a dataset
// and printing a basic identifier of the model.
func listModels(w io.Writer, projectID, datasetID string) error {
	// projectID := "my-project-id"
	// datasetID := "mydataset"
	ctx := context.Background()

	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %w", err)
	}
	defer client.Close()

	fmt.Fprintf(w, "Models contained in dataset %q\n", datasetID)
	it := client.Dataset(datasetID).Models(ctx)
	for {
		m, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return err
		}
		fmt.Fprintf(w, "Model: %s\n", m.FullyQualifiedName())
	}
	return nil
}

Java

试用此示例之前，请按照 BigQuery 快速入门：使用客户端库中的 Java 设置说明进行操作。如需了解详情，请参阅 BigQuery Java API 参考文档。

如需向 BigQuery 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为客户端库设置身份验证。

import com.google.api.gax.paging.Page;
import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQuery.ModelListOption;
import com.google.cloud.bigquery.BigQueryException;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Model;

public class ListModels {

  public static void runListModels() {
    // TODO(developer): Replace these variables before running the sample.
    String datasetName = "MY_DATASET_NAME";
    listModels(datasetName);
  }

  public static void listModels(String datasetName) {
    try {
      // Initialize client that will be used to send requests. This client only needs to be created
      // once, and can be reused for multiple requests.
      BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();

      Page<Model> models = bigquery.listModels(datasetName, ModelListOption.pageSize(100));
      if (models == null) {
        System.out.println("Dataset does not contain any models.");
        return;
      }
      models
          .iterateAll()
          .forEach(model -> System.out.printf("Success! Model ID: %s", model.getModelId()));
    } catch (BigQueryException e) {
      System.out.println("Models not listed in dataset due to error: \n" + e.toString());
    }
  }
}

Node.js

试用此示例之前，请按照 BigQuery 快速入门：使用客户端库中的 Node.js 设置说明进行操作。如需了解详情，请参阅 BigQuery Node.js API 参考文档。

如需向 BigQuery 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为客户端库设置身份验证。

// Import the Google Cloud client library
const {BigQuery} = require('@google-cloud/bigquery');
const bigquery = new BigQuery();

async function listModels() {
  // Lists all existing models in the dataset.

  /**
   * TODO(developer): Uncomment the following lines before running the sample.
   */
  // const datasetId = "my_dataset";

  const dataset = bigquery.dataset(datasetId);

  dataset.getModels().then(data => {
    const models = data[0];
    console.log('Models:');
    models.forEach(model => console.log(model.metadata));
  });
}

Python

试用此示例之前，请按照 BigQuery 快速入门：使用客户端库中的 Python 设置说明进行操作。如需了解详情，请参阅 BigQuery Python API 参考文档。

如需向 BigQuery 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为客户端库设置身份验证。

from google.cloud import bigquery

# Construct a BigQuery client object.
client = bigquery.Client()

# TODO(developer): Set dataset_id to the ID of the dataset that contains
#                  the models you are listing.
# dataset_id = 'your-project.your_dataset'

models = client.list_models(dataset_id)  # Make an API request.

print("Models contained in '{}':".format(dataset_id))
for model in models:
    full_model_id = "{}.{}.{}".format(
        model.project, model.dataset_id, model.model_id
    )
    friendly_name = model.friendly_name
    print("{}: friendly_name='{}'".format(full_model_id, friendly_name))

后续步骤

• 如需大致了解 BigQuery ML，请参阅 BigQuery ML 简介。
• 如需开始使用 BigQuery ML，请参阅在 BigQuery ML 中创建机器学习模型。
• 如需详细了解如何使用模型，请参阅以下内容：
  • 获取模型元数据
  • 更新模型元数据
  • 管理模型
  • 删除模型