Skip to content
In order to view the full documentation for the Deployment Engine application, you should  log in.

Colab Enterprise Notebooks

What is Colab Enterprise?

Colab Enterprise is a collaborative managed notebook environment on Google Cloud that combines the ease of use of Google Colab with enterprise-level security and compliance. It integrates seamlessly with Google Cloud services like BigQuery and Vertex AI, offering a powerful platform for data scientists and ML engineers to work with OSDU data.

For more information, see the Official Colab Enterprise Documentation.

How to Install Colab Enterprise Jupyter Notebooks for OSDU

You can automatically provision Colab Enterprise along with your OSDU deployment via the Deployment Engine UI:

  1. In the Deployment Engine UI, start a new deployment.
  2. Proceed to the Optional Services configuration step.
  3. Select Colab Enterprise Notebooks from the list of optional services.
  4. Provide an OAuth Client ID and OAuth Client Secret. You can generate these credentials in your Google Cloud Console under APIs & Services > Credentials.
  5. Once your deployment is successfully completed, you will see a direct link to the Colab Enterprise Notebooks Bucket in the Project Information tab.

How to Import Notebooks from Bucket to Colab Enterprise

During the deployment, OSDU Jupyter notebooks are automatically provisioned in a dedicated Google Cloud Storage bucket associated with your project.

The bucket name uses the following template:
<project-id>-colab-jupyter-notebooks

You can import these notebooks directly into Colab Enterprise:

  1. Navigate to Colab Enterprise in the Google Cloud Console (under Vertex AI).
  2. Go to My notebooks.
  3. In the interface, click the Import button.

Go to My Notebooks and click Import

  1. Select the Cloud Storage tab and click the Browse button.

Select Cloud Storage and click Browse

  1. Browse or search for your dedicated bucket: <project-id>-colab-jupyter-notebooks.
  2. Select the .ipynb notebook file you wish to add and click the Select button.

Select notebook and click Select

  1. If you want to add another notebook, click Add notebook and choose the next file.
  2. When all files are in the list, click the Import button.

Choose notebooks and click the Import button

How to Run the Notebook in Colab

After importing your notebooks into the Colab Enterprise workspace:

  1. Click on the imported .ipynb file in your Colab Enterprise file browser.
  2. In the top-right corner of the interface, click Connect to allocate compute resources to your notebook.
  3. Run the notebook cells sequentially by clicking the Play button next to each cell, or by selecting a cell and pressing Shift + Enter.
  4. If a notebook requires access to Google Cloud or OSDU APIs, ensure you run any required authentication or setup blocks provided within the notebook cells before executing the main logic.