tf.compat.v1.train.SecondOrStepTimer
Stay organized with collections
Save and categorize content based on your preferences.
Timer that triggers at most once every N seconds or once every N steps.
tf.compat.v1.train.SecondOrStepTimer(
every_secs=None, every_steps=None
)
This symbol is also exported to v2 in tf.estimator namespace. See
https://github.com/tensorflow/estimator/blob/master/tensorflow_estimator/python/estimator/hooks/basic_session_run_hooks.py
Methods
last_triggered_step
View source
last_triggered_step()
Returns the last triggered time step or None if never triggered.
reset
View source
reset()
Resets the timer.
should_trigger_for_step
View source
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.
|
update_last_triggered_step
View source
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates. Some content is licensed under the numpy license.
Last updated 2024-04-26 UTC.
[null,null,["Last updated 2024-04-26 UTC."],[],[],null,["# tf.compat.v1.train.SecondOrStepTimer\n\n\u003cbr /\u003e\n\n|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.16.1/tensorflow/python/training/basic_session_run_hooks.py#L85-L150) |\n\nTimer that triggers at most once every N seconds or once every N steps. \n\n tf.compat.v1.train.SecondOrStepTimer(\n every_secs=None, every_steps=None\n )\n\nThis symbol is also exported to v2 in tf.estimator namespace. See\n\u003chttps://github.com/tensorflow/estimator/blob/master/tensorflow_estimator/python/estimator/hooks/basic_session_run_hooks.py\u003e\n\nMethods\n-------\n\n### `last_triggered_step`\n\n[View source](https://github.com/tensorflow/tensorflow/blob/v2.16.1/tensorflow/python/training/basic_session_run_hooks.py#L149-L150) \n\n last_triggered_step()\n\nReturns the last triggered time step or None if never triggered.\n\n### `reset`\n\n[View source](https://github.com/tensorflow/tensorflow/blob/v2.16.1/tensorflow/python/training/basic_session_run_hooks.py#L105-L107) \n\n reset()\n\nResets the timer.\n\n### `should_trigger_for_step`\n\n[View source](https://github.com/tensorflow/tensorflow/blob/v2.16.1/tensorflow/python/training/basic_session_run_hooks.py#L109-L134) \n\n should_trigger_for_step(\n step\n )\n\nReturn true if the timer should trigger for the specified step.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ||\n|--------|------------------------------|\n| `step` | Training step to trigger on. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|---|---|\n| 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. ||\n\n\u003cbr /\u003e\n\n### `update_last_triggered_step`\n\n[View source](https://github.com/tensorflow/tensorflow/blob/v2.16.1/tensorflow/python/training/basic_session_run_hooks.py#L136-L147) \n\n update_last_triggered_step(\n step\n )\n\nUpdate the last triggered time and step number.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ||\n|--------|-------------------|\n| `step` | The current step. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|---|---|\n| 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. ||\n\n\u003cbr /\u003e"]]
View source on GitHub