Skip to content

← distributions package

DistributionEntropy

Calculate the entropy of a provided (wired-in) probability distribution.

This is generally a scalar, but the value will be an array if the distribution itself is batched, as in, is parameterized by a batch of parameters (e.g., multiple sets of locations or scales). In these cases, the shape of the result is (batch_shape). Note that the entropy is not available if your you have chosen numpyro as the backend for your distribution, but when available, it is the analytic, i.e. exact, result. Entropy is also not readily available for sampling-based distributions (e.g., those obtained from one of the Inference nodes). More Info... Version 1.0.0

Ports/Properties

dist

Distribution to use.

  • verbose name: Dist
  • default value: None
  • port type: DataPort
  • value type: Distribution (can be None)
  • data direction: IN

value

Resulting value.

  • verbose name: Value
  • default value: None
  • port type: DataPort
  • value type: AnyNumeric (can be None)
  • data direction: OUT

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)