DiscreteSACLoss¶
- class torchrl.objectives.DiscreteSACLoss(*args, **kwargs)[來源]¶
離散 SAC 損失模組。
- 參數:
actor_network (ProbabilisticActor) – 要訓練的 actor。
qvalue_network (TensorDictModule) – 單一 Q 值網路,將根據需要多次複製。
action_space (str or TensorSpec) – 動作空間。必須是
"one-hot"
、"mult_one_hot"
、"binary"
或"categorical"
其中之一,或相應規格的實例 (torchrl.data.OneHot
、torchrl.data.MultiOneHot
、torchrl.data.Binary
或torchrl.data.Categorical
)。num_actions (int, optional) – 動作空間中的動作數量。如果 target_entropy 設定為 “auto”,則必須提供。
num_qvalue_nets (int, optional) – 要訓練的 Q 值網路數量。預設值為 2。
loss_function (str, optional) – 用於 Q 值的損失函數。可以是 “smooth_l1”、“l2”、“l1” 其中之一。預設值為 “smooth_l1”。
alpha_init (float, optional) – 初始熵乘數。預設值為 1.0。
min_alpha (float, optional) – alpha 的最小值。預設值為 None (無最小值)。
max_alpha (float, optional) – alpha 的最大值。預設值為 None (無最大值)。
fixed_alpha (bool, optional) – 是否應訓練 alpha 以匹配目標熵。預設值為
False
。target_entropy_weight (float, optional) – 目標熵項的權重。
target_entropy (Union[str, Number], optional) – 隨機策略的目標熵。預設值為 “auto”。
delay_qvalue (bool, optional) – 是否將目標 Q 值網路與用於資料收集的 Q 值網路分開。預設值為
False
。priority_key (str, optional) – [已棄用,請改用 .set_keys(priority_key=priority_key)] 用於寫入優先重播緩衝區優先值的鍵。預設值為 “td_error”。
separate_losses (bool, optional) – 如果
True
,策略 (policy) 和評論家 (critic) 之間的共享參數將僅針對策略損失進行訓練。預設為False
,即梯度會傳播到策略和評論家損失的共享參數。reduction (str, optional) – 指定應用於輸出的縮減方式:
"none"
|"mean"
|"sum"
。"none"
:不套用任何縮減;"mean"
:輸出總和將除以輸出中的元素數量;"sum"
:將輸出加總。預設值:"mean"
。
範例:>>> 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()
- forward(tensordict: TensorDictBase = None) 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)