Aggiornamento metadati modello

Panoramica

Questa pagina mostra come aggiornare i metadati del modello BigQuery ML. Puoi aggiornare i metadati del modello in questo modo:

Utilizzo della console Google Cloud.
Utilizzo del comando bq update nello strumento a riga di comando bq.
Chiamare il metodo API models.patch direttamente o utilizzando le librerie client.

Puoi aggiornare i seguenti metadati del modello:

Descrizione: può essere aggiornata utilizzando la console Google Cloud, lo strumento a riga di comando bq, l'API o le librerie client.
Etichette: possono essere aggiornate utilizzando la console Google Cloud, lo strumento a riga di comando bq, l'API o le librerie client.
Data di scadenza: può essere aggiornata utilizzando lo strumento bq, l'API o le librerie client.

Autorizzazioni obbligatorie

Per aggiornare i metadati del modello, devi disporre del ruolo WRITER per il set di dati oppure di un ruolo Identity and Access Management (IAM) a livello di progetto che includa le autorizzazioni bigquery.models.updateMetadata. Se ti vengono concesse le autorizzazioni bigquery.models.updateMetadata a livello di progetto, puoi aggiornare i metadati per i modelli in qualsiasi set di dati del progetto. I seguenti ruoli IAM predefiniti a livello di progetto includono le autorizzazioni bigquery.models.updateMetadata:

bigquery.dataEditor
bigquery.dataOwner
bigquery.admin

Per ulteriori informazioni su ruoli e autorizzazioni IAM in BigQuery ML, consulta Controllo dell'accesso.

Aggiorna la descrizione di un modello

La descrizione di un modello è una stringa di testo utilizzata per identificare facilmente il modello.

Per aggiornare la descrizione di un modello:

Console

Nella console Google Cloud, vai alla pagina BigQuery.

Vai alla pagina di BigQuery
Nella sezione Risorse del pannello di navigazione, espandi il nome del progetto e del set di dati.
Fai clic sul nome del modello. I modelli sono indicati con l'icona del modello: .
Fai clic sulla scheda Dettagli.
Per aggiornare la descrizione del modello, fai clic sull'icona di modifica (matita) a destra di Descrizione.
Nella finestra di dialogo Modifica descrizione, inserisci il testo e fai clic su Aggiorna.

bq

Per aggiornare la descrizione di un modello, esegui il comando bq update con il flag --model o -m e il flag --description.

Se stai aggiornando un modello in un progetto diverso da quello predefinito, aggiungi l'ID progetto al set di dati nel seguente formato: [PROJECT_ID]:[DATASET].

bq update --model --description "[STRING]" [PROJECT_ID]:[DATASET].[MODEL]

Dove:

[STRING] è la stringa di testo che descrive il modello tra virgolette.
[PROJECT_ID] è l'ID progetto.
[DATASET] è il nome del set di dati.
[MODEL] è il nome del modello.

L'output comando è simile al seguente:

Model '[PROJECT_ID]:[DATASET].[MODEL]' successfully updated.

Puoi confermare le modifiche inviando il comando bq show. Per ulteriori informazioni, consulta la sezione Recupero dei metadati del modello.

Esempi:

Inserisci il comando seguente per aggiornare la descrizione di mymodel in mydataset nel progetto predefinito.

bq update --model --description "My updated description" \
mydataset.mymodel

Inserisci il comando seguente per aggiornare la descrizione di mymodel in mydataset in myotherproject.

bq update --model --description "My updated description" \
myotherproject:mydataset.mymodel

API

Per aggiornare la descrizione di un modello utilizzando l'API, chiama il metodo models.patch e fornisci i campi projectId, datasetId e modelId. Per modificare la descrizione, aggiungi o aggiorna la proprietà "description" per la risorsa del modello.

Go

Prima di provare questo esempio, segui le istruzioni di configurazione di Go nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Go.

Per eseguire l'autenticazione in BigQuery, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta la pagina Configurare l'autenticazione per un ambiente di sviluppo locale.

Visualizza su GitHub Feedback

import (
	"context"
	"fmt"

	"cloud.google.com/go/bigquery"
)

// updateModelDescription demonstrates fetching BigQuery ML model metadata and updating the
// Description metadata.
func updateModelDescription(projectID, datasetID, modelID string) error {
	// projectID := "my-project-id"
	// datasetID := "mydataset"
	// modelID := "mymodel"
	ctx := context.Background()
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %w", err)
	}
	defer client.Close()

	model := client.Dataset(datasetID).Model(modelID)
	oldMeta, err := model.Metadata(ctx)
	if err != nil {
		return fmt.Errorf("couldn't retrieve model metadata: %w", err)
	}
	update := bigquery.ModelMetadataToUpdate{
		Description: "This model was modified from a Go program",
	}
	if _, err = model.Update(ctx, update, oldMeta.ETag); err != nil {
		return fmt.Errorf("couldn't update model: %w", err)
	}
	return nil
}

Java

Prima di provare questo esempio, segui le istruzioni di configurazione di Java nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Java.

Visualizza su GitHub Feedback

import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQueryException;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Model;
import com.google.cloud.bigquery.ModelId;

// Sample to update description on a model
public class UpdateModelDescription {

  public static void runUpdateModelDescription() {
    // TODO(developer): Replace these variables before running the sample.
    String datasetName = "MY_DATASET_NAME";
    String modelName = "MY_MODEL_NAME";
    String newDescription = "A really great model.";
    updateModelDescription(datasetName, modelName, newDescription);
  }

  public static void updateModelDescription(
      String datasetName, String modelName, String newDescription) {
    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();

      Model model = bigquery.getModel(ModelId.of(datasetName, modelName));
      bigquery.update(model.toBuilder().setDescription(newDescription).build());
      System.out.println("Model description updated successfully to " + newDescription);
    } catch (BigQueryException e) {
      System.out.println("Model description was not updated \n" + e.toString());
    }
  }
}

Node.js

Prima di provare questo esempio, segui le istruzioni di configurazione di Node.js nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Node.js.

Visualizza su GitHub Feedback

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

async function updateModel() {
  // Updates a model's metadata.

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

  const metadata = {
    description: 'A really great model.',
  };

  const dataset = bigquery.dataset(datasetId);
  const [apiResponse] = await dataset.model(modelId).setMetadata(metadata);
  const newDescription = apiResponse.description;

  console.log(`${modelId} description: ${newDescription}`);
}

Python

Prima di provare questo esempio, segui le istruzioni di configurazione di Python nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Python.

Visualizza su GitHub Feedback


from google.cloud import bigquery

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

# TODO(developer): Set model_id to the ID of the model to fetch.
# model_id = 'your-project.your_dataset.your_model'

model = client.get_model(model_id)  # Make an API request.
model.description = "This model was modified from a Python program."
model = client.update_model(model, ["description"])  # Make an API request.

full_model_id = "{}.{}.{}".format(model.project, model.dataset_id, model.model_id)
print(
    "Updated model '{}' with description '{}'.".format(
        full_model_id, model.description
    )
)

Aggiorna le etichette di un modello

Le etichette sono coppie chiave-valore che puoi collegare a una risorsa. Quando crei risorse BigQuery ML, le etichette sono facoltative. Per ulteriori informazioni, consulta la sezione Aggiungere e utilizzare le etichette.

Per aggiornare le etichette di un modello:

Console

Nella console Google Cloud, vai alla pagina BigQuery.

Vai alla pagina di BigQuery
Nella sezione Risorse del pannello di navigazione, espandi il nome del progetto e del set di dati.
Fai clic sul nome del modello. I modelli sono indicati dall'icona del modello: .
Fai clic sulla scheda Dettagli.
Per aggiornare le etichette del modello, fai clic sull'icona di modifica (matita) a destra di Etichette.
Nella finestra di dialogo Modifica etichette:
- Per applicare altre etichette, fai clic su Aggiungi etichetta. Ogni chiave può essere utilizzata una sola volta per ogni set di dati, ma puoi utilizzare la stessa chiave in diversi set di dati all'interno dello stesso progetto.
- Modifica le chiavi o i valori esistenti per aggiornare un'etichetta.
- Fai clic su Update (Aggiorna) per salvare le modifiche.

bq

Per aggiornare le etichette di un modello, esegui il comando bq update con il flag --model o -m e il flag --set_label. Ripeti il flag --set_label per aggiungere o aggiornare più etichette.

Se stai aggiornando un modello in un progetto diverso da quello predefinito, aggiungi l'ID progetto al set di dati nel seguente formato: [PROJECT_ID]:[DATASET].

bq update --model --set_label [KEY:VALUE] \
[PROJECT_ID]:[DATASET].[MODEL]

Dove:

[KEY:VALUE] corrisponde a una coppia chiave-valore per un'etichetta che vuoi aggiungere o aggiornare. Se specifichi la stessa chiave di un'etichetta esistente, il valore dell'etichetta esistente viene aggiornato. La chiave deve essere univoca.
[PROJECT_ID] è l'ID progetto.
[DATASET] è il nome del set di dati.
[MODEL] è il nome del modello.

L'output comando è simile al seguente.

Model '[PROJECT_ID]:[DATASET].[MODEL]' successfully updated.

Puoi confermare le modifiche inviando il comando bq show. Per ulteriori informazioni, consulta la sezione Recupero dei metadati del modello.

Esempi:

Per aggiornare l'etichetta department su mymodel, inserisci il comando bq update e specifica department come chiave di etichetta. Ad esempio, per aggiornare l'etichetta department:shipping in department:logistics, inserisci questo comando. mydataset è in myotherproject, non è il tuo progetto predefinito.

bq update --model --set_label department:logistics \
myotherproject:mydataset.mymodel

API

Per aggiornare le etichette di un modello utilizzando l'API, chiama il metodo models.patch e fornisci i campi projectId, datasetId e modelId. Per modificare le etichette, aggiungi o aggiorna la proprietà "labels" per la risorsa modello.

Aggiorna la data di scadenza di un modello

La data di scadenza di un modello è un valore timestamp che determina quando un modello viene eliminato. Puoi impostare la data di scadenza di un modello quando questo viene creato utilizzando l'interfaccia a riga di comando, l'API o le librerie client. Puoi anche impostare o aggiornare la data di scadenza di un modello dopo la sua creazione. La data di scadenza di un modello è spesso indicata come "durata" o TTL.

Se non imposti una data di scadenza per un modello, quest'ultimo non scade mai e dovrai eliminarlo manualmente.

Il valore della data di scadenza viene espresso in modo diverso a seconda di dove è impostato. Utilizza il metodo che offre il livello di granularità appropriato:

Nello strumento a riga di comando, la scadenza è espressa in secondi rispetto all'ora attuale UTC. Quando specifichi la scadenza nella riga di comando, il valore intero in secondi viene aggiunto al timestamp UTC attuale.
Nell'API, la scadenza è espressa in millisecondi dall'epoca. Se specifichi un valore di scadenza inferiore al timestamp attuale, il modello scade immediatamente.

Per aggiornare la data di scadenza di un modello:

Console

L'impostazione o l'aggiornamento della data di scadenza di un modello non è attualmente supportato dalla console Google Cloud.

bq

Per aggiornare la data di scadenza di un modello, esegui il comando bq update con il flag --model o -m e il flag --expiration.

Se stai aggiornando un modello in un progetto diverso da quello predefinito, aggiungi l'ID progetto al set di dati nel seguente formato: [PROJECT_ID]:[DATASET].

bq update --model --expiration [INTEGER] \
[PROJECT_ID]:[DATASET].[MODEL]

Dove:

[INTEGER] è la durata (in secondi) del modello. Il valore minimo è 3600 secondi (un'ora). L'ora di scadenza viene calcolata in base all'ora UTC corrente più il valore intero.
[PROJECT_ID] è l'ID progetto.
[DATASET] è il nome del set di dati.
[MODEL] è il nome del modello.

L'output comando è simile al seguente.

Model '[PROJECT_ID]:[DATASET].[MODEL]' successfully updated.

Puoi confermare le modifiche inviando il comando bq show. Per ulteriori informazioni, consulta la sezione Recupero dei metadati del modello.

Esempi:

Inserisci il comando seguente per aggiornare la scadenza di mymodel in mydataset a 5 giorni (432.000 secondi). mydataset è nel tuo progetto predefinito.

bq update --model --expiration 432000 mydataset.mymodel

Inserisci il comando seguente per aggiornare la scadenza di mymodel in mydataset a 5 giorni (432.000 secondi). mydataset è in myotherproject, non è il tuo progetto predefinito.

bq update --model --expiration 432000 myotherproject:mydataset.mymodel

API

Per aggiornare la scadenza di un modello utilizzando l'API, chiama il metodo models.patch e fornisci i campi projectId, datasetId e modelId. Per modificare la scadenza, aggiungi o aggiorna la proprietà "expirationTime" per la risorsa del modello. "expirationTime" è espressa in millisecondi dall'epoca.

Passaggi successivi

Per una panoramica di BigQuery ML, consulta Introduzione a BigQuery ML.
Per iniziare a utilizzare BigQuery ML, consulta Creare modelli di machine learning in BigQuery ML.
Per saperne di più sull'utilizzo dei modelli, consulta: