Administrar notebooks

En este documento, se describe cómo administrar notebooks de Colab Enterprise en BigQuery, lo que incluye cómo ver, comparar, restablecer, programar y borrar notebooks.

Los notebooks son recursos de código de BigQuery Studio con tecnología de Dataform.

Si deseas usar notebooks, primero debes habilitar BigQuery Studio para la administración de recursos.

Permisos necesarios

Para compartir los notebooks, necesitas los siguientes roles de Identity and Access Management (IAM):

• Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
• Usuario de sesión de lectura de BigQuery (roles/bigquery.readSessionUser)
• Propietario del código (roles/dataform.codeOwner) a nivel de recurso.

Para guardar y borrar notebooks, necesitas los siguientes roles de IAM:

• Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
• Usuario de sesión de lectura de BigQuery (roles/bigquery.readSessionUser)
• Propietario (roles/dataform.codeOwner) o Editor de código (roles/dataform.codeEditor)

Para trabajar con revisiones del notebook, necesitas los siguientes roles de IAM:

• Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
• Usuario de sesión de lectura de BigQuery (roles/bigquery.readSessionUser)

• Cualquiera de los siguientes roles:

  • Propietario del código (roles/dataform.codeOwner)
  • Editor de código (roles/dataform.codeEditor)
  • Visualizador de código (roles/dataform.codeViewer)

Para crear programas de notebooks (vista previa), necesitas los siguientes roles:

• Administrador de Dataform (roles/dataform.admin)
• Usuario de sesión de lectura de BigQuery (roles/bigquery.readSessionUser) o usuario de BigQuery Studio (roles/bigquery.studioUser)

Para editar programas de notebooks (vista previa), necesitas el rol Editor de Dataform (roles/dataform.editor).

Para ver los programas de notebooks (vista previa), necesitas el rol Visualizador de Dataform (roles/dataform.viewer).

Para obtener más información sobre IAM de BigQuery, consulta Control de acceso con IAM.

Otorga acceso a los notebooks

Para otorgar acceso a un notebook a otros usuarios, agrégalos a un rol de IAM adecuada.

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Busca el notebook al que quieres otorgar acceso.

3. Haz clic en more_vert Ver acciones junto al notebook y, luego, en Compartir > Administrar permisos.

4. En el panel Administrar permisos, haz clic en Agregar usuario o grupo.

5. En el campo Principales nuevas, ingresa una principal.

6. En la lista Rol, selecciona uno de los siguientes roles:

   • Propietario del código: Puede realizar cualquier acción en el notebook, incluida la eliminación o el uso compartido.
   • Editor de código: Puede editar el notebook.
   • Visualizador de código: Puede ver el notebook.

7. Opcional: Para ver una lista completa de las funciones y la configuración de uso compartido avanzada, haz clic en Uso compartido avanzado.

8. Haz clic en Guardar.

9. Para volver a la página de información del notebook, haz clic en Cerrar.

Comparte notebooks

Para compartir un notebook con otros usuarios, puedes generar y compartir un vínculo al notebook. Para que otros usuarios vean el notebook que compartes, primero debes otorgar acceso al notebook.

Para ejecutar un notebook, los usuarios deben tener acceso a los datos a los que accede el notebook. Para obtener más información, consulta Otorga acceso a un conjunto de datos.

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, expande la carpeta Explorer. Busca la carpeta que quieras compartir.

3. Haz clic en more_vert Ver acciones junto al notebook y, luego, en Compartir > Copiar vínculo.

4. Comparte el vínculo con otros usuarios.

Visualiza todos los notebooks

Para ver una lista de todos los notebooks de tu proyecto, haz lo siguiente:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, haz clic en more_vert Explorer junto a Explorer y, luego, realiza una de las siguientes acciones:

• Para abrir la lista en la pestaña actual, haz clic en Mostrar todo.
• Para abrir la lista en una pestaña nueva, haz clic en Mostrar todo en > Nueva pestaña.
• Para abrir la lista en una pestaña dividida, haz clic en Mostrar todo en > Dividir pestaña.

Cómo ver los metadatos del notebook

Para ver los metadatos del notebook, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook del que quieres ver los metadatos.

3. Mira el panel Resumen para ver información sobre el notebook, como la región que usa para los datos y la fecha en que se modificó por última vez.

Trabaja con versiones de notebooks

Usa las siguientes secciones para aprender a ver, comparar y restablecer versiones de un notebook.

Cómo ver las versiones de notebook

Para ver las versiones de notebook, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook del que quieres ver la actividad.

3. Haz clic en la pestaña Actividad para ver una lista de las versiones de notebook en orden descendente por fecha.

Cómo comparar versiones de notebooks

Para comparar las versiones de notebook, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook del que quieres comparar la información de la versión.

3. En la pestaña Actividad, haz clic en more_vert Ver acciones junto a la versión de un notebook y, luego, haz clic en Comparar.

4. En el panel Historial de revisión, usa los menús desplegables de Versión para elegir las versiones que quieres comparar.

5. Opcional: Para comparar el código fuente del notebook, selecciona la casilla de verificación Fuente sin procesar.

6. Opcional: Para comparar las versiones intercaladas en lugar de en paneles separados, selecciona la casilla de verificación Diferencia intercalada.

7. Opcional: Para ocultar el resultado del comando en el notebook, desmarca la casilla de verificación Mostrar resultado.

Restablece una versión de notebook

Usa una de las siguientes opciones para restablecer una versión del notebook. Restablecer desde el panel Historial de revisión te permite comparar las versiones actuales y anteriores del notebook antes de restablecer la versión anterior. Si restableces un notebook, se crea una versión nueva del notebook en lugar de reemplazar la actual. No se pierde el historial de versiones.

Descarga un notebook

Para descargar un notebook, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook que deseas descargar.

3. Haz clic en Descargar.

Programa notebooks

Para proporcionar comentarios sobre la programación de notebooks, envía un correo electrónico a [email protected].

Puedes programar un notebook para que se ejecute de forma automática a una hora y frecuencia especificadas, por ejemplo, para entrenar un modelo de AA, llamar a APIs externas o ejecutar código de BigQuery DataFrames.

Los cambios que realices en un notebook se guardarán de forma automática, pero solo estarán disponibles para ti y los usuarios que tengan acceso al notebook. Para actualizar el programa con una versión nueva del notebook, debes implementar el notebook. Cuando implementas un notebook, actualizas su programa con tu versión actual del notebook. Los programas ejecutan la última versión implementada del notebook.

Una cuenta de servicio de Dataform personalizada, que seleccionas durante la creación del programa, ejecuta cada programación de notebook. Para obtener más información sobre los tipos de cuentas de servicio en Dataform, consulta Acerca de las cuentas de servicio en Dataform.

Dataform escribe el resultado de las ejecuciones de notebooks programadas en el bucket de Cloud Storage seleccionado durante la creación del programa.

Las programaciones de notebooks usan un entorno de ejecución estándar E2. Se aplican cargos de Colab Enterprise por entornos de ejecución. Se te cobra por el procesamiento del entorno de ejecución en función del tipo de máquina E2. Para obtener información sobre los precios de los entornos de ejecución E2 estándar, consulta los precios de Colab Enterprise.

Habilita la programación de notebooks

Para programar notebooks, debes otorgar los siguientes roles a la cuenta de servicio personalizada de Dataform que planeas usar para los programas de notebooks:

Usuario del ejecutor de notebooks (roles/aiplatform.notebookExecutorUser)

Sigue los pasos de Cómo otorgar un solo rol en un proyecto para otorgar el rol de usuario de ejecutor de notebooks a tu Dataform personalizado en el proyecto seleccionado.

Administrador de almacenamiento (roles/storage.admin)

Sigue las instrucciones de Agrega un principal a una política a nivel de bucket para agregar tu cuenta de servicio personalizada de Dataform como principal al bucket de Cloud Storage que planeas usar para almacenar el resultado de ejecuciones programadas de notebooks y otorgar el rol de administrador de almacenamiento a esta principal.

Usuario de cuenta de servicio (roles/iam.serviceAccountUser)

Sigue Otorga un solo rol en una cuenta de servicio para agregar tu cuenta de servicio personalizada de Dataform como principal a sí misma. En otras palabras, agrega la cuenta de servicio personalizada de Dataform como una principal a la misma cuenta de servicio personalizada de Dataform. Luego, otorga el rol de usuario de cuenta de servicio a este principal.

Además, debes otorgar el siguiente rol a la cuenta de servicio predeterminada de Dataform:

Creador de tokens de cuenta de servicio (roles/iam.serviceAccountTokenCreator)

Sigue los pasos de Otorga acceso de creación de tokens a una cuenta de servicio personalizada de Dataform para agregar la cuenta de servicio predeterminada de Dataform como principal a tu cuenta de servicio de Dataform personalizada, y otorga el rol de creador de tokens de cuentas de servicio a esta principal.

Para obtener más información sobre las cuentas de servicio en Dataform, consulta Acerca de las cuentas de servicio en Dataform.

Crear una programación

Para programar un notebook, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook que deseas programar.

3. Haga clic en Programar.

4. En el panel Programa notebook, en el campo Nombre del programa, ingresa un nombre para el programa.

5. En el campo Plantilla de entorno de ejecución, selecciona un entorno de ejecución.

6. En el campo Cuenta de servicio, selecciona una cuenta de servicio personalizada de Dataform.

7. En el campo Bucket de Cloud Storage, haz clic en Explorar y selecciona o crea un bucket de Cloud Storage.

   La cuenta de servicio personalizada de Dataform seleccionada debe tener el rol de IAM de administrador de almacenamiento en el bucket seleccionado. Para obtener más información, consulta Habilita la programación de notebooks.

8. En la sección frecuencia de programación, haz lo siguiente:

   1. En el menú desplegable Repeticiones, selecciona la frecuencia de las ejecuciones programadas de notebooks.
   2. En el campo A la hora, ingresa la hora para las ejecuciones programadas del notebook.
   3. En el menú desplegable Zona horaria, elige la zona horaria para el programa.

9. Haz clic en Crear programación.

Cuando creas el programa, la versión actual del notebook se implementa automáticamente. Para actualizar el programa con una versión nueva del notebook, implementa el notebook.

La última versión implementada del notebook se ejecuta a la hora y con la frecuencia seleccionadas.

Implementa un notebook

La implementación de un notebook actualiza su programa con la versión actual del notebook. Los programas ejecutan la última versión implementada del notebook.

Sigue estos pasos para implementar un notebook:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook seleccionado.

3. Haz clic en Implementar.

El programa correspondiente se actualiza con la versión actual del notebook. La versión más reciente del notebook implementada se ejecuta a la hora programada.

Visualiza los detalles del programa

Para ver los detalles del programa de un notebook seleccionado, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook seleccionado.

3. Haz clic en Ver programación.

Ver ejecuciones anteriores

Para ver las ejecuciones anteriores de un programa de notebook seleccionado, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook seleccionado.

3. Haz clic en Ver programación y, luego, en Ver ejecuciones anteriores.

Inhabilita un programa

Para pausar las ejecuciones programadas de un notebook seleccionado sin borrar el programa, puedes inhabilitarlo.

Para inhabilitar un programa en un notebook seleccionado, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook seleccionado.

3. Haz clic en Ver programación.

4. En la tabla de detalles del programa, en la fila Estado del programa, haz clic en el botón de activar o desactivar El programa está habilitado.

Habilita un programa

Para reanudar las ejecuciones programadas de un programa inhabilitado, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook seleccionado.

3. Haz clic en Ver programación.

4. En la tabla de detalles del programa, en la fila Estado del programa, haz clic en el botón de activar o desactivar El programa está inhabilitado.

Edita una planificación

Para editar un programa, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, la carpeta Explorer. Haz clic en el nombre del notebook seleccionado.

3. Haz clic en Ver programación y, luego, en Editar.

4. En el cuadro de diálogo Programar notebook, edita el programa y, luego, haz clic en Actualizar programa.

Visualiza todos los programas

Para ver todos los programas de notebooks en tu proyecto, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página Organización.

   Ve a la página Organización

2. Opcional: Para ver los detalles de un programa seleccionado y sus ejecuciones anteriores, haz clic en el nombre del programa.

Borra un programa

Para borrar de forma permanente un programa de un notebook seleccionado, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página Organización.

   Ve a la página Organización

2. En la lista de todos los programas, elige la fila que contiene el programa que deseas borrar.

3. Opcional: Para borrar varios programas a la vez, selecciona varias filas.

4. Haz clic en Borrar.

5. En el cuadro de diálogo que aparece, haz clic en Borrar.

Cómo borrar notebooks

Para borrar un notebook, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorer, expande tu proyecto y la carpeta Explorer y, si es necesario, expande la carpeta Explorer. Busca el notebook que quieres borrar.

3. Haz clic en more_vert Ver acciones junto al notebook y, luego, en Borrar.

4. Para confirmar la eliminación, escribe delete en el cuadro de diálogo.

5. Haz clic en Borrar.

Soluciona problemas

Para obtener más información, consulta Soluciona problemas de Colab Enterprise.

¿Qué sigue?

• Obtén más información sobre los notebooks de Colab Enterprise en BigQuery.
• Obtén más información para crear notebooks.