describe#
- hybrid_aif.describe(system, params, *, arrays='auto', inline_max=256, extensions=None)[source]#
The document for
(system, params), plus its arrays file.arrays="auto"writes an array inline when it has at mostinline_maxelements and into the arrays file otherwise;"inline"and"file"force one placement. A constant array is written as the scalar it broadcasts from, except under"file". The document names the arrays file inarrays_filewhen any clamp refers to it.extensionsis the one place for a consumer’s own data, keyed by consumer name and carried untouched.Every variable, factor and term is written; what has no document form is refused by address: a lambda, a module outside the family menu, a scoring entry no term mounts, a recognition variable or external input named like a node (the document has one namespace; a node and a modality of one name the System itself refuses), and a nonlinear transition whose
f’s class is not registered (register_transition()): a registeredfis written as its name and its fields, since a document carries data and never code. Design: docs/design/model-description-0.3.md; the format: docs/description-format.md.