[Orbit] Add PeriodicAction utility#13596
Open
LINYV0719 wants to merge 1 commit intotensorflow:masterfrom
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a new utility class
PeriodicActiontoorbit/actions.Motivation:
Currently, actions in Orbit are typically executed every time the
Controllerloop completes (steps_per_loop). Users often need to execute certain actions at a different, less frequent interval without changing thesteps_per_loopsetting which might affect preemption granularityChanges:
PeriodicActionclass which wraps any callableActionglobal_step % interval == 0to decide whether to execute the wrapped actionorbit/actions/periodic_action_test.pyto verify the executionactions/init Changes:
PeriodicActioninorbit/actions/__init__.pyfor easier accessType of change
Tests
I added a new test suite
orbit.actions.periodic_action_testto verify the logic.Test Configuration:
python -m orbit.actions.periodic_action_testglobal_stepmatches the interval.Checklist