Comparar el contenido de dos Jupyter celda a celda.

Uno de los problemas que pueden existir a la hora de trabajar con documentos Jupyter es el control de cambios en los documentos. Es decir, saber qué celdas han cambiado y cuales son iguales. Incluso pequeños cambios que pueden cambiar completamente el resultado del documento. Algo, que a medida que el tamaño de los documentos crecer, es más necesario poder hacer de forma automática. Para esto se puede utilizar nbdime, una librería de Python para comparar el contenido de dos Jupyter celda a celda.

Instalación de nbdime

La librería nbdime se puede instalar como cualquier otro paquete de Python con pip. Para lo que solamente hay que abrir una terminal y escribir en el siguiente comando:

pip install nbdime

A partir de este momento tendremos dos nuevos comandos en nuestra instalación de Python: nbdiff y nbdiff-web. Ambos nos permiten comparar dos documentos Jupyter celda a celda, el primero en la terminal y el segundo en una aplicación web. Posiblemente el más interesante sea el segundo, ya que la comparación se realiza visualmente.

Comparar el contenido de dos Jupyter con nbdiff-web

Para comparar dos versiones de un documento Jupyter se tiene que abrir una terminal y escribir

nbdiff notebook_1.ipynb notebook_2.ipynb

Alternativamente, para poder ver el resultado de la comparativa en una versión web, utilizar el comando

nbdiff-web notebook_1.ipynb notebook_2.ipynb

En ambos casos notebook_1.ipynb es una versión del documento y notebook_2.ipynb otra. El segundo comando lanzará en el navegador una página como la que se muestra en la siguiente captura de pantalla.

Imagen en la que se puede apreciar las diferencias entre las dos hojas celda a celda.

Resultado de la comparación

En la captura de pantalla se puede ver que la primera celda no ha cambiado. Por otro lado, en la segunda se puede ver un cambio sutil que puede pasar desapercibido. En lugar de sumar uno a la columna A del DataFrame en la segunda hoja se suma 2. Lo que hace que el resultado de la celda cambie. Algo que también muestra la herramienta.

Quizás aún es más interesante sea lo que se puede ver en la tercera celda. En esta no se ha modificado el código, pero como los datos empleados han sido modificados en la celda anterior la salida sí que cambia. Además de una forma sutil que aun observado humano se le puede pasar desapercibido fácilmente. Es decir, no solo compara cambios en el código sino que también cambios en los resultados de las celdas. Lo que puede facilitar enormemente la auditoría de los notebooks.

Conclusiones

En esta entrada se ha visto una herramienta con la que es posible comparar el contenido de dos Jupyter notebooks. Realizado una comparativa tanto del código como de los resultados del notebook, facilitando así los procesos de auditoría y el trabajo colaborativo.

Imagen de FotoRieth en Pixabay