Mention truncation in the migration guide #105
Merged
Conversation
This file contains 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
10 tasks
araffin
reviewed
Nov 2, 2022
| ```{eval-rst} | ||
| In v21, the :class:`TimeLimit` wrapper added an extra key in the ``info`` dictionary ``TimeLimit.truncated`` whenever the agent reached the time limit without reaching a terminal state. | ||
|
|
||
| In v26, this information is instead communicated through the `truncated` return value described in the previous section, which is `True` if the agent reaches the time limit, whether or not it reaches a terminal state. The old dictionary entry is equivalent to ``truncated and not terminated`` |
There was a problem hiding this comment.
As discussed in #101, truncated can be true without the agent reaching the timelimit.
As suggested in pseudo-rnd-thoughts/gym#1 (comment), it would also be nice to add a TL;DR codeblock as done by pytorch for breaking changes: https://github.com/pytorch/pytorch/releases/tag/v1.12.0
pseudo-rnd-thoughts
approved these changes
Jan 5, 2023
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.
See openai/gym#3102.
This adds an explicit mention of this change to the migration guide, also including the edge case where
terminated == truncated == TrueCan someone familiar with the docs format check if the code is written properly?