Create an experiment

This page shows you how to interact with Experiments on Gemini Enterprise Agent Platform by using the side panel in Colab Enterprise.

To access Google Cloud services and APIs by running code in your Colab Enterprise notebook, you can use the credentials associated with your Google Account. To learn more, see Access Google Cloud services and APIs.

The side panel is an additional way to interact with Experiments on Agent Platform without leaving the Colab Enterprise interface.

The side panel appears to the right of an open notebook.

[Buttons on the side panel to the right of an open notebook]

Before you begin

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.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Agent Platform, Dataform, and Compute Engine APIs.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the APIs

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Agent Platform, Dataform, and Compute Engine APIs.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the APIs

Required roles

To get the permissions that you need to use the side panel in a Colab Enterprise notebook, ask your administrator to grant you the following IAM roles on the project:

• Colab Enterprise User (roles/aiplatform.colabEnterpriseUser)
• Agent Platform User (roles/aiplatform.user)

For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

Experiments on Agent Platform

Experiments on Agent Platform helps you track and analyze different model architectures, hyperparameters, and training environments by letting you track the steps, inputs, and outputs of an experiment run. To learn more, see Introduction to Experiments on Agent Platform.

Create and view an experiment

You can create and view the results of an experiment by using the side panel in Colab Enterprise.

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

   Go to My notebooks

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

3. Click the notebook that you want to open. If you haven't created a notebook yet, create a notebook.

4. To the right of your notebook, in the side panel, click the [icon-manage-experiments.png] Experiments button.

   The side panel expands the Experiments tab.

5. Click the Insert sample code button.

   Colab Enterprise adds code cells to your notebook for interacting with an experiment.

6. In your notebook, find the code cell that stores parameter values. You'll use these parameters to interact with Experiments on Agent Platform.

7. Update the values for the following parameters:

   • PROJECT_ID: The ID of the project that your notebook is in.
   • REGION: The region that your notebook is in.
   • BUCKET_URI: A Cloud Storage bucket URI, in the format gs://BUCKET_NAME. This can be an existing bucket, or you can create it when you run the code. This bucket must be in the same project and region as your Colab Enterprise notebook.
   • EXPERIMENT_NAME: The name of your experiment. If your experiment doesn't exist, Experiments on Agent Platform creates one.

8. If you need to create your Cloud Storage bucket, find and uncomment the following line of code:

   # ! gcloud storage buckets create {BUCKET_URI} --location={REGION} --project={PROJECT_ID}
   

9. Run the code cells that the side panel added to your notebook.

10. After the last code cell runs, click the [icon-manage-experiments.png] View experiment button that appears.

11. In the side panel, click the Runs tab or Details tab to see information about your experiment. To learn more, see Create and manage experiment runs.

    The side panel shows information about your experiment runs. You can create, manage, and delete runs by using Experiments on Agent Platform in the Google Cloud console or through the Agent Platform API.

What's next

• Learn more about Experiments on Agent Platform.

• To find a notebook that can help you get your project started quickly, see the notebook gallery.