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, optional) – 动作张量规范。如果未提供且目标熵为 "auto"，将从 actor 中获取。

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

• target_entropy (float or str, optional) – 随机策略的目标熵。默认为 “auto”，此时目标熵计算为 -prod(n_actions)。

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

• separate_losses (bool, optional) – 如果为 True，策略和 critic 之间的共享参数将只在策略损失上训练。默认为 False，即梯度将传播到策略和 critic 损失的共享参数上。

• reduction (str, optional) – 指定应用于输出的归约方法： "none" | "mean" | "sum"。"none"：不应用归约，"mean"：输出的总和除以输出中的元素数量，"sum"：输出将被求和。默认值："mean"。

示例

>>> 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"] 加上 actor 和 qvalue 网络的 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[Tensor, Dict[str, Tensor]]

计算 actor 损失。

actor 损失应在计算 qvalue_loss() 之后、~.alpha_loss 之前计算，因为 ~.alpha_loss 需要此方法返回的 metadata 中的 log_prob 字段。

参数:

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

返回值：一个可微分的张量，包含 alpha 损失以及一个元数据字典，该字典包含采样动作的 detached “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()，并返回一个 tensordict，其中包含这些值以及 “alpha” 值和 “entropy” 值（detached）。要查看输入 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) – 一个包含参数和持久缓冲区的字典。

• strict (bool, optional) – 是否严格强制要求 state_dict 中的键与此模块的 state_dict() 函数返回的键匹配。默认值：True

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

返回值:

• missing_keys 是一个包含任何此模块预期

  但提供的 state_dict 中缺失的键的字符串列表。

• unexpected_keys 是一个包含任何不

  在此模块预期但存在于提供的 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, optional) – 如果为 True，如果无法确定目标熵，则返回 None。否则引发异常。默认为 True。

qvalue_loss(tensordict: TensorDictBase) → Tuple[Tensor, Dict[str, Tensor]]

计算 q 值损失。

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

参数:

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

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

用于优先级采样的 detached “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, optional) – 如果提供，模块的状态将更新到该字典中并返回同一对象。否则，将创建一个 OrderedDict 并返回。默认值：None。

• prefix (str, optional) – 添加到参数和缓冲区名称的前缀，用于构成 state_dict 中的键。默认值：''。

• keep_vars (bool, optional) – 默认情况下，state dict 中返回的 Tensor 会从 autograd 分离。如果设置为 True，则不会执行分离操作。默认值：False。

返回值:

一个包含模块整个状态的字典

返回值类型:

dict

示例

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

属性 target_entropy_buffer

目标熵。

此值可以通过构造器中的 target_entropy kwarg 控制。