Aggiornamento metadati modello

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

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

È possibile aggiornare i seguenti metadati del modello:

  • Descrizione: può essere aggiornata utilizzando la consoleGoogle 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.
  • Ora 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 nel 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 saperne di più su ruoli e autorizzazioni IAM in BigQuery ML, consulta Controllo dell'accesso.

Aggiornare la descrizione di un modello

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

Per aggiornare la descrizione di un modello:

Console

  1. Nella console Google Cloud , vai alla pagina BigQuery.

    Vai alla pagina BigQuery

  2. Nel riquadro Explorer, espandi il progetto e poi un set di dati.

  3. Espandi la cartella Modelli nel set di dati, poi fai clic sul nome di un modello per selezionarlo.

  4. Fai clic sulla scheda Dettagli.

  5. Per aggiornare la descrizione del modello, fai clic su Modifica .

  6. Nella finestra di dialogo Modifica dettagli, aggiorna la descrizione e poi fai clic su Salva.

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

Sostituisci quanto segue:

  • 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 del comando è simile al seguente:

Model 'myproject.mydataset.mymodel' successfully updated.

Puoi confermare le modifiche eseguendo il comando bq show. Per maggiori informazioni, consulta Recuperare i metadati del modello.

Esempi:

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

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

Inserisci il seguente comando 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 projectId, datasetId e modelId. Per modificare la descrizione, aggiungi o aggiorna la proprietà "description" per la risorsa modello.

Vai

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

Per eseguire l'autenticazione in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, vedi Configurare l'autenticazione per le librerie client. 

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 per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Java.

Per eseguire l'autenticazione in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, vedi Configurare l'autenticazione per le librerie client. 

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 per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Node.js.

Per eseguire l'autenticazione in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, vedi Configurare l'autenticazione per le librerie client. 

// 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 per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Python.

Per eseguire l'autenticazione in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, vedi Configurare l'autenticazione per le librerie client. 


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
    )
)

Aggiornare 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, vedi Aggiungere e utilizzare le etichette.

Per aggiornare le etichette di un modello:

Console

  1. Nel riquadro Explorer, espandi il progetto e poi un set di dati.

  2. Espandi la cartella Modelli nel set di dati, poi fai clic sul nome di un modello per selezionarlo.

  3. Fai clic sulla scheda Dettagli.

  4. Per aggiornare le etichette del modello, fai clic su Modifica .

  5. Nella finestra di dialogo Modifica dettaglio, aggiungi, elimina o modifica le etichette, quindi fai clic su Salva.

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

Sostituisci quanto segue:

  • 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 del comando è simile al seguente.

Model 'myproject.mydataset.mymodel' successfully updated.

Puoi confermare le modifiche eseguendo il comando bq show. Per maggiori informazioni, consulta Recuperare i metadati del modello.

Esempi:

Per aggiornare l'etichetta department su mymodel, inserisci il comando bq update e specifica department come chiave dell'etichetta. Ad esempio, per aggiornare l'etichetta department:shipping a department:logistics, inserisci il seguente comando. mydataset si trova in myotherproject, non nel 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 projectId, datasetId e modelId. Per modificare le etichette, aggiungi o aggiorna la proprietà "labels" per la risorsa modello.

Aggiorna l'ora di scadenza di un modello

Il tempo di scadenza di un modello è un valore timestamp che determina quando un modello viene eliminato. Puoi impostare la data di scadenza di un modello al momento della sua creazione utilizzando l'interfaccia a riga di comando, l'API o le librerie client. Puoi anche impostare o aggiornare la scadenza di un modello dopo la sua creazione. Il tempo di scadenza di un modello viene spesso chiamato "durata" o TTL.

Se non imposti un tempo di scadenza per un modello, questo non scade mai e devi eliminarlo manualmente.

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

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

Per aggiornare la scadenza di un modello:

Console

L'impostazione o l'aggiornamento del tempo di scadenza di un modello non è supportato dalla console Google Cloud .

bq

Per aggiornare l'ora di scadenza di un modello, esegui il comando bq update con i flag --model o -m e --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

Sostituisci quanto segue:

  • INTEGER è la durata (in secondi) del modello. Il valore minimo è 3600 secondi (un'ora). La scadenza corrisponde all'ora UTC attuale più il valore intero.
  • PROJECT_ID è l'ID progetto.
  • DATASET è il nome del set di dati.
  • MODEL è il nome del modello.

L'output del comando è simile al seguente.

Model 'myproject.mydataset.mymodel' successfully updated.

Puoi confermare le modifiche eseguendo il comando bq show. Per maggiori informazioni, consulta Recuperare i metadati del modello.

Esempi:

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

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

Inserisci il seguente comando per aggiornare il tempo di scadenza di mymodel in mydataset a 5 giorni (432.000 secondi). mydataset si trova in myotherproject, non nel 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 projectId, datasetId e modelId. Per modificare la scadenza, aggiungi o aggiorna la proprietà "expirationTime" per la risorsa modello. "expirationTime" è espresso in millisecondi dall'epoca.

Passaggi successivi