Console

1. In the Google Cloud console, go to the Colab EnterpriseMy notebooks page.

   Go to My notebooks

2. In theRegion menu, select the region that contains your notebook.

3. Next to a notebook, click themore_vertNotebook actions menu and selectSchedule.

4. In theSchedule name field, enter a name for your schedule.

5. Click theRuntime template list, and select a runtime template. The runtime template determines the specifications of the runtime that runs your notebook.

6. UnderRun schedule, selectOne-off to run your notebook as soon as you submit the notebook run.

7. Next to theCloud Storage output location field, clickBrowse to open theSelect folder dialog.

8. Select a Cloud Storage bucket. Or, to create a bucket, click Create new bucket and complete the dialog.

9. If you selected a runtime template without end-user credentials enabled, the dialog includes aService account field. In theService account field, enter a service account's email address.

10. ClickSubmit.

    The notebook run starts immediately.

gcloud

Before using any of the command data below, make the following replacements:

• DISPLAY_NAME: the display name for your notebook run.
• NOTEBOOK_RUNTIME_TEMPLATE: the notebook runtime template that specifies your runtime's compute configuration.
• NOTEBOOK_URI: the Cloud Storage URI of the notebook to run.
• OUTPUT_URI: the Cloud Storage location where you want to store results.
• USER_EMAIL: the user account email address that specifies the notebook run's access to Google Cloud resources.
• PROJECT_ID: your project ID.
• REGION: the region where your notebook will run.

Execute the following command:

gcloudcolabexecutionscreate--display-name="DISPLAY_NAME"\--notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE\--gcs-notebook-uri=NOTEBOOK_URI\--gcs-output-uri=OUTPUT_URI\--user-email=USER_EMAIL\--project=PROJECT_ID\--region=REGION

gcloudcolabexecutionscreate--display-name="DISPLAY_NAME"`--notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE`--gcs-notebook-uri=NOTEBOOK_URI`--gcs-output-uri=OUTPUT_URI`--user-email=USER_EMAIL`--project=PROJECT_ID`--region=REGION

gcloudcolabexecutionscreate--display-name="DISPLAY_NAME"^--notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE^--gcs-notebook-uri=NOTEBOOK_URI^--gcs-output-uri=OUTPUT_URI^--user-email=USER_EMAIL^--project=PROJECT_ID^--region=REGION

For more information about managing Colab Enterprise notebook runsfrom the command line, see thegcloud CLI documentation.

Python

Before trying this sample,install the Vertex AI SDK for Python. The Vertex AI Python client library is installed when you install the Vertex AI SDK for Python. For more information, see theVertex AI SDK for Python API reference documentation.

To run the following code sample, you'll need the Dataform repository ID of your notebook. To get the repository ID of your notebook, you can use Dataform'slist_repositories method.

fromgoogle.cloudimportaiplatform_v1PROJECT_ID="my-project"LOCATION="us-central1"REPOSITORY_ID="b223577f-a3fb-482c-a22c-0658c6602598"TEMPLATE_ID="6524523989455339520"API_ENDPOINT=f"{LOCATION}-aiplatform.googleapis.com"PARENT=f"projects/{PROJECT_ID}/locations/{LOCATION}"notebook_service_client=aiplatform_v1.NotebookServiceClient(client_options={"api_endpoint":API_ENDPOINT,})operation=notebook_service_client.create_notebook_execution_job(parent=PARENT,notebook_execution_job={"display_name":"my-execution-job",# Specify a NotebookRuntimeTemplate to source compute configuration from"notebook_runtime_template_resource_name":f"projects/{PROJECT_ID}/locations/{LOCATION}/notebookRuntimeTemplates/{TEMPLATE_ID}",# Specify a Colab Enterprise notebook to run"dataform_repository_source":{"dataform_repository_resource_name":f"projects/{PROJECT_ID}/locations/{LOCATION}/repositories/{REPOSITORY_ID}",},# Specify a Cloud Storage bucket to store output artifacts"gcs_output_uri":"gs://my-bucket/",# Specify the identity that runs the notebook"execution_user":"{EMAIL}",# Run as the service account instead# "service_account": "my-service-account",})print("Waiting for operation to complete...")result=operation.result()

Terraform

To learn how to apply or remove a Terraform configuration, seeBasic Terraform commands. For more information, see theTerraform provider reference documentation.

The following sample uses thegoogle_colab_notebook_execution Terraform resource to run a Colab Enterprise notebook.

resource"google_colab_runtime_template""my_runtime_template"{provider=google-betaname="{{index $.Vars "runtime_template_name"}}"display_name="Runtime template"location="us-central1"machine_spec{machine_type="e2-standard-4"}network_spec{enable_internet_access=true}}resource"google_storage_bucket""output_bucket"{provider=google-betaname="{{index $.Vars "bucket"}}"location="US"force_destroy=trueuniform_bucket_level_access=true}resource"google_storage_bucket_object""notebook"{provider=google-betaname="hello_world.ipynb"bucket=google_storage_bucket.output_bucket.namecontent=<<EOF{"cells":[{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["print(\"Hello, World!\")"]}],"metadata":{"kernelspec":{"display_name":"Python 3","language":"python","name":"python3"},"language_info":{"codemirror_mode":{"name":"ipython","version":3},"file_extension":".py","mimetype":"text/x-python","name":"python","nbconvert_exporter":"python","pygments_lexer":"ipython3","version":"3.8.5"}},"nbformat":4,"nbformat_minor":4}EOF}resource"google_colab_notebook_execution" "{{$.PrimaryResourceId}}"{provider=google-betanotebook_execution_job_id="{{index $.Vars "notebook_execution_job_id"}}"display_name="Notebook execution full"location="us-central1"execution_timeout="86400s"gcs_notebook_source{uri="gs://${google_storage_bucket_object.notebook.bucket}/${google_storage_bucket_object.notebook.name}"generation=google_storage_bucket_object.notebook.generation}service_account="{{index $.TestEnvVars "service_account"}}"gcs_output_uri="gs://${google_storage_bucket.output_bucket.name}"notebook_runtime_template_resource_name="projects/${google_colab_runtime_template.my_runtime_template.project}/locations/${google_colab_runtime_template.my_runtime_template.location}/notebookRuntimeTemplates/${google_colab_runtime_template.my_runtime_template.name}"depends_on=[google_storage_bucket_object.notebook,google_storage_bucket.output_bucket,google_colab_runtime_template.my_runtime_template,]}

Console

1. In the Google Cloud console, go to the Colab EnterpriseMy notebooks page.

   Go to My notebooks

2. In theRegion menu, select the region that contains your notebook.

3. Next to a notebook, click themore_vertNotebook actions menu and selectSchedule.

4. In theSchedule name field, enter a name for your schedule.

5. Click theRuntime template list, and select a runtime template. The runtime template determines the specifications of the runtime that runs your notebook.

6. UnderRun schedule, selectRecurring to schedule the notebook run for a specific interval of time.

7. Complete the scheduling dialog.

8. Next to theCloud Storage output location field, clickBrowse to open theSelect folder dialog.

9. Select a Cloud Storage bucket. Or, to create a bucket, click Create new bucket and complete the dialog.

10. If you selected a runtime template without end-user credentials enabled, the dialog includes aService account field. In theService account field, enter a service account's email address.

11. ClickSubmit.

    Scheduled notebook runs start automatically on the schedule that you set.

gcloud

Before using any of the command data below, make the following replacements:

• DISPLAY_NAME: the display name of your schedule.
• CRON_SCHEDULE: the schedule that you set, inunix-cron format. For example,00 19 * * MON means weekly on Monday, at 1900 hours Greenwich Mean Time (GMT).
• NOTEBOOK_RUN_NAME: the display name for notebook runs generated by this schedule.
• NOTEBOOK_RUNTIME_TEMPLATE: the notebook runtime template that specifies your runtime's compute configuration.
• NOTEBOOK_URI: the Cloud Storage URI of the notebook to run.
• OUTPUT_URI: the Cloud Storage location where you want to store results.
• USER_EMAIL: the user account email address that specifies the notebook run's access to Google Cloud resources.
• PROJECT_ID: your project ID.
• REGION: the region where your schedule will run.

Execute the following command:

gcloudcolabschedulescreate--display-name="DISPLAY_NAME"\--cron-schedule=CRON_SCHEDULE\--execution-display-name=NOTEBOOK_RUN_NAME\--notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE\--gcs-notebook-uri=NOTEBOOK_URI\--gcs-output-uri=OUTPUT_URI\--user-email=USER_EMAIL\--project=PROJECT_ID\--region=REGION

gcloudcolabschedulescreate--display-name="DISPLAY_NAME"`--cron-schedule=CRON_SCHEDULE`--execution-display-name=NOTEBOOK_RUN_NAME`--notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE`--gcs-notebook-uri=NOTEBOOK_URI`--gcs-output-uri=OUTPUT_URI`--user-email=USER_EMAIL`--project=PROJECT_ID`--region=REGION

gcloudcolabschedulescreate--display-name="DISPLAY_NAME"^--cron-schedule=CRON_SCHEDULE^--execution-display-name=NOTEBOOK_RUN_NAME^--notebook-runtime-template=NOTEBOOK_RUNTIME_TEMPLATE^--gcs-notebook-uri=NOTEBOOK_URI^--gcs-output-uri=OUTPUT_URI^--user-email=USER_EMAIL^--project=PROJECT_ID^--region=REGION

For more information about creating Colab Enterprise notebook schedulesfrom the command line, see thegcloud CLIdocumentation.

Python

Before trying this sample,install the Vertex AI SDK for Python. The Vertex AI Python client library is installed when you install the Vertex AI SDK for Python. For more information, see theVertex AI SDK for Python API reference documentation.

To run the following code sample, you'll need the Dataform repository ID of your notebook. To get the repository ID of your notebook, you can use Dataform'slist_repositories method.

fromgoogle.cloudimportaiplatform_v1PROJECT_ID="my-project"LOCATION="us-central1"REPOSITORY_ID="b223577f-a3fb-482c-a22c-0658c6602598"TEMPLATE_ID="6524523989455339520"API_ENDPOINT=f"{LOCATION}-aiplatform.googleapis.com"PARENT=f"projects/{PROJECT_ID}/locations/{LOCATION}"schedules_service_client=aiplatform_v1.ScheduleServiceClient(client_options={"api_endpoint":API_ENDPOINT,})schedule=schedules_service_client.create_schedule(parent=PARENT,schedule={"display_name":"my-notebook-schedule",# Time specification. TZ is optional.# cron = "* * * * *" to run it in the next minute."cron":"TZ=America/Los_Angeles * * * * *",# How many runs the schedule will trigger before it becomes COMPLETED.# A Schedule in COMPLETED state will not trigger any more runs."max_run_count":1,"max_concurrent_run_count":1,"create_notebook_execution_job_request":{"parent":PARENT,"notebook_execution_job":{"display_name":"my-execution-job",# Specify a NotebookRuntimeTemplate to source compute configuration from"notebook_runtime_template_resource_name":f"projects/{PROJECT_ID}/locations/{LOCATION}/notebookRuntimeTemplates/{TEMPLATE_ID}",# Specify a Colab Enterprise notebook to run"dataform_repository_source":{"dataform_repository_resource_name":f"projects/{PROJECT_ID}/locations/{LOCATION}/repositories/{REPOSITORY_ID}",},# Specify a Cloud Storage bucket to store output artifacts"gcs_output_uri":"gs://my-bucket/",# Specify the identity that runs the notebook"execution_user":"{EMAIL}",# Run as the service account instead# "service_account": "my-service-account",}}})

Terraform

To learn how to apply or remove a Terraform configuration, seeBasic Terraform commands. For more information, see theTerraform provider reference documentation.

The following sample uses thegoogle_colab_schedule Terraform resource to schedule a Colab Enterprise notebook run.

resource"google_colab_runtime_template""my_runtime_template"{provider=google-betaname="{{index $.Vars "runtime_template_name"}}"display_name="Runtime template"location="us-central1"machine_spec{machine_type="e2-standard-4"}network_spec{enable_internet_access=true}}resource"google_storage_bucket""output_bucket"{provider=google-betaname="{{index $.Vars "bucket"}}"location="US"force_destroy=trueuniform_bucket_level_access=true}resource"google_secret_manager_secret""secret"{provider=google-betasecret_id="{{index $.Vars "secret"}}"replication{auto{}}}resource"google_secret_manager_secret_version""secret_version"{provider=google-betasecret=google_secret_manager_secret.secret.idsecret_data="secret-data"}resource"google_dataform_repository""dataform_repository"{provider=google-betaname="{{index $.Vars "dataform_repository"}}"display_name="dataform_repository"npmrc_environment_variables_secret_version=google_secret_manager_secret_version.secret_version.idkms_key_name="{{index $.Vars "key_name"}}"labels={label_foo1="label-bar1"}git_remote_settings{url="https://github.com/OWNER/REPOSITORY.git"default_branch="main"authentication_token_secret_version=google_secret_manager_secret_version.secret_version.id}workspace_compilation_overrides{default_database="database"schema_suffix="_suffix"table_prefix="prefix_"}}resource"google_colab_schedule" "{{$.PrimaryResourceId}}"{provider=google-betadisplay_name="{{index $.Vars "display_name"}}"location="{{index $.TestEnvVars "location"}}"allow_queueing=truemax_concurrent_run_count=2cron="TZ=America/Los_Angeles * * * * *"max_run_count=5start_time="{{index $.Vars "start_time"}}"end_time="{{index $.Vars "end_time"}}"desired_state="ACTIVE"create_notebook_execution_job_request{notebook_execution_job{display_name="Notebook execution"execution_timeout="86400s"dataform_repository_source{commit_sha="randomsha123"dataform_repository_resource_name="projects/{{index $.TestEnvVars "project_id"}}/locations/{{index $.TestEnvVars "location"}}/repositories/${google_dataform_repository.dataform_repository.name}"}notebook_runtime_template_resource_name="projects/${google_colab_runtime_template.my_runtime_template.project}/locations/${google_colab_runtime_template.my_runtime_template.location}/notebookRuntimeTemplates/${google_colab_runtime_template.my_runtime_template.name}"gcs_output_uri="gs://${google_storage_bucket.output_bucket.name}"service_account="{{index $.TestEnvVars "service_account"}}"}}depends_on=[google_colab_runtime_template.my_runtime_template,google_storage_bucket.output_bucket,google_secret_manager_secret_version.secret_version,google_dataform_repository.dataform_repository,]}

Console

1. In the Google Cloud console, go to the Colab EnterpriseExecutions page.

   Go to Executions

2. Next to the notebook run that you want to view results for, clickView result.

   Colab Enterprise opens the result of the notebook run in a new tab.

3. To view the result, click the tab.

gcloud

Before using any of the command data below, make the following replacements:

• PROJECT_ID: your project ID.
• REGION: the region where your notebook run results are located.
• SCHEDULE_NAME: the name of the schedule to view results for. To see results from all schedules, omit the--filter flag.

Execute the following command:

gcloudcolabexecutionslist--project=PROJECT_ID\--region=REGION\--filter="scheduleResourceName:SCHEDULE_NAME"

gcloudcolabexecutionslist--project=PROJECT_ID`--region=REGION`--filter="scheduleResourceName:SCHEDULE_NAME"

gcloudcolabexecutionslist--project=PROJECT_ID^--region=REGION^--filter="scheduleResourceName:SCHEDULE_NAME"

For more information about listing Colab Enterprise notebook runsfrom the command line, see thegcloud CLIdocumentation.

Python

Before trying this sample,install the Vertex AI SDK for Python. The Vertex AI Python client library is installed when you install the Vertex AI SDK for Python. For more information, see theVertex AI SDK for Python API reference documentation.

To run the following code sample, you'll need the Dataform repository ID of your notebook. To get the repository ID of your notebook, you can use Dataform'slist_repositories method.

fromgoogle.cloudimportaiplatform_v1PROJECT_ID="my-project"LOCATION="us-central1"API_ENDPOINT=f"{LOCATION}-aiplatform.googleapis.com"PARENT=f"projects/{PROJECT_ID}/locations/{LOCATION}"notebook_service_client=aiplatform_v1.NotebookServiceClient(client_options={"api_endpoint":API_ENDPOINT,})notebook_execution_jobs=notebook_service_client.list_notebook_execution_jobs(parent=PARENT)notebook_execution_jobs

Console

1. In the Google Cloud console, go to the Colab EnterpriseExecutions page.

   Go to Executions

2. Select the notebook run that you want to delete the result for.

3. Clickdelete Delete.

4. To confirm the deletion, clickConfirm.

gcloud

Before using any of the command data below, make the following replacements:

• NOTEBOOK_RUN_ID: the ID of the notebook run that you want to delete.
• PROJECT_ID: your project ID.
• REGION: the region where your notebook run is located.

Execute the following command:

gcloudcolabexecutionsdeleteNOTEBOOK_RUN_ID\--project=PROJECT_ID\--region=REGION

gcloudcolabexecutionsdeleteNOTEBOOK_RUN_ID`--project=PROJECT_ID`--region=REGION

gcloudcolabexecutionsdeleteNOTEBOOK_RUN_ID^--project=PROJECT_ID^--region=REGION

For more information about deleting Colab Enterprise notebook runsfrom the command line, see thegcloud CLIdocumentation.

Console

1. In the Google Cloud console, go to the Colab EnterpriseSchedules page.

   Go to Schedules

2. Click the name of a schedule.

   TheSchedule details page opens.

3. To go back to theSchedules page, clickarrow_back Back to previous page.

gcloud

Before using any of the command data below, make the following replacements:

• SCHEDULE: your schedule ID.
• PROJECT_ID: your project ID.
• REGION: the region where your schedule is located.

Execute the following command:

gcloudcolabschedulesdescribeSCHEDULE\--project=PROJECT_ID\--region=REGION

gcloudcolabschedulesdescribeSCHEDULE`--project=PROJECT_ID`--region=REGION

gcloudcolabschedulesdescribeSCHEDULE^--project=PROJECT_ID^--region=REGION

For more information about viewing Colab Enterprise schedulesfrom the command line, see thegcloud CLIdocumentation.

Console

1. In the Google Cloud console, go to the Colab EnterpriseSchedules page.

   Go to Schedules

2. Select a schedule.

3. Clickpause Pause,play_arrow Resume, ordelete Delete.

gcloud

Before using any of the command data below, make the following replacements:

• ACTION: one ofpause,resume, ordelete.
• SCHEDULE_ID: your schedule ID.
• PROJECT_ID: your project ID.
• REGION: the region where your schedule is located.

Execute the following command:

gcloudcolabschedulesACTIONSCHEDULE_ID\--project=PROJECT_ID\--region=REGION

gcloudcolabschedulesACTIONSCHEDULE_ID`--project=PROJECT_ID`--region=REGION

gcloudcolabschedulesACTIONSCHEDULE_ID^--project=PROJECT_ID^--region=REGION

For more information about managing Colab Enterprise schedulesfrom the command line, see thegcloud CLIdocumentation.

Terraform

To learn how to apply or remove a Terraform configuration, seeBasic Terraform commands. For more information, see theTerraform provider reference documentation.

The following sample uses thegoogle_colab_schedule Terraform resource to pause or resume a schedule.

To use this sample, change the value ofdesired_state according to the following:

• PAUSED to pause the schedule
• ACTIVE to resume the schedule

resource"google_colab_runtime_template""my_runtime_template"{name="{{index $.Vars "runtime_template_name"}}"display_name="Runtime template"location="us-central1"machine_spec{machine_type="e2-standard-4"}network_spec{enable_internet_access=true}}resource"google_storage_bucket""output_bucket"{name="{{index $.Vars "bucket"}}"location="US"force_destroy=trueuniform_bucket_level_access=true}resource"google_storage_bucket_object""notebook"{name="hello_world.ipynb"bucket=google_storage_bucket.output_bucket.namecontent=<<EOF{"cells":[{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["print(\"Hello, World!\")"]}],"metadata":{"kernelspec":{"display_name":"Python 3","language":"python","name":"python3"},"language_info":{"codemirror_mode":{"name":"ipython","version":3},"file_extension":".py","mimetype":"text/x-python","name":"python","nbconvert_exporter":"python","pygments_lexer":"ipython3","version":"3.8.5"}},"nbformat":4,"nbformat_minor":4}EOF}resource"google_colab_schedule" "{{$.PrimaryResourceId}}"{display_name="{{index $.Vars "display_name"}}"location="{{index $.TestEnvVars "location"}}"max_concurrent_run_count=2cron="TZ=America/Los_Angeles * * * * *"desired_state="PAUSED"create_notebook_execution_job_request{notebook_execution_job{display_name="Notebook execution"gcs_notebook_source{uri="gs://${google_storage_bucket_object.notebook.bucket}/${google_storage_bucket_object.notebook.name}"generation=google_storage_bucket_object.notebook.generation}notebook_runtime_template_resource_name="projects/${google_colab_runtime_template.my_runtime_template.project}/locations/${google_colab_runtime_template.my_runtime_template.location}/notebookRuntimeTemplates/${google_colab_runtime_template.my_runtime_template.name}"gcs_output_uri="gs://${google_storage_bucket.output_bucket.name}"service_account="{{index $.TestEnvVars "service_account"}}"}}depends_on=[google_colab_runtime_template.my_runtime_template,google_storage_bucket.output_bucket,]}