ertk.utils.TqdmParallel

class ertk.utils.TqdmParallel(total: int = 1, desc: str = '', unit: str = 'it', leave: bool = True, **kwargs)

Bases: Parallel

Convenience class that acts identically to joblib.Parallel except it uses a tqdm progress bar.

Parameters:
total: int

Total number of items in the iterable.

desc: str

Progress bar description.

unit: str

Progress bar unit.

leave: bool

Whether to leave the progress bar after completion.

**kwargs: dict

Other keyword args passed to joblib.Parallel.

__init__(total: int = 1, desc: str = '', unit: str = 'it', leave: bool = True, **kwargs)
Parameters:
depth: int, optional

The depth of objects printed.

Methods

__init__([total, desc, unit, leave])

Parameters:

print_progress()

Display the process of the parallel execution only a fraction of time, controlled by self.verbose.

Inherited Methods

debug(msg)

dispatch_next()

Dispatch more data for parallel processing

dispatch_one_batch(iterator)

Prefetch the tasks for the next batch and dispatch them.

format(obj[, indent])

Return the formatted representation of the object.

retrieve()

warn(msg)

print_progress()

Display the process of the parallel execution only a fraction of time, controlled by self.verbose.