Skip to content

Commit

Permalink
Mention truncation in the migration guide (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
RedTachyon authored Jan 5, 2023
1 parent e8897ff commit 82b839f
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/content/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,13 @@ For users looping through an environment, they should modify ``done = terminated
For training libraries, the primary difference is to change ``done`` to ``terminated``, indicating whether bootstrapping should or shouldn't happen.
```

## TimeLimit Wrapper
```{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``
```

## Environment Render

```{eval-rst}
Expand Down

0 comments on commit 82b839f

Please sign in to comment.