VecNorm

class torchrl.envs.transforms.VecNorm(in_keys: Optional[Sequence[NestedKey]] = None, out_keys: Optional[Sequence[NestedKey]] = None, shared_td: Optional[TensorDictBase] = None, lock: Optional[Lock] = None, decay: float = 0.9999, eps: float = 0.0001, shapes: Optional[List[Size]] = None)

用于 torchrl 环境的移动平均归一化层。

VecNorm 跟踪数据集的汇总统计信息，以便即时对其进行标准化。如果变换处于“eval”模式，则不会更新运行统计信息。

如果多个进程正在运行类似的环境，则可以传递放置在共享内存中的 TensorDictBase 实例：如果是这样，则每次查询归一化层时，它都会更新共享相同引用的所有进程的值。

要在推理时使用 VecNorm 并避免使用新观测值更新值，应将此层替换为 to_observation_norm()。这将提供 VecNorm 的静态版本，该版本在源变换更新时不会更新。要获取 VecNorm 层的冻结副本，请参阅 frozen_copy()。

参数:

• in_keys (NestedKey 序列, 可选) – 要更新的键。默认值：[“observation”, “reward”]

• out_keys (NestedKey 序列, 可选) – 目标键。默认为 in_keys。

• shared_td (TensorDictBase, 可选) – 包含变换键的共享 tensordict。

• lock (mp.Lock) – 用于防止进程之间出现竞争条件的锁。默认为 None（在 init 期间创建锁）。

• decay (数字, 可选) – 移动平均的衰减率。默认值：0.99

• eps (数字, 可选) – 运行标准差的下限（用于数值下溢）。默认值为 1e-4。

• shapes (List[torch.Size], 可选) – 如果提供，则表示每个 in_keys 的形状。其长度必须与 in_keys 的长度匹配。每个形状必须与相应条目的尾部维度匹配。否则，条目的特征维度（即，所有不属于 tensordict 批大小的维度）将被视为特征维度。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> t = VecNorm(decay=0.9)
>>> env = GymEnv("Pendulum-v0")
>>> env = TransformedEnv(env, t)
>>> tds = []
>>> for _ in range(1000):
...     td = env.rand_step()
...     if td.get("done"):
...         _ = env.reset()
...     tds += [td]
>>> tds = torch.stack(tds, 0)
>>> print((abs(tds.get(("next", "observation")).mean(0))<0.2).all())
tensor(True)
>>> print((abs(tds.get(("next", "observation")).std(0)-1)<0.2).all())
tensor(True)

static build_td_for_shared_vecnorm(env: EnvBase, keys: Optional[Sequence[str]] = None, memmap: bool = False) → TensorDictBase

创建用于跨进程归一化的共享 tensordict。

参数:

• env (EnvBase) – 用于创建 tensordict 的示例环境

• keys (NestedKey 序列, 可选) – 必须归一化的键。默认值为 [“next”, “reward”]

• memmap (bool) – 如果为 True，则生成的 tensordict 将被转换为内存映射（使用 memmap_()）。否则，tensordict 将放置在共享内存中。

返回:

共享内存中的内存，将发送到每个进程。

示例

>>> from torch import multiprocessing as mp
>>> queue = mp.Queue()
>>> env = make_env()
>>> td_shared = VecNorm.build_td_for_shared_vecnorm(env,
...     ["next", "reward"])
>>> assert td_shared.is_shared()
>>> queue.put(td_shared)
>>> # on workers
>>> v = VecNorm(shared_td=queue.get())
>>> env = TransformedEnv(make_env(), v)

forward(tensordict: TensorDictBase) → TensorDictBase

读取输入 tensordict，并为选定的键应用变换。

freeze() → VecNorm

冻结 VecNorm，避免在调用时更新统计信息。

请参阅 unfreeze()。

frozen_copy()

返回 Transform 的副本，该副本跟踪统计信息，但不更新它们。

get_extra_state() → OrderedDict

返回要包含在模块 state_dict 中的任何额外状态。

如果您需要存储额外状态，请为您的模块实现此功能和相应的 set_extra_state()。此函数在构建模块的 state_dict() 时调用。

请注意，额外状态应该是可 pickle 的，以确保 state_dict 的工作序列化。我们仅为序列化 Tensor 提供向后兼容性保证；如果其他对象的序列化 pickle 形式发生更改，则可能会破坏向后兼容性。

返回:

要存储在模块 state_dict 中的任何额外状态

返回类型:

object

property loc

返回一个 TensorDict，其中包含用于仿射变换的 loc。

property scale

返回一个 TensorDict，其中包含用于仿射变换的 scale。

set_extra_state(state: OrderedDict) → None

设置加载的 state_dict 中包含的额外状态。

此函数从 load_state_dict() 调用，以处理在 state_dict 中找到的任何额外状态。如果您需要在模块的 state_dict 中存储额外状态，请为您的模块实现此函数和相应的 get_extra_state()。

参数:

state (dict) – 来自 state_dict 的额外状态

property standard_normal

由 loc 和 scale 给出的仿射变换是否遵循标准正态方程。

类似于 ObservationNorm standard_normal 属性。

始终返回 True。

to_observation_norm() → Union[Compose, ObservationNorm]

将 VecNorm 转换为可在推理时使用的 ObservationNorm 类。

可以使用 state_dict() API 更新 ObservationNorm 层。

示例

>>> from torchrl.envs import GymEnv, VecNorm
>>> vecnorm = VecNorm(in_keys=["observation"])
>>> train_env = GymEnv("CartPole-v1", device=None).append_transform(
...     vecnorm)
>>>
>>> r = train_env.rollout(4)
>>>
>>> eval_env = GymEnv("CartPole-v1").append_transform(
...     vecnorm.to_observation_norm())
>>> print(eval_env.transform.loc, eval_env.transform.scale)
>>>
>>> r = train_env.rollout(4)
>>> # Update entries with state_dict
>>> eval_env.transform.load_state_dict(
...     vecnorm.to_observation_norm().state_dict())
>>> print(eval_env.transform.loc, eval_env.transform.scale)

transform_observation_spec(observation_spec: TensorSpec) → TensorSpec

转换观测规范，使生成的规范与变换映射匹配。

参数:

observation_spec (TensorSpec) – 变换前的规范

返回:

变换后预期的规范

unfreeze() → VecNorm

解冻 VecNorm。

请参阅 freeze()。