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

一個轉換，用於在父環境上呼叫 render，並在 tensordict 中註冊像素觀察。

當實例化提供渲染的環境成本高昂，或者未實作 from_pixels 時，此轉換提供了一個替代 from_pixels 語法糖的方法。 它既可以用於單個環境，也可以用於批次處理的環境。

參數:

• out_keys (List[NestedKey] or Nested) – 註冊像素觀測值的鍵列表。

• preproc (Callable, optional) – 一個 preproc 函數。 可用於重塑觀測值，或應用任何其他轉換，使其能夠在輸出資料中註冊。

• as_non_tensor (bool, optional) – 如果 True，資料將以 NonTensorData 的形式寫入，從而放寬形狀要求。 如果未提供，將自動從輸入資料類型和形狀推斷。

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

• pass_tensordict (bool, optional) – 如果 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() 傳回單個圖像時，也可以使用此轉換

範例

>>> 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() 方法禁用此轉換，如果渲染關閉則開啟渲染，如果渲染開啟則關閉渲染（也可以傳遞參數來控制此行為）。 由於轉換是 Module 實例，因此可以使用 apply() 來控制此行為

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