timer

class timer(label=None, auto=False, start=True, unit='auto', verbose=None, **kwargs)

Bases: object

Simple timer class. Note: sc.timer() and sc.Timer() are aliases.

This wraps sc.tic() and sc.toc() with the formatting arguments and the start time (at construction).

Use this in a with block to automatically print elapsed time when the block finishes.

By default, output is displayed in seconds. You can change this with the unit argument, which can be a string or a float:

• ‘hr’ or 3600

• ‘min’ or 60

• ‘s’ or 1 (default)

• ‘ms’ or 1e-3

• ‘us’ or 1e-6

• ‘ns’ or 1e-9

• ‘auto’ to choose an appropriate unit

Parameters:

• label (str) – label identifying this timer

• auto (bool) – whether to automatically increment the label

• start (bool) – whether to start timing from object creation (else, call timer.tic() explicitly)

• unit (str/float) – the unit of time to display; see options above

• verbose (bool) – whether to print output on each timing

• kwargs (dict) – passed to sc.toc() when invoked

Example making repeated calls to the same timer, using auto to keep track:

>>> T = sc.timer(auto=True)
>>> T.toc()
(0): 2.63 s
>>> T.toc()
(1): 5.00 s

Example wrapping code using with-as:

>>> with sc.timer('mylabel'):
>>>     sc.timedsleep(0.5)

Example using a timer to collect data, using timer.tt() as an alias for sc.toctic() to reset the time:

T = sc.timer(verbose=False)
for key in 'abcde':
    sc.timedsleep(np.random.rand())
    T.tt(key)
print(T.timings)

Implementation based on https://preshing.com/20110924/timing-your-code-using-pythons-with-statement/

New in version 1.3.0: sc.timer() alias, and allowing the label as first argument

New in version 1.3.2: toc() passes label correctly; tt() method; auto argument

New in version 2.0.0: plot() method; total() method; indivtimings and cumtimings properties

New in version 2.1.0: total as property instead of method; updated repr; added disp() method

New in version 3.0.0: unit argument; verbose argument; sum, min, max, mean, std methods; rawtimings property

New in version 3.1.0: Timers can be combined by addition, including sum()

New in version 3.1.5: T.timings is now an sc.objdict() instead of an sc.odict()

New in version 3.2.2: sc.timer() can be used as a function decorator

New in version 3.2.5: .string attribute (e.g. ‘3.25 s’)

Attributes

cumtimings	Compute the cumulative time for each timing
indivtimings	Compute the individual time between each timing
rawtimings	Return an array of timings
total	Calculate total time

Methods

__call__(func)

Allow being used as a decorator

__add__(T2)

Ditto

disp()

Display the full representation of the object

tic()

Set start time

toc(label=None, **kwargs)

Print elapsed time; see sc.toc() for keyword arguments

property total

Calculate total time

start()

Alias for sc.tic()

stop(*args, verbose=False, **kwargs)

Alias for sc.toc()

tocout(label=None, output=True, **kwargs)

Alias for sc.toc() with output=True

toctic(*args, reset=True, **kwargs)

Like toc, but reset time between timings

tt(*args, **kwargs)

Alias for sc.toctic()

tto(*args, output=True, **kwargs)

Alias for sc.toctic() with output=True

property rawtimings

Return an array of timings

property indivtimings

Compute the individual time between each timing

property cumtimings

Compute the cumulative time for each timing

sum()

Sum of timings; similar to timer.total

New in version 3.0.0.

min()

Minimum of timings

New in version 3.0.0.

max()

Maximum of timings

New in version 3.0.0.

mean()

Mean of timings

New in version 3.0.0.

std()

Standard deviation of timings

New in version 3.0.0.

plot(fig=None, figkwargs=None, grid=True, **kwargs)

Create a plot of Timer.timings

Parameters:

• cumulative (bool) – how the timings will be presented, individual or cumulative

• fig (fig) – an existing figure to draw the plot in

• figkwargs (dict) – passed to plt.figure()

• grid (bool) – whether to show a grid

• kwargs (dict) – passed to plt.bar()

New in version 2.0.0.