Skip to content

Commit ee4006a

Browse files
author
Vincent Moens
committed
[Doc] Add Tokenizer and auto-reset doc link
ghstack-source-id: 90f55b5 Pull Request resolved: #2754
1 parent fa697fe commit ee4006a

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

docs/source/reference/envs.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,8 @@ single agent standards.
509509
Auto-resetting Envs
510510
-------------------
511511

512+
.. _autoresetting_envs:
513+
512514
Auto-resetting environments are environments where calls to :meth:`~torchrl.envs.EnvBase.reset` are not expected when
513515
the environment reaches a ``"done"`` state during a rollout, as the reset happens automatically.
514516
Usually, in such cases the observations delivered with the done and reward (which effectively result from performing the
@@ -920,6 +922,7 @@ to be able to create this other composition:
920922
TargetReturn
921923
TensorDictPrimer
922924
TimeMaxPool
925+
Tokenizer
923926
ToTensorImage
924927
TrajCounter
925928
UnaryTransform

torchrl/envs/common.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,9 @@ class EnvBase(nn.Module, metaclass=_EnvPostInit):
317317
.. note:: The auto-resetting is achieved by the `EnvBase` metaclass. It does not appear in the
318318
`__init__` method and is included in the keyword arguments strictly for type-hinting purpose.
319319
320+
.. seealso:: The :ref:`auto-resetting environments API <autoresetting_envs>` section in the API
321+
documentation.
322+
320323
Attributes:
321324
done_spec (Composite): equivalent to ``full_done_spec`` as all
322325
``done_specs`` contain at least a ``"done"`` and a ``"terminated"`` entry

0 commit comments

Comments
 (0)