reference/generated/tensordict.nn.composite_lp_aggregate

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

composite_lp_aggregate

tensordict.nn.composite_lp_aggregate(nowarn: bool = False) → bool | None

Returns whether a CompositeDistribution log-probabilities and entropies will be aggregated in a single tensor.

Returns False unless set_composite_lp_aggregate or the COMPOSITE_LP_AGGREGATE environment variable set it to True. See the log-probability key table of ProbabilisticTensorDictModule for what each value changes.

Parameters:

nowarn (bool, optional) – has no effect. Defaults to False.

See also

set_composite_lp_aggregate()