credmark.cmf.types.compose.MapBlocksOutput
- DTO class MapBlocksOutput(*, results=[])[source]
Bases:
IterableListGenericDTO[MapBlockResult]
,Generic
[DTOCLS
]A DTO for the output of
compose.map-*
block models which run another model over a series of blocks.The generic type specifies the class to use as the output in the
MapBlockResult
.For example
block_results = BlockSeries[MyOutputClass](**data)
whereblock_results.results[0].output
will be an instance ofMyOutputClass
If a permanent error occurs during a model run, the block with error will be added to the series array. If a non-permanent error occurs during a model run, the entire series will generate an error.
The output can be converted to list (to_list) or Panda’s DataFrame (to_dataframe()) with customized lambdas to extract certain field(s) of the output into values (in a list) or columns (in a dataframe).
Show JSON schema
{ "title": "MapBlocksOutput", "description": "A DTO for the output of ``compose.map-*`` block models which run another\nmodel over a series of blocks.\n\nThe generic type specifies the class to use as the output\nin the ``MapBlockResult``.\n\nFor example ``block_results = BlockSeries[MyOutputClass](**data)``\nwhere ``block_results.results[0].output`` will be an instance of ``MyOutputClass``\n\nIf a permanent error occurs during a model run, the block with error\nwill be added to the series array.\nIf a non-permanent error occurs during a model run, the entire series\nwill generate an error.\n\nThe output can be converted to list (to_list) or Panda's DataFrame (to_dataframe())\nwith customized lambdas to extract certain field(s) of the output into\nvalues (in a list) or columns (in a dataframe).", "type": "object", "properties": { "results": { "title": "Results", "description": "List of results of block model run outputs", "default": [], "type": "array", "items": { "$ref": "#/definitions/MapBlockResult" } } }, "definitions": { "ModelCallStackEntry": { "title": "ModelCallStackEntry", "description": "An item in an error's call stack.", "type": "object", "properties": { "slug": { "title": "Slug", "description": "Model slug", "type": "string" }, "version": { "title": "Version", "description": "Model version", "type": "string" }, "chainId": { "title": "Chainid", "description": "Context chain id", "type": "integer" }, "blockNumber": { "title": "Blocknumber", "description": "Context block number", "type": "integer" }, "input": { "title": "Input", "description": "Context input" }, "trace": { "title": "Trace", "description": "Trace of code that generated the error", "type": "string" } }, "required": [ "slug", "version" ] }, "ModelErrorDTO": { "title": "ModelErrorDTO", "description": "Data fields common to all error types:\nModelDataError, ModelRunError, ModelInputError etc.", "type": "object", "properties": { "type": { "title": "Type", "description": "Error type", "type": "string" }, "message": { "title": "Message", "description": "Error message", "type": "string" }, "stack": { "title": "Stack", "description": "Model call stack. Last element is the model that raised the error.", "default": [], "type": "array", "items": { "$ref": "#/definitions/ModelCallStackEntry" } }, "code": { "title": "Code", "description": "Short identifier for the type of error", "default": "generic", "type": "string" }, "detail": { "title": "Detail", "description": "Arbitrary data object related to the error." }, "permanent": { "title": "Permanent", "description": "If true, the error will always give the same result for the same context.", "default": false, "type": "boolean" } }, "required": [ "type", "message" ] }, "MapBlockResult": { "title": "MapBlockResult", "description": "A data row in a block series.\nThe generic type specifies the class to use as the output.\n\nFor example ``row = MapBlockResult[MyOutputClass](**data)``\nwhere ``row.output`` will be an instance of ``MyOutputClass``.", "type": "object", "properties": { "blockNumber": { "title": "Blocknumber", "description": "Block number of result.", "type": "integer" }, "output": { "title": "Output", "description": "Model output of result. Will not be present if there is an error." }, "error": { "title": "Error", "description": "Error DTO from model run. Will not be present if output exists.", "allOf": [ { "$ref": "#/definitions/ModelErrorDTO" } ] } }, "required": [ "blockNumber" ] } } }
- Fields
- Parameters
results (List[MapBlockResult]) –
- Return type
None
- field results: List[MapBlockResult] = []
List of results of block model run outputs
- append(obj)
- extend(obj)