reference/generated/torchrl.set_auto_unwrap_transformed_env

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

set_auto_unwrap_transformed_env

class torchrl.set_auto_unwrap_transformed_env(mode: bool)

A context manager or decorator to control whether TransformedEnv should automatically unwrap nested TransformedEnv instances.

Parameters:

mode (bool) – Whether to automatically unwrap nested TransformedEnv instances. If False, TransformedEnv will not unwrap nested instances. Defaults to True.

Note

If this value is not set explicitly, nesting TransformedEnv instances emits an informational warning and uses auto_unwrap=True. You can set the value of auto_unwrap_transformed_env() through:

• The AUTO_UNWRAP_TRANSFORMED_ENV environment variable;

• By setting torchrl.set_auto_unwrap_transformed_env(val: bool).set() at the beginning of your script;

• By using torchrl.set_auto_unwrap_transformed_env(val: bool) as a context manager or a decorator.

See also

TransformedEnv

Examples

>>> with set_auto_unwrap_transformed_env(False):
...     env = TransformedEnv(TransformedEnv(env))
...     assert not isinstance(env.base_env, TransformedEnv)
>>> @set_auto_unwrap_transformed_env(False)
... def my_function():
...     env = TransformedEnv(TransformedEnv(env))
...     assert not isinstance(env.base_env, TransformedEnv)
...     return env