Mostrar barra de progreso en Jupyter

Al aumentar la complejidad la complejidad de los análisis realizados en un Jupyter Notebook. O al aumentar el conjunto de datos sobre el que se trabaja. Los procesos pueden pasar de unos pocos segundos a minutos o incluso horas. En estas situaciones saber el estado del proceso y una estimación del tiempo que falta para finalizar puede ser de gran ayuda. Para lo que las barras de progreso son una herramienta ideal. A continuación, vamos a ver como mostrar una barra de progreso en Jupyter Notebook desde Python.

Instalando la barra de progreso: tqdm

Una de las mejores librerías para usar barras de progreso en nuestro código que podemos encontrar en Python es tqdm. La instalación de la librería se puede hacer como siempre a través de pip escribiendo la siguiente línea en el terminal:

pip install tqdm

Probando la barra de progreso

Una vez instalado la librería se puede probar esta. Para ello solamente se tiene que importar tqdm y usar el método en un bucle for. Por ejemplo, para ejecutar un código 10 veces:

import time
from tqdm import tqdm

for i in tqdm(range(10)):
    time.sleep(0.5)

Con lo que obtiene una barra de progreso como la que se muestra a continuación.

100%|██████████| 10/10 [00:05<00:00,  1.98it/s]

Lo primero que se muestra es el porcentaje, lo segundo una barra que indica visualmente el progreso, posteriormente la iteración actual sobre el total, el tiempo transcurrido, seguido del estimado para finalizar el proceso y, finalmente, el número de iteraciones medias que se realizan por segundo.

Usando la barra de progreso manualmente

Si cada una de las iteraciones de nuestro proceso es rápida puede ser mejor actualizar cada 10, 100 o más pasos. Evitando de esta manera que el proceso gaste más tiempo en actualizar la barra de progreso que en los cálculos en sí. Para ello se puede usar el modo manual creando la barra y actualizándose con la propiedad .update(), como se muestra en el siguiente ejemplo

pbar = tqdm(total=1000)

for i in range(10):
    time.sleep(0.05)
    pbar.update(100)
    
pbar.close()

En este se puede ver que en primer lugar se crea la barra para 1000 iteraciones y posteriormente actualizamos el estado del proceso cada 100 iteraciones. Actualizando la información de la barra solamente 10 veces en lugar de 1000. Finalmente se tiene que cerrar la barra de progreso mediante el comando .close().

Una forma alternativa de implementar este proceso es usando with, lo que evita tener que cerrar la barra una vez finalizado el proceso.

with tqdm(total=1000) as pbar:
    for i in range(10):
        time.sleep(0.05)
        pbar.update(100)

Uso de más de una barra

Si tenemos varios procesos es posible darle un nombre a la barra para identificar los procesos que han terminado y aquel que está en marcha. Para lo que se tiene que indicar un nombre mediante el parámetro desc de tqdm. Lo que se muestra en el siguiente ejemplo.

import time
from tqdm import tqdm

for i in tqdm(range(10), desc="Proceso #1"):
    time.sleep(0.5)
for i in tqdm(range(10), desc="Proceso #2"):
    time.sleep(0.5)

Proceso #1: 100%|██████████| 10/10 [00:05<00:00,  1.98it/s]
Proceso #2: 100%|██████████| 10/10 [00:05<00:00,  1.98it/s]

Conclusiones

Hoy se ha visto cómo implementar una barra de progreso en Jupyter Notebok desde Python. Algo que es útil cuando el tiempo de los análisis supera los pocos segundos y es necesario conocer el estado de los procesos. Algo que ya vimos como hacer en R.

Obviamente, esta barra de progreso también se puede utilizar en programas de Python que ejecutemos en la terminal.

Imagen de Free-Photos en Pixabay