DiscreteSACLoss

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

離散 SAC 損失模組。

引數：

• actor_network (ProbabilisticActor) – 要訓練的 actor

• qvalue_network (TensorDictModule) – 單個 Q 值網路，將根據需要複製多次。

• action_space (str 或 TensorSpec) – 動作空間。必須是 "one-hot"、"mult_one_hot"、"binary" 或 "categorical" 之一，或者是相應規範的例項 (torchrl.data.OneHot, torchrl.data.MultiOneHot, torchrl.data.Binary 或 torchrl.data.Categorical)。

• 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"。

• skip_done_states (bool, 可選) – 用於價值計算的 actor 網路是否僅在有效、非終止的下一個狀態上執行。如果為 True，則假定 done 狀態可以廣播到資料的形狀，並且掩碼資料會產生有效的資料結構。這在 MARL 設定或使用 RNN 時可能不成立。預設為 False。

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data.tensor_specs import OneHot
>>> 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
>>> from tensordict import TensorDict
>>> from tensordict.nn import TensorDictModule
>>> n_act, n_obs = 4, 3
>>> spec = OneHot(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 和 qvalue 網路的 in_keys。返回值是按以下順序排列的張量元組：``[“loss_actor”, “loss_qvalue”, “loss_alpha”,

“alpha”, “entropy”]``

輸出鍵也可以使用 DiscreteSACLoss.select_out_keys() 方法進行過濾。

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data.tensor_specs import OneHot
>>> 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 = OneHot(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()

default_keys

_AcceptedKeys 的別名

forward(tensordict: TensorDictBase = None) → TensorDictBase

它旨在讀取輸入的 TensorDict 並返回另一個包含以“loss*”命名的損失鍵的 tensordict。

將損失分解為其組成部分後，訓練器可以使用它來記錄整個訓練過程中的各種損失值。輸出 tensordict 中存在的其他標量也將被記錄。

引數：

tensordict – 包含計算損失所需值的輸入 tensordict。

返回：

一個新的不帶批次維度的 tensordict，其中包含各種名為“loss*”的損失標量。損失必須以此名稱返回，因為訓練器在反向傳播之前會讀取它們，這一點至關重要。

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)