CrossQLoss

class torchrl.objectives.CrossQLoss(*args, **kwargs)

TorchRL 实现的 CrossQ 损失。

在“CROSSQ: BATCH NORMALIZATION IN DEEP REINFORCEMENT LEARNING FOR GREATER SAMPLE EFFICIENCY AND SIMPLICITY” https://openreview.net/pdf?id=PczQtTsTIX 中提出

此类有三个损失函数，它们将按顺序由 `forward` 方法调用：`qvalue_loss()`、`actor_loss()` 和 `alpha_loss()`。 或者，用户也可以按照自己的顺序调用它们。

参数:

• actor_network (ProbabilisticActor) – 随机策略

• qvalue_network (TensorDictModule) –

  Q(s, a) 参数化模型。该模块通常输出一个 `"state_action_value"` 条目。如果提供了一个 `qvalue_network` 实例，它将被复制 `num_qvalue_nets` 次。如果传递了一个模块列表，它们的参数将被堆叠，除非它们共享相同的身份（在这种情况下，原始参数将被扩展）。

  警告

  当传入参数列表时，它 __不会__ 与策略参数进行比较，所有参数都将被视为独立的。

关键字参数:

• num_qvalue_nets (integer, optional) – 使用的 Q 值网络的数量。默认为 2。

• loss_function (str, optional) – 要用于值函数损失的损失函数。默认为 “smooth_l1”。

• alpha_init (float, optional) – 初始熵乘数。默认为 1.0。

• min_alpha (float, optional) – alpha 的最小值。默认为 None（无最小值）。

• max_alpha (float, optional) – alpha 的最大值。默认为 None（无最大值）。

• action_spec (TensorSpec, 可选) – 动作张量规范。如果未提供且目标熵为 `"auto"`，则将从策略中检索。

• fixed_alpha (bool, 可选) – 如果为 `True`，则 alpha 将固定为其初始值。否则，alpha 将被优化以匹配 ‘target_entropy’ 值。默认为 `False`。

• target_entropy (float 或 str, 可选) – 随机策略的目标熵。默认为 `"auto"`，此时目标熵计算为 `-prod(n_actions)`。

• priority_key (str, 可选) – [已弃用，请改用 `.set_keys(priority_key=priority_key)`] 优先级将被写入的 tensordict 键（用于优先回放缓冲区）。默认为 `"td_error"`。

• separate_losses (bool, 可选) – 如果为 `True`，则策略和评估器之间的共享参数仅用于策略损失的训练。默认为 `False`，即梯度会同时传播到策略和评估器的共享参数。

• reduction (str, 可选) – 指定应用于输出的缩减方法：`"none"` | `"mean"` | `"sum"`。`"none"`：不应用任何缩减，`"mean"`：输出的总和除以输出中的元素数量，`"sum"`：输出将被求和。默认为 `"mean"`。

• deactivate_vmap (bool, 可选) – 是否禁用 vmap 调用并用普通 for 循环替换它们。默认为 False。

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data import Bounded
>>> from torchrl.modules.distributions import NormalParamExtractor, TanhNormal
>>> from torchrl.modules.tensordict_module.actors import ProbabilisticActor, ValueOperator
>>> from torchrl.modules.tensordict_module.common import SafeModule
>>> from torchrl.objectives.crossq import CrossQLoss
>>> from tensordict import TensorDict
>>> n_act, n_obs = 4, 3
>>> spec = Bounded(-torch.ones(n_act), torch.ones(n_act), (n_act,))
>>> net = nn.Sequential(nn.Linear(n_obs, 2 * n_act), NormalParamExtractor())
>>> module = SafeModule(net, in_keys=["observation"], out_keys=["loc", "scale"])
>>> actor = ProbabilisticActor(
...     module=module,
...     in_keys=["loc", "scale"],
...     spec=spec,
...     distribution_class=TanhNormal)
>>> class ValueClass(nn.Module):
...     def __init__(self):
...         super().__init__()
...         self.linear = nn.Linear(n_obs + n_act, 1)
...     def forward(self, obs, act):
...         return self.linear(torch.cat([obs, act], -1))
>>> module = ValueClass()
>>> qvalue = ValueOperator(
...     module=module,
...     in_keys=['observation', 'action'])
>>> loss = CrossQLoss(actor, qvalue)
>>> batch = [2, ]
>>> action = spec.rand(batch)
>>> data = TensorDict({
...         "observation": torch.randn(*batch, n_obs),
...         "action": action,
...         ("next", "done"): torch.zeros(*batch, 1, dtype=torch.bool),
...         ("next", "terminated"): torch.zeros(*batch, 1, dtype=torch.bool),
...         ("next", "reward"): torch.randn(*batch, 1),
...         ("next", "observation"): torch.randn(*batch, n_obs),
...     }, batch)
>>> loss(data)
TensorDict(
    fields={
        alpha: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        entropy: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        loss_actor: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        loss_alpha: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        loss_qvalue: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

此类也兼容非 tensordict 的模块，并且可以在不依赖任何 tensordict 相关原语的情况下使用。在这种情况下，预期的关键字参数是：`["action", "next_reward", "next_done", "next_terminated"]` + 策略和 Q 值网络的 `in_keys`。返回值是一个按以下顺序排列的张量元组：`["loss_actor", "loss_qvalue", "loss_alpha", "alpha", "entropy"]`

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data import Bounded
>>> from torchrl.modules.distributions import NormalParamExtractor, TanhNormal
>>> from torchrl.modules.tensordict_module.actors import ProbabilisticActor, ValueOperator
>>> from torchrl.modules.tensordict_module.common import SafeModule
>>> from torchrl.objectives import CrossQLoss
>>> _ = torch.manual_seed(42)
>>> n_act, n_obs = 4, 3
>>> spec = Bounded(-torch.ones(n_act), torch.ones(n_act), (n_act,))
>>> net = nn.Sequential(nn.Linear(n_obs, 2 * n_act), NormalParamExtractor())
>>> module = SafeModule(net, in_keys=["observation"], out_keys=["loc", "scale"])
>>> actor = ProbabilisticActor(
...     module=module,
...     in_keys=["loc", "scale"],
...     spec=spec,
...     distribution_class=TanhNormal)
>>> class ValueClass(nn.Module):
...     def __init__(self):
...         super().__init__()
...         self.linear = nn.Linear(n_obs + n_act, 1)
...     def forward(self, obs, act):
...         return self.linear(torch.cat([obs, act], -1))
>>> module = ValueClass()
>>> qvalue = ValueOperator(
...     module=module,
...     in_keys=['observation', 'action'])
>>> loss = CrossQLoss(actor, qvalue)
>>> batch = [2, ]
>>> action = spec.rand(batch)
>>> loss_actor, loss_qvalue, _, _, _ = loss(
...     observation=torch.randn(*batch, n_obs),
...     action=action,
...     next_done=torch.zeros(*batch, 1, dtype=torch.bool),
...     next_terminated=torch.zeros(*batch, 1, dtype=torch.bool),
...     next_observation=torch.zeros(*batch, n_obs),
...     next_reward=torch.randn(*batch, 1))
>>> loss_actor.backward()

输出键也可以使用 `CrossQLoss.select_out_keys()` 方法进行过滤。

示例

>>> _ = loss.select_out_keys('loss_actor', 'loss_qvalue')
>>> loss_actor, loss_qvalue = loss(
...     observation=torch.randn(*batch, n_obs),
...     action=action,
...     next_done=torch.zeros(*batch, 1, dtype=torch.bool),
...     next_terminated=torch.zeros(*batch, 1, dtype=torch.bool),
...     next_observation=torch.zeros(*batch, n_obs),
...     next_reward=torch.randn(*batch, 1))
>>> loss_actor.backward()

actor_loss(tensordict: TensorDictBase) → tuple[torch.Tensor, dict[str, torch.Tensor]]

计算策略损失。

策略损失应在 `qvalue_loss()` 之后和 `~.alpha_loss` 之前计算，后者需要此方法返回的 `metadata` 中的 `log_prob` 字段。

参数:

tensordict (TensorDictBase) – 损失的输入数据。请查看类的 `in_keys` 以了解计算此损失所需的字段。

返回: 一个可微分的张量，包含 alpha 损失以及一个包含从 `metadata` 中分离出的 `"log_prob"` 的元数据字典。

alpha_loss(log_prob: Tensor) → Tensor

计算熵损失。

熵损失应最后计算。

参数:

log_prob (torch.Tensor) – 一个由 `actor_loss()` 计算并返回在 `metadata` 中的对数概率。

返回: 一个可微分的张量，包含熵损失。

default_keys

别名：_AcceptedKeys

forward(tensordict: TensorDictBase = None) → TensorDictBase

forward 方法。

依次计算 `qvalue_loss()`、`actor_loss()` 和 `alpha_loss()`，并返回一个包含这些值以及 `"alpha"` 值和（分离的）`"entropy"` 值的 tensordict。要查看输入 tensordict 中期望的键以及输出期望的键，请查看类的 `"in_keys"` 和 `"out_keys"` 属性。

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)

将参数和缓冲区从 `state_dict` 复制到此模块及其子模块中。

如果 `strict` 为 `True`，则 `state_dict` 的键必须与此模块的 `state_dict()` 函数返回的键完全匹配。

警告

如果 `assign` 为 `True`，则优化器必须在调用 `load_state_dict` 之后创建，除非 `get_swap_module_params_on_conversion()` 为 `True`。

参数:

• state_dict (dict) – 包含参数和持久 buffer 的字典。

• strict (bool, 可选) – 是否严格执行 `state_dict` 中的键与此模块的 `state_dict()` 函数返回的键匹配。默认：`True`

• assign (bool, 可选) – 当设置为 `False` 时，将保留当前模块中张量的属性；而设置为 `True` 时，则保留 state dict 中张量的属性。唯一的例外是 `requires_grad` 字段。默认：`False`

返回:

• missing_keys 是一个包含任何预期键的 str 列表。

  在提供的 state_dict 中缺失的任何键的字符串列表。

• unexpected_keys 是一个包含不匹配的键的 str 列表。

  不期望但在提供的 state_dict 中存在的键。

返回类型:

NamedTuple，具有 `missing_keys` 和 `unexpected_keys` 字段。

注意

如果参数或缓冲区注册为 `None` 且其对应键存在于 `state_dict` 中，则 `load_state_dict()` 将引发 `RuntimeError`。

make_value_estimator(value_type: Optional[ValueEstimators] = None, **hyperparams)

值函数构造函数。

如果需要非默认值函数，必须使用此方法构建。

参数:

• value_type (ValueEstimators) – 一个 `ValueEstimators` 枚举类型，指示要使用的价值函数。如果未提供，将使用存储在 `default_value_estimator` 属性中的默认值。生成的价值估计器类将注册在 `self.value_type` 中，以供将来改进。

• \*\*hyperparams – 用于价值函数的超参数。如果未提供，将使用 `default_value_kwargs()` 指定的值。

示例

>>> from torchrl.objectives import DQNLoss
>>> # initialize the DQN loss
>>> actor = torch.nn.Linear(3, 4)
>>> dqn_loss = DQNLoss(actor, action_space="one-hot")
>>> # updating the parameters of the default value estimator
>>> dqn_loss.make_value_estimator(gamma=0.9)
>>> dqn_loss.make_value_estimator(
...     ValueEstimators.TD1,
...     gamma=0.9)
>>> # if we want to change the gamma value
>>> dqn_loss.make_value_estimator(dqn_loss.value_type, gamma=0.9)

maybe_init_target_entropy(fault_tolerant=True)

初始化目标熵。

参数:

fault_tolerant (bool, 可选) – 如果为 `True`，则在无法确定目标熵时返回 None。否则会引发异常。默认为 `True`。

qvalue_loss(tensordict: TensorDictBase) → tuple[torch.Tensor, dict[str, torch.Tensor]]

计算 q 值损失。

q 值损失应在 `actor_loss()` 之前计算。

参数:

tensordict (TensorDictBase) – 损失的输入数据。请查看类的 `in_keys` 以了解计算此损失所需的字段。

返回: 一个可微分的张量，包含 q 值损失，以及一个元数据字典，其中包含

用于优先采样的 `"td_error"`（已分离）。

set_keys(**kwargs) → None

设置 tensordict 键名。

示例

>>> from torchrl.objectives import DQNLoss
>>> # initialize the DQN loss
>>> actor = torch.nn.Linear(3, 4)
>>> dqn_loss = DQNLoss(actor, action_space="one-hot")
>>> dqn_loss.set_keys(priority_key="td_error", action_value_key="action_value")

state_dict(*args, destination=None, prefix='', keep_vars=False)

返回一个字典，其中包含对模块整个状态的引用。

参数和持久缓冲区（例如，运行平均值）都包含在内。键是相应的参数和缓冲区名称。设置为 None 的参数和缓冲区不包含在内。

注意

返回的对象是浅拷贝。它包含对模块参数和缓冲区的引用。

警告

目前 `state_dict()` 也接受位置参数，顺序为 `destination`、`prefix` 和 `keep_vars`。但是，这正在被弃用，并且在未来的版本中将强制使用关键字参数。

警告

请避免使用参数 destination，因为它不是为最终用户设计的。

参数:

• destination (dict, 可选) – 如果提供，模块的状态将被更新到该字典中，并返回相同的对象。否则，将创建一个 `OrderedDict` 并返回。默认：`None`。

• prefix (str, optional) – a prefix added to parameter and buffer names to compose the keys in state_dict. Default: ''。

• keep_vars (bool, 可选) – 默认情况下，state_dict 中返回的 `Tensor` 已从自动微分中分离。如果设置为 `True`，则不会执行分离。默认：`False`。

返回:

包含模块整体状态的字典

返回类型:

dict

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> module.state_dict().keys()
['bias', 'weight']

property target_entropy_buffer

目标熵。

此值可以通过构造函数中的 `target_entropy` 关键字参数控制。