Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Ejecuta ejecuciones de notebook con parámetros
Las instancias de notebooks administrados de Vertex AI Workbench te permiten usar valores de parámetros en las ejecuciones de notebooks para especificar diferencias en la forma en que se ejecuta el código de tu archivo de notebook.
En esta página, se describe cómo configurar tu archivo de notebook a fin de usar parámetros y cómo ejecutar ejecuciones que especifiquen valores diferentes para los parámetros del notebook.
Usa parámetros para ejecutar diferentes iteraciones de tu archivo de notebook
Puedes usar valores de parámetros de notebook en tus ejecuciones para ejecutar el mismo código de notebook y especificar diferencias como las siguientes:
Especifica un conjunto de datos diferente que quieras usar o un tamaño de muestra diferente del conjunto de datos.
Especifica diferentes configuraciones de modelos, como la tasa de aprendizaje o el tipo de optimizador.
Ejecuta diferentes modelos o diferentes versiones del mismo modelo.
Cómo usar parámetros en la ejecución de un notebook
El proceso de ejecución de un notebook con parámetros tiene dos pasos principales:
Agrega la etiqueta parameters a una de las celdas de tu archivo de notebook.
Si bien no es un requisito técnico, por lo general, esta celda contiene código que asigna valores a las variables de parámetros, aunque este no es un requisito técnico.
Si no asignas valores de parámetros diferentes en tu ejecución, la ejecución usa los valores de parámetros en tu archivo de notebook como valores predeterminados.
Crea una ejecución para tu archivo de notebook que incluya valores nuevos de tus parámetros. Usa el siguiente patrón para dar formato a los parámetros y sus valores: parameter1=value1,parameter2=value2. El formato requiere comas entre pares de valores de parámetros, sin espacios ni comillas.
Cuando se ejecuta la ejecución, el ejecutor agrega una celda al notebook que actualiza los valores de tus parámetros directamente después de la celda etiquetada como parameters.
Antes de comenzar
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.
Para garantizar que la cuenta de servicio de tu instancia tenga los permisos necesarios para interactuar con el ejecutor de Vertex AI Workbench, pídele a tu administrador que le otorgue a la cuenta de servicio de tu instancia los siguientes roles de IAM en el proyecto:
Es posible que tu administrador también pueda otorgar a la cuenta de servicio de tu instancia los permisos necesarios mediante roles personalizados o con otros roles predefinidos.
Abre JupyterLab
Si deseas abrir JupyterLab y preparar un archivo de notebook para que se ejecute, completa los siguientes pasos.
Sube un archivo de notebook (ipynb), abre un archivo existente o abre un archivo de notebook nuevo y agrega al notebook nuevo el código que deseas ejecutar.
Agrega la etiqueta parameters a una celda de notebook
En la interfaz de usuario de JupyterLab de tu instancia de notebooks administrados, abre el archivo de notebook que deseas ejecutar.
Escribe código en una celda que asigne valores a tus variables de parámetros.
Estos son los valores que usa el archivo de notebook si no asignas valores de parámetros diferentes en la ejecución.
Asegúrate de que la celda de parámetros aún esté seleccionada y, luego, en la barra lateral derecha, haz clic en Inspector de propiedades.
En el inspector de propiedades, en la sección Etiquetas de celda, haz clic en Agregar etiqueta, ingresa parameters y, luego, presiona Enter.
Proporciona valores de parámetros para tu ejecución
En la interfaz de usuario de JupyterLab de tu instancia de notebooks administrados, haz clic en el botón Ejecutor.
En el diálogo Enviar notebooks al ejecutor, ingresa un nombre para tu ejecución en el campo Nombre de ejecución.
Selecciona un Tipo de máquina y un Tipo de acelerador.
Selecciona un entorno.
En el campo Tipo, selecciona Ejecución única o Ejecuciones recurrentes basadas en el programa y completa el cuadro de diálogo a fin de programar ejecuciones.
En Opciones avanzadas, selecciona la Región en la que deseas ejecutar el notebook.
En el campo Bucket de Cloud Storage, selecciona un bucket de Cloud Storage disponible o ingresa un nombre para un bucket nuevo y haz clic en Crear y seleccionar.
El ejecutor almacena el resultado de tu notebook en este bucket de Cloud Storage.
En la sección Parametrización del notebook, en el cuadro de texto Parámetros de entrada, agrega parámetros de notebook separados por comas, como optimizer=SGD,learning_rate=0.01. El formato requiere que no haya espacios ni comillas.
Configura el resto de tu ejecución y, luego, haz clic en Enviar.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-04 (UTC)"],[],[],null,["# Run notebook executions with parameters\n=======================================\n\n\n| Vertex AI Workbench managed notebooks is\n| [deprecated](/vertex-ai/docs/deprecations). On\n| April 14, 2025, support for\n| managed notebooks will end and the ability to create managed notebooks instances\n| will be removed. Existing instances will continue to function\n| but patches, updates, and upgrades won't be available. To continue using\n| Vertex AI Workbench, we recommend that you\n| [migrate\n| your managed notebooks instances to Vertex AI Workbench instances](/vertex-ai/docs/workbench/managed/migrate-to-instances).\n\n\u003cbr /\u003e\n\nVertex AI Workbench managed notebooks instances\nlet you use parameter values in your notebook executions\nto specify differences in how your notebook file's code runs.\nThis page describes how to set up your notebook file to use parameters\nand how to run executions that specify different values\nfor your notebook parameters.\n\nUse parameters to run different iterations of your notebook file\n----------------------------------------------------------------\n\nYou can use notebook parameter values in your executions\nto run the same notebook code while specifying differences like the following:\n\n- Specify a different dataset to use, or a different sample size\n of the dataset.\n\n- Specify different model configurations such as learning rate or\n optimizer type.\n\n- Run different models, or run different versions of the same model.\n\nHow to use parameters in a notebook execution\n---------------------------------------------\n\nThe process for executing a notebook with parameters has two main steps:\n\n1. [Add the `parameters` tag to one of your notebook file's cells](#add-tag).\n While this isn't a technical requirement, this cell\n typically contains code that assigns values to your parameter\n variables, though this is not a technical requirement.\n If you don't assign different parameter values in your execution,\n the execution uses the parameter values in your notebook file\n as default values.\n\n2. [Create an execution for your notebook file that includes\n new values for your parameters](#provide-values). Use the\n following pattern to format your parameters and their values:\n `parameter1=value1,parameter2=value2`. The format requires commas\n between parameter-value pairs, no spaces, and no quotation marks.\n When your execution runs,\n the executor adds a cell to the notebook that updates the\n values of your parameters directly following the cell that\n is tagged `parameters`.\n\nBefore you begin\n----------------\n\n- Sign in to your Google Cloud account. If you're new to Google Cloud, [create an account](https://console.cloud.google.com/freetrial) to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.\n- In the Google Cloud console, on the project selector page,\n select or create a Google Cloud project.\n\n | **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.\n\n [Go to project selector](https://console.cloud.google.com/projectselector2/home/dashboard)\n-\n [Verify that billing is enabled for your Google Cloud project](/billing/docs/how-to/verify-billing-enabled#confirm_billing_is_enabled_on_a_project).\n\n-\n\n\n Enable the Notebooks and Vertex AI APIs.\n\n\n [Enable the APIs](https://console.cloud.google.com/flows/enableapi?apiid=notebooks.googleapis.com,aiplatform.googleapis.com)\n\n- In the Google Cloud console, on the project selector page,\n select or create a Google Cloud project.\n\n | **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.\n\n [Go to project selector](https://console.cloud.google.com/projectselector2/home/dashboard)\n-\n [Verify that billing is enabled for your Google Cloud project](/billing/docs/how-to/verify-billing-enabled#confirm_billing_is_enabled_on_a_project).\n\n-\n\n\n Enable the Notebooks and Vertex AI APIs.\n\n\n [Enable the APIs](https://console.cloud.google.com/flows/enableapi?apiid=notebooks.googleapis.com,aiplatform.googleapis.com)\n\n1. If you haven't already, [create\n a managed notebooks instance](/vertex-ai/docs/workbench/managed/create-instance#create).\n\n### Required roles\n\n\nTo ensure that your instance's service account has the necessary\npermissions to interact with the Vertex AI Workbench executor,\n\nask your administrator to grant your instance's service account the\nfollowing IAM roles on the project:\n\n| **Important:** You must grant these roles to your instance's service account, *not* to your user account. Failure to grant the roles to the correct principal might result in permission errors.\n\n- Notebooks Viewer ([`roles/notebooks.viewer`](/vertex-ai/docs/workbench/instances/iam#notebooks.viewer))\n- Vertex AI User ([`roles/aiplatform.user`](/vertex-ai/docs/general/access-control#aiplatform.user))\n- Storage Admin ([`roles/storage.admin`](/storage/docs/access-control/iam-roles#standard-roles))\n\n\nFor more information about granting roles, see [Manage access to projects, folders, and organizations](/iam/docs/granting-changing-revoking-access).\n\n\nYour administrator might also be able to give your instance's service account\nthe required permissions through [custom\nroles](/iam/docs/creating-custom-roles) or other [predefined\nroles](/iam/docs/roles-overview#predefined).\n\nOpen JupyterLab\n---------------\n\nTo open JupyterLab and prepare a notebook file to run,\ncomplete the following steps.\n\n1. [Open JupyterLab](/vertex-ai/docs/workbench/managed/create-managed-notebooks-instance-console-quickstart#open-jupyterlab).\n\n2. Upload a notebook (ipynb) file, open an existing file,\n or [open a new notebook\n file](/vertex-ai/docs/workbench/managed/create-managed-notebooks-instance-console-quickstart#open-a-new-notebook-file)\n and add the code that you want to run to the new notebook.\n\n3. Make sure your notebook file's code meets the [requirements\n for using the executor](/vertex-ai/docs/workbench/managed/executor#requirements).\n\nAdd the `parameters` tag to a notebook cell\n-------------------------------------------\n\n1. In your managed notebooks instance's\n JupyterLab user interface, open the notebook file that you want to run.\n\n2. Write code in one cell that assigns values to\n your parameter variables.\n These are the values your notebook file uses if\n you don't assign different parameter values in your execution.\n\n3. Make sure your parameters cell is still selected, and then\n in the right sidebar, click the\n **Property inspector**.\n\n4. In the property inspector, in the **Cell Tags** section,\n click **Add Tag** , enter `parameters`, and then press `Enter`.\n\n | **Note:** If you tag more than one cell with `parameters`, the executor adds only one parameters cell directly following the first cell with the `parameters` tag.\n\nProvide parameter values for your execution\n-------------------------------------------\n\n1. In your managed notebooks instance's\n JupyterLab user interface, click the\n **Executor** button.\n\n2. In the **Submit notebooks to Executor** dialog,\n enter a name for your execution in the **Execution name** field.\n\n3. Select a **Machine type** and **Accelerator type**.\n\n4. Select an **Environment**.\n\n5. In the **Type** field,\n select **One-time execution** , or\n select **Schedule-based recurring executions**, and complete\n the dialog for scheduling executions.\n\n6. In **Advanced options** ,\n select the **Region** where you want to run your notebook.\n\n7. In the **Cloud Storage bucket** field,\n select an available Cloud Storage bucket or\n enter a name for a new bucket and click **Create and select**.\n The executor stores your notebook output\n in this Cloud Storage bucket.\n\n8. In the **Notebook parameterization** section\n and the **Input parameters** text box,\n add notebook parameters separated by commas, for example\n `optimizer=SGD,learning_rate=0.01`. The format requires\n that there are no spaces and no quotation marks.\n\n9. Configure the rest of your execution, and then click **Submit**.\n\nWhat's next\n-----------\n\n- Learn more about [how to run notebook code in\n the executor](/vertex-ai/docs/workbench/managed/executor)."]]