DerivedVariable¶
Capture a derived value in a statistical model under a given name.
This can be used to record certain derived information computed in the model as a variable that will later be available in some model outputs (e.g., model predictions). More Info... Version 1.0.0
Ports/Properties¶
value¶
Value of the parameter.
- verbose name: Value
- default value: None
- port type: DataPort
- value type: AnyNumeric (can be None)
- data direction: INOUT
varname¶
Name of the variable. The variable can be accessed under this name when analyzing derived distributions such as the predictive distribution.
- verbose name: Parameter Name
- default value: myvar
- port type: StringPort
- value type: str (can be None)
desc¶
Description for the variable. This can be used to annotate the purpose/meaning of the variable in the context of a statistical model. This is often a single sentence.
- verbose name: Description
- default value:
- port type: StringPort
- value type: str (can be None)
verbose_name¶
Optional verbose name for the variable. Can be used for augmented human-readable output.
- verbose name: Verbose Name
- default value: None
- port type: StringPort
- value type: str (can be None)
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)