PixelRenderTransform

torchrl.record.PixelRenderTransform(out_keys: List[NestedKey] = None, preproc: Callable[[np.ndarray | torch.Tensor], np.ndarray | torch.Tensor] = None, as_non_tensor: bool = None, render_method: str = 'render', pass_tensordict: bool = False, **kwargs) → None

一個 transform，用於在其父環境上呼叫 render 方法，並在 tensordict 中註冊畫素觀察結果。

這個 transform 提供了一種替代 from_pixels 語法糖的方式，適用於例項化支援渲染的環境成本較高，或 from_pixels 未實現的情況。它既可以在單個環境中使用，也可以在批次環境中類似地使用。

引數:

• out_keys (List[NestedKey] 或 Nested) – 用於註冊畫素觀察結果的鍵列表。

• preproc (Callable, 可選) – 預處理函式。可用於重塑觀察結果，或應用任何其他使其能夠在輸出資料中註冊的轉換。

• as_non_tensor (bool, 可選) – 如果為 True，資料將作為 NonTensorData 寫入，從而放寬形狀要求。如果未提供，將根據輸入資料型別和形狀自動推斷。

• render_method (str, 可選) – render 方法的名稱。預設為 "render"。

• pass_tensordict (bool, 可選) – 如果為 True，輸入的 tensordict 將傳遞給 render 方法。這使得無狀態環境能夠進行渲染。預設為 False。

• **kwargs – 要傳遞給 render 函式的額外關鍵字引數（例如 mode="rgb_array"）。

示例

>>> from torchrl.envs import GymEnv, check_env_specs, ParallelEnv, EnvCreator
>>> from torchrl.record.loggers import CSVLogger
>>> from torchrl.record.recorder import PixelRenderTransform, VideoRecorder
>>>
>>> def make_env():
>>>     env = GymEnv("CartPole-v1", render_mode="rgb_array")
>>>     env = env.append_transform(PixelRenderTransform())
>>>     return env
>>>
>>> if __name__ == "__main__":
...     logger = CSVLogger("dummy", video_format="mp4")
...
...     env = ParallelEnv(4, EnvCreator(make_env))
...
...     env = env.append_transform(VideoRecorder(logger=logger, tag="pixels_record"))
...     env.rollout(3)
...
...     check_env_specs(env)
...
...     r = env.rollout(30)
...     print(env)
...     env.transform.dump()
...     env.close()

當批次環境的 render() 方法返回單個影像時，也可以使用此 transform

示例

>>> from torchrl.envs import check_env_specs
>>> from torchrl.envs.libs.vmas import VmasEnv
>>> from torchrl.record.loggers import CSVLogger
>>> from torchrl.record.recorder import PixelRenderTransform, VideoRecorder
>>>
>>> env = VmasEnv(
...     scenario="flocking",
...     num_envs=32,
...     continuous_actions=True,
...     max_steps=200,
...     device="cpu",
...     seed=None,
...     # Scenario kwargs
...     n_agents=5,
... )
>>>
>>> logger = CSVLogger("dummy", video_format="mp4")
>>>
>>> env = env.append_transform(PixelRenderTransform(mode="rgb_array", preproc=lambda x: x.copy()))
>>> env = env.append_transform(VideoRecorder(logger=logger, tag="pixels_record"))
>>>
>>> check_env_specs(env)
>>>
>>> r = env.rollout(30)
>>> env.transform[-1].dump()

可以使用 switch() 方法停用 transform，這將使渲染在關閉時開啟，在開啟時關閉（也可以傳遞引數來控制此行為）。由於 transforms 是 Module 例項，可以使用 apply() 來控制此行為

>>> def switch(module):
...     if isinstance(module, PixelRenderTransform):
...         module.switch()
>>> env.apply(switch)