tf.train.SecondOrStepTimer

Class SecondOrStepTimer

Aliases:

  • Class tf.estimator.SecondOrStepTimer
  • Class tf.train.SecondOrStepTimer

Defined in tensorflow/python/training/basic_session_run_hooks.py.

Timer that triggers at most once every N seconds or once every N steps.

__init__

__init__(
    every_secs=None,
    every_steps=None
)

Initialize self. See help(type(self)) for accurate signature.

Methods

tf.train.SecondOrStepTimer.last_triggered_step

last_triggered_step()

Returns the last triggered time step or None if never triggered.

tf.train.SecondOrStepTimer.reset

reset()

Resets the timer.

tf.train.SecondOrStepTimer.should_trigger_for_step

should_trigger_for_step(step)

Return true if the timer should trigger for the specified step.

Args:

  • step: Training step to trigger on.

Returns:

True if the difference between the current time and the time of the last trigger exceeds every_secs, or if the difference between the current step and the last triggered step exceeds every_steps. False otherwise.

tf.train.SecondOrStepTimer.update_last_triggered_step

update_last_triggered_step(step)

Update the last triggered time and step number.

Args:

  • step: The current step.

Returns:

A pair (elapsed_time, elapsed_steps), where elapsed_time is the number of seconds between the current trigger and the last one (a float), and elapsed_steps is the number of steps between the current trigger and the last one. Both values will be set to None on the first trigger.