Menjadwalkan operasi notebook

Halaman ini menjelaskan cara menjadwalkan eksekusi notebook di Colab Enterprise.

Ringkasan

Anda dapat menjadwalkan notebook agar segera dijalankan satu kali, atau sesuai jadwal berulang.

Saat menjadwalkan eksekusi notebook, Anda memilih template runtime. Colab Enterprise menggunakan template runtime ini untuk membuat runtime yang menjalankan notebook Anda.

Runtime memerlukan izin tertentu untuk menjalankan kode notebook dan mengakses layanan serta API. Google Cloud

• Jika konfigurasi template runtime Anda mengaktifkan kredensial pengguna akhir, runtime akan menggunakan izin yang terkait dengan kredensial pengguna Anda.

• Jika kredensial pengguna akhir tidak diaktifkan, Anda harus menentukan akun layanan saat menjadwalkan eksekusi notebook. Colab Enterprise menggunakan kredensial akun layanan ini untuk menjalankan notebook Anda.

Untuk mengetahui informasi selengkapnya, lihat Peran yang diperlukan untuk menjalankan notebook.

Setelah Colab Enterprise menyelesaikan eksekusi notebook, hasilnya akan disimpan di bucket Cloud Storage yang dapat dibagikan.

Batasan

Runtime Colab Enterprise menggunakan kuota Compute Engine. Lihat halaman Kuota alokasi Compute Engine.

Sebelum memulai

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Dataform, and Compute Engine APIs.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Dataform, and Compute Engine APIs.

Enable the APIs

Peran yang diperlukan untuk menjadwalkan eksekusi notebook

Untuk mendapatkan izin yang Anda perlukan untuk menjadwalkan eksekusi notebook di Colab Enterprise, minta administrator untuk memberi Anda peran IAM berikut di project:

• Pengguna Colab Enterprise (roles/aiplatform.colabEnterpriseUser)
• Storage Admin (roles/storage.admin)

Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

Peran yang diperlukan untuk menjalankan notebook

Akun utama yang menjalankan notebook memerlukan izin tertentu. Akun utama adalah akun pengguna Anda atau akun layanan yang Anda tentukan, seperti yang dijelaskan dalam ringkasan.

Untuk mendapatkan izin yang Anda perlukan untuk menjalankan notebook di Colab Enterprise, minta administrator Anda untuk memberi Anda peran IAM berikut:

• Code Viewer (roles/dataform.codeViewer) pada notebook
• Logs Writer (roles/logging.logWriter) di project
• Monitoring Metric Writer (roles/monitoring.metricWriter) di project
• Storage Legacy Bucket Writer (roles/storage.legacyBucketWriter) di notebook
• Storage Legacy Object Reader (roles/storage.legacyObjectReader) di bucket output

Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Peran bawaan ini berisi izin yang diperlukan untuk menjalankan notebook di Colab Enterprise. Untuk melihat izin yang benar-benar diperlukan, luaskan bagian Izin yang diperlukan:

Izin yang diperlukan

Izin berikut diperlukan untuk menjalankan notebook di Colab Enterprise:

• dataform.locations.list di buku catatan
• dataform.repositories.computeAccessTokenStatus di buku catatan
• dataform.repositories.fetchHistory di buku catatan
• dataform.repositories.fetchRemoteBranches di buku catatan
• dataform.repositories.get di buku catatan
• dataform.repositories.getIamPolicy di buku catatan
• dataform.repositories.list di buku catatan
• dataform.repositories.queryDirectoryContents di buku catatan
• dataform.repositories.readFile di buku catatan
• logging.logEntries.create di project
• logging.logEntries.route di project
• monitoring.metricDescriptors.create di project
• monitoring.metricDescriptors.get di project
• monitoring.metricDescriptors.list di project
• monitoring.monitoredResourceDescriptors.get di project
• monitoring.monitoredResourceDescriptors.list di project
• monitoring.timeSeries.create di project
• resourcemanager.projects.get di project
• resourcemanager.projects.list di project
• storage.buckets.get di buku catatan
• storage.managedFolders.create di buku catatan
• storage.managedFolders.delete di buku catatan
• storage.managedFolders.get di buku catatan
• storage.managedFolders.list di buku catatan
• storage.multipartUploads.abort di buku catatan
• storage.multipartUploads.create di buku catatan
• storage.multipartUploads.list di buku catatan
• storage.multipartUploads.listParts di buku catatan
• storage.objects.create di buku catatan
• storage.objects.delete di buku catatan
• storage.objects.get di buku catatan
• storage.objects.list di buku catatan
• storage.objects.restore di buku catatan
• storage.objects.setRetention di buku catatan

Anda mungkin juga bisa mendapatkan izin ini dengan peran khusus atau peran bawaan lainnya.

Menjalankan notebook sekali

Untuk menjalankan notebook satu kali, Anda dapat menggunakan Google Cloud konsol, Google Cloud CLI, library klien Python Vertex AI, atau Terraform.

Konsol

1. Di konsol Google Cloud , buka halaman Notebook saya Colab Enterprise.

   Buka Notebook saya

2. Di menu Region, pilih region yang berisi notebook Anda.

3. Di samping notebook, klik menu more_vertTindakan notebook dan pilih Jadwalkan.

4. Di kolom Nama jadwal, masukkan nama untuk jadwal Anda.

5. Klik daftar Runtime template, lalu pilih template runtime. Template runtime menentukan spesifikasi runtime yang menjalankan notebook Anda.

6. Di bagian Jadwal proses, pilih Sekali saja untuk menjalankan notebook segera setelah Anda mengirimkan proses notebook.

7. Di samping kolom Lokasi output Cloud Storage, klik Telusuri untuk membuka dialog Pilih folder.

8. Pilih bucket Cloud Storage. Atau, untuk membuat bucket, klik  Buat bucket baru dan selesaikan dialog.

9. Jika Anda memilih template runtime tanpa kredensial pengguna akhir yang diaktifkan, dialog ini akan menyertakan kolom Akun layanan. Di kolom Service account, masukkan alamat email akun layanan.

10. Klik Kirim.

    Notebook akan segera dijalankan.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

• DISPLAY_NAME: nama tampilan untuk eksekusi notebook Anda.
• NOTEBOOK_RUNTIME_TEMPLATE: template runtime notebook yang menentukan konfigurasi komputasi runtime Anda.
• NOTEBOOK_URI: URI Cloud Storage dari notebook yang akan dijalankan.
• OUTPUT_URI: lokasi Cloud Storage tempat Anda ingin menyimpan hasil.
• USER_EMAIL: alamat email akun pengguna yang menentukan akses run notebook ke resource Google Cloud .
• PROJECT_ID: project ID Anda.
• REGION: region tempat notebook Anda akan berjalan.

Jalankan perintah berikut:

Linux, macOS, atau Cloud Shell

gcloud colab executions create --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

Windows (PowerShell)

gcloud colab executions create --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

Windows (cmd.exe)

gcloud colab executions create --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

Untuk mengetahui informasi selengkapnya tentang cara mengelola eksekusi notebook Colab Enterprise dari command line, lihat dokumentasi gcloud CLI.

Python

Sebelum mencoba contoh ini, instal Vertex AI SDK untuk Python. Library klien Python Vertex AI diinstal saat Anda menginstal Vertex AI SDK untuk Python. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Vertex AI SDK untuk Python.

Untuk menjalankan contoh kode berikut, Anda memerlukan ID repositori Dataform notebook Anda. Untuk mendapatkan ID repositori notebook Anda, Anda dapat menggunakan metode list_repositories Dataform.

from google.cloud import aiplatform_v1

PROJECT_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

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi penyedia Terraform.

Contoh berikut menggunakan resource Terraform google_colab_notebook_execution untuk menjalankan notebook Colab Enterprise.

resource "google_colab_runtime_template" "my_runtime_template" {
  provider = google-beta
  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" {
  provider = google-beta
  name          = "{{index $.Vars "bucket"}}"
  location      = "US"
  force_destroy = true
  uniform_bucket_level_access = true
}

resource "google_storage_bucket_object" "notebook" {
  provider = google-beta
  name   = "hello_world.ipynb"
  bucket = google_storage_bucket.output_bucket.name
  content = <<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-beta
  notebook_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,
  ]

}

Anda dapat melihat hasil dari operasi notebook yang telah selesai di halaman Eksekusi.

Menjadwalkan operasi notebook

Untuk menjadwalkan eksekusi notebook, Anda dapat menggunakan Google Cloud konsol, gcloud CLI, library klien Python Vertex AI, atau Terraform.

Konsol

1. Di konsol Google Cloud , buka halaman Notebook saya Colab Enterprise.

   Buka Notebook saya

2. Di menu Region, pilih region yang berisi notebook Anda.

3. Di samping notebook, klik menu more_vertTindakan notebook dan pilih Jadwalkan.

4. Di kolom Nama jadwal, masukkan nama untuk jadwal Anda.

5. Klik daftar Runtime template, lalu pilih template runtime. Template runtime menentukan spesifikasi runtime yang menjalankan notebook Anda.

6. Di bagian Jadwal proses, pilih Berulang untuk menjadwalkan proses notebook pada interval waktu tertentu.

7. Selesaikan dialog penjadwalan.

8. Di samping kolom Lokasi output Cloud Storage, klik Telusuri untuk membuka dialog Pilih folder.

9. Pilih bucket Cloud Storage. Atau, untuk membuat bucket, klik  Buat bucket baru dan selesaikan dialog.

10. Jika Anda memilih template runtime tanpa kredensial pengguna akhir yang diaktifkan, dialog ini akan menyertakan kolom Akun layanan. Di kolom Service account, masukkan alamat email akun layanan.

11. Klik Kirim.

    Operasi notebook terjadwal akan dimulai secara otomatis sesuai jadwal yang Anda tetapkan.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

• DISPLAY_NAME: nama tampilan jadwal Anda.
• CRON_SCHEDULE: jadwal yang Anda tetapkan, dalam format unix-cron. Misalnya, 00 19 * * MON berarti setiap minggu pada hari Senin, pukul 1900 Waktu Greenwich (GMT).
• NOTEBOOK_RUN_NAME: nama tampilan untuk eksekusi notebook yang dihasilkan oleh jadwal ini.
• NOTEBOOK_RUNTIME_TEMPLATE: template runtime notebook yang menentukan konfigurasi komputasi runtime Anda.
• NOTEBOOK_URI: URI Cloud Storage dari notebook yang akan dijalankan.
• OUTPUT_URI: lokasi Cloud Storage tempat Anda ingin menyimpan hasil.
• USER_EMAIL: alamat email akun pengguna yang menentukan akses run notebook ke resource Google Cloud .
• PROJECT_ID: project ID Anda.
• REGION: region tempat jadwal Anda akan berjalan.

Jalankan perintah berikut:

Linux, macOS, atau Cloud Shell

gcloud colab schedules create --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

Windows (PowerShell)

gcloud colab schedules create --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

Windows (cmd.exe)

gcloud colab schedules create --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

Untuk mengetahui informasi selengkapnya tentang cara membuat jadwal notebook Colab Enterprise dari command line, lihat dokumentasi gcloud CLI.

Python

Sebelum mencoba contoh ini, instal Vertex AI SDK untuk Python. Library klien Python Vertex AI diinstal saat Anda menginstal Vertex AI SDK untuk Python. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Vertex AI SDK untuk Python.

Untuk menjalankan contoh kode berikut, Anda memerlukan ID repositori Dataform notebook Anda. Untuk mendapatkan ID repositori notebook Anda, Anda dapat menggunakan metode list_repositories Dataform.

from google.cloud import aiplatform_v1

PROJECT_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

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi penyedia Terraform.

Contoh berikut menggunakan resource Terraform google_colab_schedule untuk menjadwalkan eksekusi notebook Colab Enterprise.

resource "google_colab_runtime_template" "my_runtime_template" {
  provider = google-beta
  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" {
  provider = google-beta
  name          = "{{index $.Vars "bucket"}}"
  location      = "US"
  force_destroy = true
  uniform_bucket_level_access = true
}

resource "google_secret_manager_secret" "secret" {
  provider = google-beta
  secret_id = "{{index $.Vars "secret"}}"
  replication {
    auto {}
  }
}

resource "google_secret_manager_secret_version" "secret_version" {
  provider = google-beta
  secret = google_secret_manager_secret.secret.id
  secret_data = "secret-data"
}

resource "google_dataform_repository" "dataform_repository" {
  provider = google-beta
  name = "{{index $.Vars "dataform_repository"}}"
  display_name = "dataform_repository"
  npmrc_environment_variables_secret_version = google_secret_manager_secret_version.secret_version.id
  kms_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-beta
  display_name = "{{index $.Vars "display_name"}}"
  location = "{{index $.TestEnvVars "location"}}"
  allow_queueing = true
  max_concurrent_run_count = 2
  cron = "TZ=America/Los_Angeles * * * * *"
  max_run_count = 5
  start_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,
  ]
}

Di konsol Google Cloud , Anda dapat melihat jadwal di halaman Schedules. Anda dapat melihat hasil dari operasi notebook yang telah selesai di halaman Eksekusi.

Melihat hasilnya

Untuk melihat hasil eksekusi notebook, Anda dapat menggunakan konsol Google Cloud , gcloud CLI, atau library klien Vertex AI Python.

Konsol

1. Di konsol Google Cloud , buka halaman Eksekusi Colab Enterprise.

   Buka Executions

2. Di samping eksekusi notebook yang ingin Anda lihat hasilnya, klik Lihat hasil.

   Colab Enterprise akan membuka hasil eksekusi notebook di tab baru.

3. Untuk melihat hasilnya, klik tab.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

• PROJECT_ID: project ID Anda.
• REGION: region tempat hasil eksekusi notebook Anda berada.
• SCHEDULE_NAME: nama jadwal untuk melihat hasilnya. Untuk melihat hasil dari semua jadwal, hilangkan tanda --filter.

Jalankan perintah berikut:

Linux, macOS, atau Cloud Shell

gcloud colab executions list --project=PROJECT_ID \
    --region=REGION \
    --filter="scheduleResourceName:SCHEDULE_NAME"

Windows (PowerShell)

gcloud colab executions list --project=PROJECT_ID `
    --region=REGION `
    --filter="scheduleResourceName:SCHEDULE_NAME"

Windows (cmd.exe)

gcloud colab executions list --project=PROJECT_ID ^
    --region=REGION ^
    --filter="scheduleResourceName:SCHEDULE_NAME"

Untuk mengetahui informasi selengkapnya tentang mencantumkan eksekusi notebook Colab Enterprise dari command line, lihat dokumentasi gcloud CLI.

Python

Sebelum mencoba contoh ini, instal Vertex AI SDK untuk Python. Library klien Python Vertex AI diinstal saat Anda menginstal Vertex AI SDK untuk Python. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Vertex AI SDK untuk Python.

Untuk menjalankan contoh kode berikut, Anda memerlukan ID repositori Dataform notebook Anda. Untuk mendapatkan ID repositori notebook Anda, Anda dapat menggunakan metode list_repositories Dataform.

from google.cloud import aiplatform_v1

PROJECT_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

Menghapus hasil

Untuk menghapus hasil dari salah satu eksekusi notebook, Anda dapat menggunakan konsol Google Cloud atau gcloud CLI.

Konsol

1. Di konsol Google Cloud , buka halaman Eksekusi Colab Enterprise.

   Buka Executions

2. Pilih eksekusi notebook yang hasilnya ingin Anda hapus.

3. Klik delete Hapus.

4. Untuk mengonfirmasi penghapusan, klik Konfirmasi.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

• NOTEBOOK_RUN_ID: ID operasi notebook yang ingin Anda hapus.
• PROJECT_ID: project ID Anda.
• REGION: region tempat eksekusi notebook Anda berada.

Jalankan perintah berikut:

Linux, macOS, atau Cloud Shell

gcloud colab executions delete NOTEBOOK_RUN_ID \
    --project=PROJECT_ID \
    --region=REGION

Windows (PowerShell)

gcloud colab executions delete NOTEBOOK_RUN_ID `
    --project=PROJECT_ID `
    --region=REGION

Windows (cmd.exe)

gcloud colab executions delete NOTEBOOK_RUN_ID ^
    --project=PROJECT_ID ^
    --region=REGION

Untuk mengetahui informasi selengkapnya tentang cara menghapus eksekusi notebook Colab Enterprise dari command line, lihat dokumentasi gcloud CLI.

Membagikan hasil operasi notebook

Anda dapat membagikan hasil operasi notebook dengan memberikan akses ke bucket Cloud Storage yang berisi operasi notebook Anda. Dengan menyediakan akses ini, pengguna juga akan memiliki akses ke resource lain di bucket Cloud Storage yang sama (lihat Pertimbangan keamanan).

Untuk mengetahui informasi selengkapnya, lihat halaman Berbagi dan kolaborasi Cloud Storage.

Pertimbangan keamanan

Hasil eksekusi notebook Anda disimpan sebagai file notebook (IPYNB) di bucket Cloud Storage. Pertimbangkan hal berikut saat Anda memberikan akses ke bucket ini:

• Siapa pun yang memiliki akses ke bucket dapat melihat kode file notebook dan hasil menjalankan notebook.

• Siapa saja yang dapat mengubah isi bucket dapat mengubah isi file notebook.

Jika jadwal Anda dikonfigurasi untuk menggunakan kredensial pribadi, hanya pengguna yang ditentukan yang dapat mengubah atau memicu jadwal.

Jika jadwal Anda dikonfigurasi untuk menggunakan akun layanan, hanya pengguna dengan izin iam.serviceAccounts.actAs di akun layanan yang dapat mengubah jadwal atau memicu jadwal.

Melihat detail jadwal

Anda dapat melihat informasi tentang jadwal, termasuk:

• Bucket Cloud Storage tempat jadwal menyimpan hasil.
• Waktu mulai dan berakhir.
• Frekuensi.

Untuk melihat detail jadwal, Anda dapat menggunakan konsol Google Cloud atau gcloud CLI.

Konsol

1. Di konsol Google Cloud , buka halaman Jadwal Colab Enterprise.

   Buka Jadwal

2. Klik nama jadwal.

   Halaman Schedule details akan terbuka.

3. Untuk kembali ke halaman Jadwal, klik arrow_back Kembali ke halaman sebelumnya.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

• SCHEDULE: ID jadwal Anda.
• PROJECT_ID: project ID Anda.
• REGION: region tempat jadwal Anda berada.

Jalankan perintah berikut:

Linux, macOS, atau Cloud Shell

gcloud colab schedules describe SCHEDULE \
    --project=PROJECT_ID \
    --region=REGION

Windows (PowerShell)

gcloud colab schedules describe SCHEDULE `
    --project=PROJECT_ID `
    --region=REGION

Windows (cmd.exe)

gcloud colab schedules describe SCHEDULE ^
    --project=PROJECT_ID ^
    --region=REGION

Untuk mengetahui informasi selengkapnya tentang cara melihat jadwal Colab Enterprise dari command line, lihat dokumentasi gcloud CLI.

Menjeda, melanjutkan, atau menghapus jadwal

Untuk menjeda, melanjutkan, atau menghapus jadwal, Anda dapat menggunakan konsol Google Cloud , gcloud CLI, atau Terraform.

Konsol

1. Di konsol Google Cloud , buka halaman Jadwal Colab Enterprise.

   Buka Jadwal

2. Pilih jadwal.

3. Klik pause Jeda, play_arrow Lanjutkan, atau delete Hapus.

gcloud

Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:

• ACTION: salah satu dari pause, resume, atau delete.
• SCHEDULE_ID: ID jadwal Anda.
• PROJECT_ID: project ID Anda.
• REGION: region tempat jadwal Anda berada.

Jalankan perintah berikut:

Linux, macOS, atau Cloud Shell

gcloud colab schedules ACTION SCHEDULE_ID \
    --project=PROJECT_ID \
    --region=REGION

Windows (PowerShell)

gcloud colab schedules ACTION SCHEDULE_ID `
    --project=PROJECT_ID `
    --region=REGION

Windows (cmd.exe)

gcloud colab schedules ACTION SCHEDULE_ID ^
    --project=PROJECT_ID ^
    --region=REGION

Untuk mengetahui informasi selengkapnya tentang cara mengelola jadwal Colab Enterprise dari command line, lihat dokumentasi gcloud CLI.

Terraform

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi penyedia Terraform.

Contoh berikut menggunakan resource Terraform google_colab_schedule untuk menjeda atau melanjutkan jadwal.

Untuk menggunakan sampel ini, ubah nilai desired_state sesuai dengan berikut ini:

• PAUSED untuk menjeda jadwal
• ACTIVE untuk melanjutkan jadwal

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 = true
  uniform_bucket_level_access = true
}

resource "google_storage_bucket_object" "notebook" {
  name   = "hello_world.ipynb"
  bucket = google_storage_bucket.output_bucket.name
  content = <<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 = 2
  cron = "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,
  ]
}

Langkah berikutnya

• Untuk menemukan notebook yang dapat membantu Anda memulai project dengan cepat, lihat galeri notebook.

• Pelajari lebih lanjut runtime dan template runtime.

• Pelajari cara membuat template runtime.

• Pelajari lebih lanjut cara mengakses Google Cloud layanan dan API di notebook Anda.