chainer.link_hooks.TimerHook

class chainer.link_hooks.TimerHook

Link hook for measuring elapsed time of Link.forward().

Example

Code example:

from chainer.link_hooks import TimerHook
hook = TimerHook()
with hook:
    trainer.run()
hook.print_report()

Output example:

  LinkName  ElapsedTime  Occurrence
    Linear     41.42sec        2100
       MLP     42.09sec         700
Classifier     42.39sec         700

where LinkName is the name of link that calls the hook, and ElapsedTime is the elapsed time the link consumed, and Occurrence is the number of calls.

Warning

Call graph of links are hierarchical. That means reported elapsed times may be overlapping with each other and the sum may exceed the total time.

Variables

~TimerHook.call_history – List of measurement results. It consists of pairs of the name of the link that calls this hook and the elapsed time the forward() method of link consumes.

Methods

__enter__() → chainer.link_hook.LinkHook

__exit__(*_)

added(link: Optional[chainer.link.Link]) → None

Callback function invoked when the link hook is registered

Parameters

link (Link) – Link object to which the link hook is registered. None if the link hook is registered globally.

deleted(link: Optional[chainer.link.Link]) → None

Callback function invoked when the link hook is unregistered

Parameters

link (Link) – Link object to which the link hook is unregistered. None if the link hook had been registered globally.

forward_postprocess(args)

Callback function invoked after a forward call of a link.

Parameters

args –

Callback data. It has the following attributes:

• link (Link)

  Link object.

• forward_name (str)

  Name of the forward method.

• args (tuple)

  Non-keyword arguments given to the forward method.

• kwargs (dict)

  Keyword arguments given to the forward method.

• out

  Return value of the forward method.

forward_preprocess(args)

Callback function invoked before a forward call of a link.

Parameters

args –

Callback data. It has the following attributes:

• link (Link)

  Link object.

• forward_name (str)

  Name of the forward method.

• args (tuple)

  Non-keyword arguments given to the forward method.

• kwargs (dict)

  Keyword arguments given to the forward method.

print_report(unit='auto', file=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Prints a summary report of time profiling in links.

Parameters

unit (str) – Supplementary units used for computational times. sec, ms, us, ns, auto`(default) and `auto_foreach are supported. If auto, units of times are aligned to the largest, and if auto_foreach, units of times are adjusted for each element.

summary()

Returns a summary of time profiling in links.

Returns

A summarized dictionary whose keys are link names and values are dictionaries of elapsed_time and occurrence.

total_time()

Returns total elapsed time in seconds.

__eq__(value, /)

Return self==value.

__ne__(value, /)

Return self!=value.

__lt__(value, /)

Return self<value.

__le__(value, /)

Return self<=value.

__gt__(value, /)

Return self>value.

__ge__(value, /)

Return self>=value.

Attributes

name = 'TimerHook'

table = {'ms': 1000, 'ns': 1000000000, 'sec': 1, 'us': 1000000}