Update a model description

Update a model's description property for a given model ID.

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

Go

Before trying this sample, follow theGo setup instructions in theBigQuery quickstart using client libraries. For more information, see theBigQueryGo API reference documentation.

To authenticate to BigQuery, set up Application Default Credentials. For more information, seeSet up authentication for client libraries.

import("context""fmt""cloud.google.com/go/bigquery")// updateModelDescription demonstrates fetching BigQuery ML model metadata and updating the// Description metadata.funcupdateModelDescription(projectID,datasetID,modelIDstring)error{// projectID := "my-project-id"// datasetID := "mydataset"// modelID := "mymodel"ctx:=context.Background()client,err:=bigquery.NewClient(ctx,projectID)iferr!=nil{returnfmt.Errorf("bigquery.NewClient: %w",err)}deferclient.Close()model:=client.Dataset(datasetID).Model(modelID)oldMeta,err:=model.Metadata(ctx)iferr!=nil{returnfmt.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{returnfmt.Errorf("couldn't update model: %w",err)}returnnil}

Java

Before trying this sample, follow theJava setup instructions in theBigQuery quickstart using client libraries. For more information, see theBigQueryJava API reference documentation.

To authenticate to BigQuery, set up Application Default Credentials. For more information, seeSet up authentication for client libraries.

importcom.google.cloud.bigquery.BigQuery;importcom.google.cloud.bigquery.BigQueryException;importcom.google.cloud.bigquery.BigQueryOptions;importcom.google.cloud.bigquery.Model;importcom.google.cloud.bigquery.ModelId;// Sample to update description on a modelpublicclassUpdateModelDescription{publicstaticvoidmain(String[]args){// TODO(developer): Replace these variables before running the sample.StringdatasetName="MY_DATASET_NAME";StringmodelName="MY_MODEL_NAME";StringnewDescription="A really great model.";updateModelDescription(datasetName,modelName,newDescription);}publicstaticvoidupdateModelDescription(StringdatasetName,StringmodelName,StringnewDescription){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.BigQuerybigquery=BigQueryOptions.getDefaultInstance().getService();Modelmodel=bigquery.getModel(ModelId.of(datasetName,modelName));bigquery.update(model.toBuilder().setDescription(newDescription).build());System.out.println("Model description updated successfully to "+newDescription);}catch(BigQueryExceptione){System.out.println("Model description was not updated \n"+e.toString());}}}

Node.js

Before trying this sample, follow theNode.js setup instructions in theBigQuery quickstart using client libraries. For more information, see theBigQueryNode.js API reference documentation.

To authenticate to BigQuery, set up Application Default Credentials. For more information, seeSet up authentication for client libraries.

// Import the Google Cloud client libraryconst{BigQuery}=require('@google-cloud/bigquery');constbigquery=newBigQuery();asyncfunctionupdateModel(){// Updates a model's metadata./**   * TODO(developer): Uncomment the following lines before running the sample   */// const datasetId = "my_dataset";// const modelId = "my__model";constmetadata={description:'A really great model.',};constdataset=bigquery.dataset(datasetId);const[apiResponse]=awaitdataset.model(modelId).setMetadata(metadata);constnewDescription=apiResponse.description;console.log(`${modelId} description:${newDescription}`);}

Python

Before trying this sample, follow thePython setup instructions in theBigQuery quickstart using client libraries. For more information, see theBigQueryPython API reference documentation.

To authenticate to BigQuery, set up Application Default Credentials. For more information, seeSet up authentication for client libraries.

fromgoogle.cloudimportbigquery# 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))

What's next

To search and filter code samples for other Google Cloud products, see theGoogle Cloud sample browser.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.