elkhadiy / log-progress

Widget based progress bar for Jupyter

Widget based progress bar for Jupyter (IPython Notebook)

Code

Just copy and paste it into your project:

def log_progress(sequence, every=None, size=None):
    from ipywidgets import IntProgress, HTML, VBox
    from IPython.display import display
    from datetime import timedelta
    from time import time
    
    is_iterator = False
    if size is None:
        try:
            size = len(sequence)
        except TypeError:
            is_iterator = True
    if size is not None:
        if every is None:
            if size <= 200:
                every = 1
            else:
                every = size / 200     # every 0.5%
    else:
        assert every is not None, 'sequence is iterator, set every'

    if is_iterator:
        progress = IntProgress(min=0, max=1, value=1)
        progress.bar_style = 'info'
    else:
        progress = IntProgress(min=0, max=size, value=0)
    label = HTML()
    box = VBox(children=[label, progress])
    display(box)
    
    index = 0
    timestamps = []
    delta_timestamps = []
    try:
        for index, record in enumerate(sequence, 1):
            timestamps.append(time())
            if index == 1 or index % every == 0:
                if is_iterator:
                    label.value = '{index} / ?'.format(index=index)
                else:
                    progress.value = index
                    if len(timestamps) == 1 :
                        eta = u''
                    else:
                        delta_timestamps.append(timestamps[-1] - timestamps[-2])
                        last = timedelta(seconds=timestamps[-1] - timestamps[-2])
                        avr = sum(delta_timestamps) / float(len(delta_timestamps))
                        eta = u'(time remaining : {eta} | last : {last} | avr : {avr})'.format(
                            eta=str(timedelta(seconds=avr * (size - index))).split('.', 2)[0],
                            last=str(last).split('.', 2)[0],
                            avr=str(timedelta(seconds=avr)).split('.', 2)[0]
                        )
                    label.value = u'{index} / {size} {eta}'.format(
                        index=index,
                        size=size,
                        eta=eta
                    )
            yield record
    except:
        progress.bar_style = 'danger'
        raise
    else:
        progress.bar_style = 'success'
        progress.value = index
        try:
            avr = u' | avr iteration time : {avr})'.format(
                avr=str(timedelta(seconds=sum(delta_timestamps)
                                  / float(len(delta_timestamps)))).split('.', 2)[0]
            )
        except:
            avr=')'
        try:
            total = u' (total time : {total}'.format(
                total=str(timedelta(seconds=timestamps[-1]-timestamps[0])).split('.', 2)[0]
            )
        except:
            avr = ''
            total = ''
        label.value = str(str(index) + total + avr or '?')

Examples

Progress bar changes its color based on outcome:

Iterators are supported:

More then one progress bar can be in a sigle cell:

They can even be from different threads: