Gérer les notebooks

Ce document explique comment gérer des notebooks Colab Enterprise dans BigQuery, y compris comment afficher, comparer, restaurer, programmer et supprimer des notebooks.

Les notebooks sont des composants de code BigQuery Studio fournis par Dataform.

Pour utiliser des notebooks, vous devez d'abord activer BigQuery Studio pour la gestion des éléments.

Autorisations requises

Pour partager les notebooks, vous avez besoin des rôles IAM (Identity and Access Management) suivants :

• Utilisateur de job BigQuery (roles/bigquery.jobUser)
• Utilisateur de sessions de lecture BigQuery (roles/bigquery.readSessionUser)
• Propriétaire de code (roles/dataform.codeOwner) au niveau de la ressource

Pour enregistrer et supprimer des notebooks, vous avez besoin des rôles IAM suivants :

• Utilisateur de job BigQuery (roles/bigquery.jobUser)
• Utilisateur de sessions de lecture BigQuery (roles/bigquery.readSessionUser)
• Propriétaire de code (roles/dataform.codeOwner) ou Éditeur de code (roles/dataform.codeEditor)

Pour utiliser des révisions de notebook, vous avez besoin des rôles IAM suivants :

• Utilisateur de job BigQuery (roles/bigquery.jobUser)
• Utilisateur de sessions de lecture BigQuery (roles/bigquery.readSessionUser)

• L'un des rôles suivants :

  • Propriétaire de code (roles/dataform.codeOwner)
  • Éditeur de code (roles/dataform.codeEditor)
  • Lecteur de code (roles/dataform.codeViewer)

Pour créer des programmations de notebook (preview), vous devez disposer des rôles suivants :

• Administrateur Dataform (roles/dataform.admin)
• Utilisateur de sessions de lecture BigQuery (roles/bigquery.readSessionUser) ou utilisateur BigQuery Studio (roles/bigquery.studioUser)

Pour modifier les programmations de notebooks (preview), vous devez disposer du rôle Éditeur Dataform (roles/dataform.editor).

Pour afficher les programmations de notebooks (preview), vous devez disposer du rôle Lecteur Dataform (roles/dataform.viewer).

Pour plus d'informations sur BigQuery IAM, consultez la page Contrôle des accès avec IAM.

Accorder l'accès aux notebooks

Pour accorder à d'autres utilisateurs l'accès à un notebook, ajoutez-les à un rôle IAM approprié.

Important : Les utilisateurs ayant accès au notebook peuvent voir tous les résultats générés par le code dans le notebook, même si ces résultats contiennent des données de tables auxquelles ils n'ont pas accès. Pour empêcher le partage de la sortie enregistrée, désactivez l'enregistrement de la sortie du notebook.

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Recherchez le notebook auquel vous souhaitez accorder l'accès.

3. Cliquez sur le bouton Afficher les actions en regard du notebook, puis sur Partager > Gérer les autorisations.

4. Dans le volet Gérer les autorisations, cliquez sur Ajouter un utilisateur/groupe.

5. Dans le champ Nouveaux comptes principaux, saisissez un compte principal.

6. Dans la liste Rôle, sélectionnez l'un des rôles suivants :

   • Propriétaire de code : peut effectuer n'importe quelle action sur le notebook, y compris le supprimer ou le partager.
   • Éditeur de code : peut modifier le notebook.
   • Lecteur de code : peut afficher le notebook.
   Remarque : Le compte principal doit également disposer des rôles Utilisateur de l'environnement d'exécution de notebook (roles/aiplatform.notebookRuntimeUser) et Utilisateur BigQuery (roles/bigquery.user) pour exécuter le notebook.

7. Facultatif : Pour afficher la liste complète des rôles et des paramètres de partage avancés, cliquez sur Partage avancé.

8. Cliquez sur Enregistrer.

9. Pour revenir à la page d'informations sur le notebook, cliquez sur Fermer.

Partager des notebooks

Pour partager un notebook avec d'autres utilisateurs, vous pouvez générer et partager un lien vers celui-ci. Pour que les autres utilisateurs puissent voir le notebook que vous partagez, vous devez d'abord accorder l'accès au notebook.

Pour exécuter un notebook, les utilisateurs doivent avoir accès aux données auxquelles le notebook accède. Pour en savoir plus, consultez la section Accorder l'accès à un ensemble de données.

Important : Les utilisateurs ayant accès au notebook peuvent voir tous les résultats générés par le code dans le notebook, même si ces résultats contiennent des données de tables auxquelles ils n'ont pas accès. Pour empêcher le partage de la sortie enregistrée, désactivez l'enregistrement de la sortie du notebook.

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks, et développez si nécessaire le dossier Notebooks partagés. Recherchez le notebook que vous souhaitez partager.

3. Cliquez sur le bouton Afficher les actions en regard du notebook, puis sur Partager > Copier le lien.

4. Partagez le lien avec d'autres utilisateurs.

Afficher tous les notebooks

Pour afficher la liste de tous les notebooks de votre projet, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, cliquez sur le bouton Afficher les actions en regard de Notebooks, puis effectuez l'une des opérations suivantes :

• Pour ouvrir la liste dans l'onglet actuel, cliquez sur Tout afficher.
• Pour ouvrir la liste dans un nouvel onglet, cliquez sur Tout afficher dans > Nouvel onglet.
• Pour ouvrir la liste dans un onglet divisé, cliquez sur Tout afficher dans > Diviser l'onglet.

Afficher les métadonnées du notebook

Pour afficher les métadonnées du notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook dont vous souhaitez afficher les métadonnées.

3. Consultez le volet Résumé pour afficher des informations sur le notebook, telles que la région qu'il utilise pour les données et la date de sa dernière modification.

Utiliser les versions de notebook

Utilisez les sections suivantes pour savoir comment afficher, comparer et restaurer les versions d'un notebook.

Afficher les versions de notebook

Pour afficher les versions de notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook dont vous souhaitez afficher l'activité.

3. Cliquez sur l'onglet Activité pour afficher la liste des versions de notebook par ordre décroissant de date.

Comparer les versions de notebook

Pour comparer les versions de notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook pour lequel vous souhaitez comparer les informations de version.

3. Dans l'onglet Activité, cliquez sur le bouton Afficher les actions en regard d'une version de notebook, puis sur Comparer.

4. Dans le volet Historique des révisions, utilisez les listes déroulantes dans Version pour choisir les versions à comparer.

5. Facultatif : Pour comparer le code source du notebook, cochez la case Source brute.

6. Facultatif : Pour comparer les versions de manière intégrée plutôt que dans des volets distincts, cochez la case Différences intégrées.

7. Facultatif : Pour masquer le résultat de la commande dans le notebook, décochez la case Afficher le résultat.

Restaurer une version de notebook

Utilisez l'une des options suivantes pour restaurer une version de notebook. La restauration à partir du volet Historique des révisions vous permet de comparer les versions actuelles et précédentes d'un notebook avant de choisir de restaurer la version précédente. La restauration d'un notebook crée une nouvelle version au lieu de l'écraser. L'historique des versions n'est pas perdu.

Volet Activité

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks, et développez si nécessaire le dossier Notebooks partagés. Cliquez sur le nom du notebook dont vous souhaitez restaurer une version précédente.

3. Sélectionnez le volet Activité.

4. Cliquez sur le bouton Afficher les actions en regard de la version de notebook que vous souhaitez restaurer, puis cliquez sur Restaurer.

5. Cliquez sur Confirmer.

Historique des révisions

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks, et développez si nécessaire le dossier Notebooks partagés. Cliquez sur le nom du notebook dont vous souhaitez restaurer une version précédente.

3. Sélectionnez le volet Activité.

4. Cliquez sur Afficher les actions à côté d'une version de notebook, puis sur Comparer.

5. Dans le volet Historique des révisions, cliquez sur le bouton Afficher les actions en regard de la liste déroulante Version, puis sur Restaurer la révision

6. Cliquez sur Confirmer.

Télécharger un notebook

Procédez comme suit pour télécharger un notebook :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook que vous souhaitez télécharger.

3. Cliquez sur Télécharger.

Programmer des notebooks

Preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Si vous souhaitez envoyer des commentaires sur la programmation des notebooks, envoyez un e-mail à [e-mail].

Vous pouvez programmer l'exécution automatique d'un notebook à une heure et une fréquence spécifiées, par exemple pour entraîner un modèle de ML, appeler des API externes ou exécuter du code BigQuery DataFrames.

Les modifications que vous apportez à un notebook sont automatiquement enregistrées, mais ne sont disponibles que pour vous et les utilisateurs qui ont accès au notebook. Pour mettre à jour la programmation avec une nouvelle version du notebook, vous devez déployer le notebook. En déployant un notebook, vous mettez à jour sa programmation avec votre version actuelle du notebook. Les programmations exécutent la dernière version déployée du notebook.

Chaque programmation de notebook est exécutée par un compte de service Dataform personnalisé, que vous sélectionnez lors de la création de la programmation. Pour en savoir plus sur les types de comptes de service dans Dataform, consultez la section À propos des comptes de service dans Dataform.

Dataform écrit la sortie des exécutions de notebook programmées dans le bucket Cloud Storage sélectionné lors de la création de la programmation.

Les programmations de notebooks utilisent un environnement d'exécution E2 standard. Des frais Colab Enterprise s'appliquent aux environnements d'exécution. Les frais de traitement des environnements d'exécution sont calculés en fonction du type de machine E2. Pour en savoir plus sur les tarifs des environnements d'exécution E2 standards, consultez la page Tarifs de Colab Enterprise.

Activer la programmation de notebooks

Pour programmer des notebooks, vous devez attribuer les rôles suivants au compte de service Dataform personnalisé que vous prévoyez d'utiliser pour les programmations de notebooks :

Utilisateur de Notebook Executor (roles/aiplatform.notebookExecutorUser)

Suivez la procédure décrite à la section Attribuer un rôle unique à un projet pour attribuer le rôle utilisateur Notebook Executor à votre compte de service Dataform personnalisé sur le projet sélectionné.

Administrateur de l'espace de stockage (roles/storage.admin)

Suivez la procédure décrite à la section Ajouter un compte principal à une stratégie au niveau du bucket pour ajouter votre compte de service Dataform personnalisé en tant que compte principal au bucket Cloud Storage que vous prévoyez d'utiliser pour stocker le résultat des exécutions de notebook programmées, et attribuer le rôle Administrateur de l'espace de stockage à ce compte principal.

Utilisateur du compte de service (roles/iam.serviceAccountUser)

Suivez la procédure décrite à la section Accorder un rôle unique à un compte de service pour ajouter votre compte de service Dataform personnalisé en tant que compte principal à lui-même. En d'autres termes, ajoutez le compte de service Dataform personnalisé en tant que compte principal au même compte de service Dataform personnalisé. Attribuez ensuite le rôle Utilisateur du compte de service à ce compte principal.

Vous devez également attribuer le rôle suivant au compte de service Dataform par défaut :

Créateur de jetons de compte de service (roles/iam.serviceAccountTokenCreator)

Suivez la procédure décrite à la section Accorder l'accès à la création de jetons à un compte de service Dataform personnalisé pour ajouter le compte de service Dataform par défaut en tant que compte principal à votre compte de service Dataform personnalisé, et attribuer le rôle Créateur de jetons de compte de service à ce compte principal.

Pour en savoir plus sur les comptes de service dans Dataform, consultez la section À propos des comptes de service dans Dataform.

Créer une programmation

Pour programmer un notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook que vous souhaitez programmer.

3. Cliquez sur Programmer.

4. Dans le volet Programmer un notebook, dans le champ Nom de la programmation, saisissez un nom pour la programmation.

5. Dans le champ Modèle d'environnement d'exécution, sélectionnez un environnement d'exécution.

6. Dans le champ Compte de service, sélectionnez un compte de service Dataform personnalisé.

7. Dans le champ Bucket Cloud Storage, cliquez sur Parcourir, puis sélectionnez ou créez un bucket Cloud Storage.

   Le compte de service Dataform personnalisé sélectionné doit disposer du rôle IAM "Administrateur de stockage" sur le bucket sélectionné. Pour en savoir plus, consultez la section Activer la programmation des notebooks.

8. Dans la section Fréquence de programmation, procédez comme suit :

   1. Dans le menu déroulant Répétitions, sélectionnez la fréquence d'exécution du notebook programmé.
   2. Dans le champ À, saisissez l'heure d'exécution du notebook programmé.
   3. Dans le menu déroulant Fuseau horaire, sélectionnez le fuseau horaire de la programmation.

9. Cliquez sur Créer la programmation.

Lorsque vous créez la programmation, la version actuelle du notebook est automatiquement déployée. Pour mettre à jour la planification avec une nouvelle version du notebook, déployez le notebook.

La dernière version déployée du notebook s'exécute à l'heure et à la fréquence sélectionnées.

Déployer un notebook

Le déploiement d'un notebook met à jour sa programmation avec la version actuelle du notebook. Les programmations exécutent la dernière version déployée du notebook.

Pour déployer un notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook sélectionné.

3. Cliquez sur Déployer.

La programmation correspondante est mise à jour avec la version actuelle du notebook. La dernière version déployée du notebook s'exécute à l'heure programmée.

Afficher les détails d'une programmation

Pour afficher les détails de la programmation d'un notebook sélectionné, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook sélectionné.

3. Cliquez sur Afficher la programmation.

Afficher les exécutions passées

Pour afficher les exécutions précédentes d'une programmation de notebook sélectionnée, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook sélectionné.

3. Cliquez sur Afficher la programmation, puis sur Afficher les exécutions précédentes.

Désactiver une programmation

Pour suspendre les exécutions programmées d'un notebook sélectionné sans supprimer la programmation, vous pouvez la désactiver.

Pour désactiver une programmation pour un notebook sélectionné, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook sélectionné.

3. Cliquez sur Afficher la programmation.

4. Dans le tableau des détails de la programmation, sur la ligne État de la programmation, cliquez sur le bouton La programmation est activée.

Activer une programmation

Pour reprendre les exécutions programmées d'une programmation désactivée, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook sélectionné.

3. Cliquez sur Afficher la programmation.

4. Dans le tableau des détails de la programmation, sur la ligne État de la programmation, cliquez sur le bouton La programmation est désactivée.

Modifier une programmation

Pour modifier une programmation, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook sélectionné.

3. Cliquez sur Afficher la programmation, puis sur Modifier.

4. Dans la boîte de dialogue Programmer un notebook, modifiez la programmation, puis cliquez sur Mettre à jour la programmation.

Afficher toutes les programmations

Pour afficher toutes les programmations de notebooks de votre projet, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page Orchestration.

   Accéder à la page Orchestration

2. Facultatif : Pour afficher les détails d'une programmation sélectionnée et de ses exécutions précédentes, cliquez sur le nom de la programmation.

Supprimer une programmation

Pour supprimer définitivement une programmation pour un notebook sélectionné, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page Orchestration.

   Accéder à la page Orchestration

2. Dans la liste de toutes les programmations, sélectionnez la ligne contenant la programmation que vous souhaitez supprimer.

3. Facultatif : Pour supprimer plusieurs programmations à la fois, sélectionnez plusieurs lignes.

4. Cliquez sur Supprimer.

5. Dans la boîte de dialogue qui s'affiche, cliquez sur Supprimer.

Supprimer des notebooks

Pour supprimer un notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks, et développez si nécessaire le dossier Notebooks partagés. Recherchez le notebook que vous souhaitez supprimer.

3. Cliquez sur le bouton Afficher les actions en regard du notebook, puis sur Supprimer.

4. Pour confirmer la suppression, saisissez delete dans la boîte de dialogue.

5. Cliquez sur Supprimer.

Dépannage

Pour en savoir plus, consultez la page Résoudre les problèmes liés à Colab Enterprise.

Étapes suivantes

• Apprenez-en plus sur les notebooks Colab Enterprise dans BigQuery.
• Apprenez à créer des notebooks.