Scale Intelligence■ Docs
Docs / The model / ModelFamily

ModelFamily.

One family of quantitative model a market may be expressed in over the substrate: what it represents, the quantities it holds, what it reads from the record, what it gives, the solver that steps or solves it, and the check that proves it; a template names its family and a vertical chooses among them

Figure 1ModelFamilyspecified
MODELFAMILYrow at platform scopenametextwhattextrepresentationenum:stocks and flows|a graph of particip…the parts of the platform the model is written over and stepped onsubstratetextwhat one state of the model is, as rowsstate_formtextthe quantities the model holds, each a registered measure or a parameterquantities[text]what it reads from the record, by kindreads[text]what a run gives, by kindgives[text]how a state becomes the next, or how the model is solvedsolvertextthe check that proves a run right, with its planted faultchecktextthe vertical families it fits, by name; empty means every verticalfits_verticals[text]points at no other object
ModelFamily is a row at platform scope. The drawing shows its fields and the objects that they point at.
kind
row
scope
platform
key
its name
store
postgres
family
market

Fields#

fieldtyperequirednote
nametextyes
whattextyes
representationone of stocks and flows | a graph of participants and handovers | a hypergraph of co-presence | agents with behaviours | a game of roles | a learned latent model of the marketyes
substratetextyesthe parts of the platform the model is written over and stepped on
state_formtextyeswhat one state of the model is, as rows
quantities[text]yesthe quantities the model holds, each a registered measure or a parameter
reads[text]yeswhat it reads from the record, by kind
gives[text]yeswhat a run gives, by kind
solvertextyeshow a state becomes the next, or how the model is solved
checktextyesthe check that proves a run right, with its planted fault
fits_verticals[text]yesthe vertical families it fits, by name; empty means every vertical

Routes that use it#

No route takes or returns ModelFamily directly. The record holds it, and the objects that point at it reach it.