DiscreteSACLoss¶
- class torchrl.objectives.DiscreteSACLoss(*args, **kwargs)[source]¶
离散 SAC 损失模块。
- 参数:
actor_network (概率 Actor) – 要训练的 Actor
qvalue_network (TensorDictModule) – 一个单一的 Q 值网络,它将根据需要乘以多次。
action_space (str 或 TensorSpec) – 动作空间。必须是
"one-hot"
、"mult_one_hot"
、"binary"
或"categorical"
之一,或对应规范的实例 (torchrl.data.OneHotDiscreteTensorSpec
、torchrl.data.MultiOneHotDiscreteTensorSpec
、torchrl.data.BinaryDiscreteTensorSpec
或torchrl.data.DiscreteTensorSpec
)。num_actions (int, 可选) – 动作空间中的动作数量。如果 target_entropy 设置为“auto”,则需要提供。
num_qvalue_nets (int, 可选) – 要训练的 Q 值网络的数量。默认为 2。
loss_function (str, 可选) – 用于 Q 值的损失函数。可以是 “smooth_l1”、“l2”、“l1” 之一,默认为“smooth_l1”。
alpha_init (float, 可选) – 初始熵乘数。默认为 1.0。
min_alpha (float, 可选) – alpha 的最小值。默认为 None(无最小值)。
max_alpha (float, 可选) – alpha 的最大值。默认为 None(无最大值)。
fixed_alpha (bool, 可选) – alpha 是否应训练以匹配目标熵。默认为
False
。target_entropy_weight (float, 可选) – 目标熵项的权重。
target_entropy (Union[str, Number], 可选) – 随机策略的目标熵。默认为“auto”。
delay_qvalue (bool, 可选) – 是否将目标 Q 值网络与用于数据收集的 Q 值网络分开。默认为
False
。priority_key (str, 可选) – [已弃用,请改用 .set_keys(priority_key=priority_key) 代替] 用于将优先级值写入优先级回放缓冲区的键。默认为 “td_error”。
separate_losses (bool, 可选) – 如果
True
,则策略和评论家之间共享的参数将仅在策略损失上进行训练。默认为False
,即梯度会传播到策略和评论家损失的共享参数。reduction (str, 可选) – 指定要应用于输出的缩减:
"none"
|"mean"
|"sum"
。"none"
:不应用缩减,"mean"
:输出的总和将除以输出中的元素数量,"sum"
:输出将被求和。默认值:"mean"
。
示例: >>> 导入 torch >>> 从 torch 导入 nn >>> 从 torchrl.data.tensor_specs 导入 OneHotDiscreteTensorSpec >>> 从 torchrl.modules.distributions 导入 NormalParamExtractor、OneHotCategorical >>> 从 torchrl.modules.tensordict_module.actors 导入 ProbabilisticActor、ValueOperator >>> 从 torchrl.modules.tensordict_module.common 导入 SafeModule >>> 从 torchrl.objectives.sac 导入 DiscreteSACLoss >>> 从 tensordict 导入 TensorDict >>> 从 tensordict.nn 导入 TensorDictModule >>> n_act、n_obs = 4、3 >>> spec = OneHotDiscreteTensorSpec(n_act) >>> module = TensorDictModule(nn.Linear(n_obs, n_act), in_keys=[“observation”], out_keys=[“logits”]) >>> actor = ProbabilisticActor( … module=module, … in_keys=[“logits”], … out_keys=[“action”], … spec=spec, … distribution_class=OneHotCategorical) >>> qvalue = TensorDictModule( … nn.Linear(n_obs, n_act), … in_keys=[“observation”], … out_keys=[“action_value”], … ) >>> loss = DiscreteSACLoss(actor, qvalue, action_space=spec, num_actions=spec.space.n) >>> 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 和 Q 值网络的输入键。返回值是按以下顺序排列的张量元组:``[“loss_actor”, “loss_qvalue”, “loss_alpha”,“alpha”, “entropy”]``
输出键也可以使用
DiscreteSACLoss.select_out_keys()
方法进行过滤。示例
>>> import torch >>> from torch import nn >>> from torchrl.data.tensor_specs import OneHotDiscreteTensorSpec >>> from torchrl.modules.distributions import NormalParamExtractor, OneHotCategorical >>> from torchrl.modules.tensordict_module.actors import ProbabilisticActor, ValueOperator >>> from torchrl.modules.tensordict_module.common import SafeModule >>> from torchrl.objectives.sac import DiscreteSACLoss >>> n_act, n_obs = 4, 3 >>> spec = OneHotDiscreteTensorSpec(n_act) >>> net = nn.Sequential(nn.Linear(n_obs, 2 * n_act), NormalParamExtractor()) >>> module = SafeModule(net, in_keys=["observation"], out_keys=["logits"]) >>> actor = ProbabilisticActor( ... module=module, ... in_keys=["logits"], ... out_keys=["action"], ... spec=spec, ... distribution_class=OneHotCategorical) >>> class ValueClass(nn.Module): ... def __init__(self): ... super().__init__() ... self.linear = nn.Linear(n_obs, n_act) ... def forward(self, obs): ... return self.linear(obs) >>> module = ValueClass() >>> qvalue = ValueOperator( ... module=module, ... in_keys=['observation']) >>> loss = DiscreteSACLoss(actor, qvalue, num_actions=actor.spec["action"].space.n) >>> batch = [2, ] >>> action = spec.rand(batch) >>> # filter output keys to "loss_actor", and "loss_qvalue" >>> _ = 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()
- forward(tensordict: TensorDictBase) TensorDictBase [source]¶
它旨在读取输入 TensorDict 并返回另一个包含名为“loss*”的损失键的 TensorDict。
然后,训练器可以将其损失分解为各个组成部分,并在整个训练过程中记录各种损失值。输出 TensorDict 中的其他标量也将被记录。
- 参数:
tensordict – 一个包含计算损失所需值的输入 TensorDict。
- 返回值:
一个新的不包含批次维度的 TensorDict,其中包含各种名为“loss*”的损失标量。这些损失必须以该名称返回,因为它们将在反向传播之前由训练器读取。
- make_value_estimator(value_type: Optional[ValueEstimators] = None, **hyperparams)[source]¶
价值函数构造器。
如果需要非默认的价值函数,则必须使用此方法构建。
- 参数:
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)