From 87ab3f13161120de73200f4c17dc95045bc024e9 Mon Sep 17 00:00:00 2001 From: Ariel Kwiatkowski Date: Tue, 1 Nov 2022 22:02:01 +0100 Subject: [PATCH] Update migration-guide.md --- docs/content/migration-guide.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/content/migration-guide.md b/docs/content/migration-guide.md index 58dd43cc99..9657d229bc 100644 --- a/docs/content/migration-guide.md +++ b/docs/content/migration-guide.md @@ -92,6 +92,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 bootstraping 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}