[rllib] Fix incorrect log value of environment steps sampled/trained #56599
+76
−39
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.
Why are these changes needed?
Currently
learners/__all_modules__/num_env_steps_trained
has a strangely large value, multiple times higher thanlearners/__all_modules__/num_module_steps_trained
.This is due to a logging error as
minibatch.env_steps()
reports the size of the whole batch.This is confusing but, seems to be intended (once):
minibatch = MultiAgentBatch(minibatch, env_steps=len(whole_batch))
ray/rllib/utils/minibatch_utils.py
Lines 174 to 178 in 3a1750b
Due to this fallacy the whole batch_size is logged for each mini batch iteration creating a too large value:
For example:
I have a batch size and sample size of 2048, train for 20 epochs with a minibatch size of 128. The resulting learners log is:
num_module_steps_trained
is correctnum_module_steps_trained = 2048 samples * 20 epochs = 128 minibatch_size * (2048/128 minibatch cycles) * 20 epochs.
However,
num_env_steps_trained
makes no sense - it is 16 times higher. It is calculated:2048 samples * 20 epochs * (16 = 2048 / 128 minibatch cycles) = 2048 * 320 iterations total
Related issue number
https://discuss.ray.io/t/is-the-num-env-steps-trained-logged-incorrectly-if-not-how-to-interpret-it-compared-to-num-module-steps-trained/22616
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.