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, optional) – 指定應用於輸出的約簡："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"] + 策略和評估器網路的 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 損失以及一個元資料字典，其中包含已分離的取樣動作的 “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, optional) – 當設定為 False 時，將保留當前模組中張量的屬性；當設定為 True 時，將保留 state_dict 中張量的屬性。唯一的例外是 Parameter 的 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, 可選) – 如果為 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, optional) – 如果提供，模組的狀態將更新到 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, optional) – 預設情況下，state dict 中返回的 Tensors 會從 autograd 中分離。如果設定為 True，則不會執行分離。預設為 False。

返回:

包含模組整體狀態的字典

返回型別:

dict

示例

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

property target_entropy_buffer

目標熵。

此值可透過建構函式中的 target_entropy 關鍵字引數進行控制。