Emission#
- class hybrid_aif.Emission[source]#
Bases:
NamedTupleThe declaration of an emission: an output of a System realised from its state factors.
Declared in
System.emissionsasname -> parents(a draw through the params’ kernel) orname -> Emission(parents, realise, kernel). Design: docs/design/nesting-and-coupling.md N5; docs/design/engine-consolidation.md.- parents: tuple[str, ...]#
The state factors and control nodes the emission is conditioned on, in the order of its kernel’s parent axes.
- realise: str#
How the emission is realised:
"sample"(a draw from the kernel),"mode"(its most probable level, or its mean) or"stats"(its probability vector, or its mean and covariance).
- kernel: Grid | None#
The emission’s static kernel:
None: the kernel isSystemParams.emission[name], a likelihood of any family, which must be there;"identity": the emission is its one state factor. A categorical state factor gives a level port (its level, or understatsits probability vector), and a continuous one a float port of the state factor’s width (its location undermode, a draw undersample;statsis not defined);a
Grid: an indicator likelihood over the cells of the grid of one continuous state factor, a level port with as many levels as the grid has cells: from a point the cell the point falls in, from a belief the belief’s mass in each cell (cell_mass()), of whichmodeis the largest cell,statsthe vector andsamplea draw;BLACK_BOX("black_box"): an out-port of a black box, with no parents; nothing in the library realises it, the black box’s step returns its value, and its type is its entry inSystem.black_box.
- static __new__(_cls, parents, realise='sample', kernel=None)#
Create new instance of Emission(parents, realise, kernel)