tf_agents.train.interval_trigger.IntervalTrigger
Stay organized with collections
Save and categorize content based on your preferences.
Triggers on every fixed interval.
tf_agents.train.interval_trigger.IntervalTrigger(
interval: int, fn: Callable[[], None], start: int = 0
)
Note that as long as the >= interval
number of steps have passed since the
last trigger, the event gets triggered. The current value is not necessarily
interval
steps away from the last triggered value.
Args |
interval
|
The triggering interval.
|
fn
|
callable with no arguments that gets triggered.
|
start
|
An initial value for the trigger.
|
Methods
reset
View source
reset() -> None
Resets the trigger interval.
set_start
View source
set_start(
start: int
) -> None
__call__
View source
__call__(
value: int, force_trigger: bool = False
) -> None
Maybe trigger the event based on the interval.
Args |
value
|
the value for triggering.
|
force_trigger
|
If True, the trigger will be forced triggered unless the
last trigger value is equal to value .
|
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.
Last updated 2024-04-26 UTC.
[null,null,["Last updated 2024-04-26 UTC."],[],[],null,["# tf_agents.train.interval_trigger.IntervalTrigger\n\n\u003cbr /\u003e\n\n|------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/agents/blob/v0.19.0/tf_agents/train/interval_trigger.py#L23-L72) |\n\nTriggers on every fixed interval. \n\n tf_agents.train.interval_trigger.IntervalTrigger(\n interval: int, fn: Callable[[], None], start: int = 0\n )\n\nNote that as long as the \\\u003e= `interval` number of steps have passed since the\nlast trigger, the event gets triggered. The current value is not necessarily\n`interval` steps away from the last triggered value.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|------------|-------------------------------------------------|\n| `interval` | The triggering interval. |\n| `fn` | callable with no arguments that gets triggered. |\n| `start` | An initial value for the trigger. |\n\n\u003cbr /\u003e\n\nMethods\n-------\n\n### `reset`\n\n[View source](https://github.com/tensorflow/agents/blob/v0.19.0/tf_agents/train/interval_trigger.py#L67-L69) \n\n reset() -\u003e None\n\nResets the trigger interval.\n\n### `set_start`\n\n[View source](https://github.com/tensorflow/agents/blob/v0.19.0/tf_agents/train/interval_trigger.py#L71-L72) \n\n set_start(\n start: int\n ) -\u003e None\n\n### `__call__`\n\n[View source](https://github.com/tensorflow/agents/blob/v0.19.0/tf_agents/train/interval_trigger.py#L50-L65) \n\n __call__(\n value: int, force_trigger: bool = False\n ) -\u003e None\n\nMaybe trigger the event based on the interval.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ||\n|-----------------|--------------------------------------------------------------------------------------------------|\n| `value` | the value for triggering. |\n| `force_trigger` | If True, the trigger will be forced triggered unless the last trigger value is equal to `value`. |\n\n\u003cbr /\u003e"]]