Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Exécuter des exécutions de notebook avec des paramètres
Les instances de notebooks gérés de Vertex AI Workbench vous permettent d'utiliser des valeurs de paramètres dans vos exécutions de notebook pour spécifier les différences d'exécution du code de votre fichier notebook.
Cette page explique comment configurer le fichier notebook pour utiliser des paramètres et comment exécuter des exécutions spécifiant des valeurs différentes pour les paramètres de vos notebooks.
Utiliser des paramètres pour exécuter différentes itérations de votre fichier notebook
Vous pouvez utiliser les valeurs des paramètres de notebook dans vos exécutions pour exécuter le même code de notebook, tout en spécifiant des différences telles que :
Spécifier un autre ensemble de données à utiliser ou une taille d'échantillon différente.
Spécifier différentes configurations de modèle, telles que le taux d'apprentissage ou le type d'optimiseur.
Exécuter différents modèles ou différentes versions du même modèle.
Utiliser des paramètres dans une exécution de notebook
Le processus d'exécution d'un notebook avec des paramètres comporte deux étapes principales :
Ajoutez le tag parameters à l'une des cellules de votre fichier notebook.
Bien qu'il ne s'agisse pas d'une exigence technique, cette cellule contient généralement du code qui attribue des valeurs à vos variables de paramètre.
Si vous n'attribuez pas différentes valeurs de paramètre dans votre exécution, celle-ci utilise les valeurs de paramètre de votre fichier notebook comme valeurs par défaut.
Créez une exécution pour votre fichier notebook incluant de nouvelles valeurs pour vos paramètres. Utilisez le modèle suivant pour mettre en forme vos paramètres et leurs valeurs : parameter1=value1,parameter2=value2. Le format requiert des virgules entre les paires paramètre/valeur, aucun espace et aucun guillemet.
Lorsque votre exécution s'exécute, l'exécuteur ajoute une cellule au notebook qui met à jour les valeurs de vos paramètres, directement après la cellule portant le tag parameters.
Avant de commencer
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.
Pour vous assurer que le compte de service de votre instance dispose des autorisations nécessaires pour interagir avec l'exécuteur Vertex AI Workbench, demandez à votre administrateur d'accorder au compte de service de votre instance le rôle IAM suivant sur le projet :
Votre administrateur peut également attribuer au compte de service de votre instance les autorisations requises à l'aide de rôles personnalisés ou d'autres rôles prédéfinis.
Ouvrir JupyterLab
Pour ouvrir JupyterLab et préparer un fichier notebook à exécuter, procédez comme suit.
Importez un fichier de notebook (ipynb), ouvrez un fichier existant ou ouvrez un nouveau fichier notebook, puis ajoutez le code que vous souhaitez exécuter sur le nouveau notebook.
Ajouter le tag parameters à une cellule de notebook
Dans l'interface utilisateur de JupyterLab de votre instance de notebooks gérés, ouvrez le fichier de notebook que vous souhaitez exécuter.
Écrivez du code dans une cellule qui attribue des valeurs à vos variables de paramètre.
Il s'agit des valeurs utilisées par votre fichier notebook si vous n'attribuez pas différentes valeurs de paramètre lors de votre exécution.
Assurez-vous que la cellule des paramètres est toujours sélectionnée, puis cliquez sur l'Inspecteur de propriétés dans la barre latérale droite.
Dans l'inspection des propriétés, dans la section Tags de cellule, cliquez sur Ajouter un tag, saisissez parameters, puis appuyez sur Enter.
Fournir des valeurs de paramètres pour votre exécution
Dans l'interface utilisateur JupyterLab de votre instance de notebooks gérés, cliquez sur le bouton Exécuteur.
Dans la boîte de dialogue Envoyer les notebooks à l'exécuteur, saisissez un nom pour votre exécution dans le champ Nom de l'exécution.
Sélectionnez un Type de machine et un Type d'accélérateur.
Sélectionnez un environnement.
Dans le champ Type, sélectionnez Exécution unique ou Exécutions récurrentes basées sur des planifications, puis compléter la boîte de dialogue permettant de planifier l'exécution.
Dans Options avancées, sélectionnez la région dans laquelle vous souhaitez exécuter votre notebook.
Dans le champ Bucket Cloud Storage, sélectionnez un bucket Cloud Storage disponible ou saisissez un nom pour un nouveau bucket, puis cliquez sur Créer et sélectionner.
L'exécuteur stocke la sortie de votre notebook dans ce bucket Cloud Storage.
Dans la section Paramètres du notebook, dans la zone de texte Paramètres d'entrée, ajoutez les paramètres des notebooks séparés par une virgule, par exemple, optimizer=SGD,learning_rate=0.01. Le format ne nécessite pas d'espace ni de guillemets.
Configurez le reste de l'exécution, puis cliquez sur Envoyer.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/04 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 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)."]]
dans la barre latérale droite.
Exécuteur.