Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Executar execuções de notebook com parâmetros
As instâncias de notebooks gerenciados do Vertex AI Workbench
permitem usar valores de parâmetro nas execuções de notebook
para especificar diferenças na forma como o código do arquivo de notebook é executado.
Nesta página, você verá como configurar o arquivo de notebook para usar parâmetros e como gerar execuções que especificam valores diferentes para os parâmetros de notebook.
Use parâmetros para executar iterações diferentes do arquivo de notebook
É possível usar os valores de parâmetro do notebook nas execuções para executar o mesmo código do notebook, especificando diferenças como as seguintes:
Especifique um conjunto de dados diferente ou um tamanho de amostra diferente
para ser usado.
Especifique diferentes configurações de modelo, como taxa de aprendizado ou tipo de otimizador.
Execute modelos diferentes ou versões diferentes do mesmo modelo.
Como usar parâmetros em uma execução de notebook
O processo para executar um notebook com parâmetros tem duas etapas principais:
Adicione a tag parameters a uma das células do arquivo de notebook.
Embora não seja um requisito técnico, essa célula normalmente contém código que atribui valores a suas variáveis de parâmetro.
Se você não atribuir valores de parâmetro diferentes na sua execução, ela usará os valores de parâmetro no arquivo do notebook como valores padrão.
Crie uma execução para o arquivo de notebook que inclua novos valores para os parâmetros. Use o
padrão a seguir para formatar os parâmetros e os valores deles:
parameter1=value1,parameter2=value2. O formato requer vírgulas
entre pares de parâmetros/valores, sem espaços e aspas.
Quando a execução é gerada, o executor adiciona uma célula ao notebook que atualiza os valores dos parâmetros logo após a célula marcada como parameters.
Antes de começar
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 garantir que a conta de serviço da instância tenha as permissões necessárias
para interagir com o executor do Vertex AI Workbench,
peça ao administrador para conceder a ela os seguintes
papéis do IAM no projeto:
O administrador também pode conceder à conta de serviço da instância
as permissões necessárias por meio de papéis
personalizados ou de outros papéis
predefinidos.
Abrir JupyterLab
Para abrir o JupyterLab e preparar um arquivo de notebook para ser executado, conclua as etapas a seguir.
Faça upload de um arquivo de notebook (ipynb), abra um atual ou abra um novo arquivo de notebook e adicione o código que você quer executar no novo notebook.
Adicionar a tag parameters a uma célula do notebook
Na interface do usuário do JupyterLab da instância de notebooks gerenciados, abra o arquivo de notebook que você quer executar.
Escreva o código em uma célula que atribua valores às suas variáveis de parâmetro.
Esses são os valores que o arquivo de notebook usará se você não atribuir valores de parâmetro diferentes na execução.
Verifique se a célula de parâmetros ainda está selecionada e, na barra lateral direita, clique no
Inspetor de propriedades.
No inspetor de propriedade, na seção Tags de célula,
clique em Adicionar tag, digite parameters e pressione Enter.
Fornecer valores de parâmetro para a execução
Na interface do usuário do JupyterLab da instância de notebooks gerenciados, clique no botão Executor.
Na caixa de diálogo Enviar notebooks para o Executor, insira um nome para sua execução no campo Nome da execução.
Selecione um tipo de máquina e um tipo de acelerador.
Selecione um Ambiente.
No campo Tipo, selecione Execução única ou Execuções recorrentes baseadas em programação e complete a caixa de diálogo para programar execuções.
Em Opções avançadas,
selecione a Região em que você quer executar o notebook.
No campo bucket do Cloud Storage, selecione um bucket disponível ou digite um nome para um novo bucket e clique em Criar e selecionar.
O executor armazena a saída do notebook
nesse bucket do Cloud Storage.
Na seção Parametrização do notebook, na caixa de texto Parâmetros de entrada, adicione os parâmetros do notebook separados por vírgulas, por exemplo, optimizer=SGD,learning_rate=0.01. O formato requer a falta de espaços e aspas.
Configure o restante da execução e clique em Enviar.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-18 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)."]]