credmark.cmf.types.series.BlockSeriesRow

DTO class BlockSeriesRow(*, blockNumber, blockTimestamp, sampleTimestamp, output)[source]

Bases: GenericModel, Generic[DTOCLS]

A data row in a block series. The generic type specifies the class to use as the output.

For example row = BlockSeriesRow[MyOutputClass](**data) where row.output will be an instance of MyOutputClass

Show JSON schema
{
   "title": "BlockSeriesRow",
   "description": "A data row in a block series.\nThe generic type specifies the class to use as the output.\n\nFor example ``row = BlockSeriesRow[MyOutputClass](**data)``\nwhere ``row.output`` will be an instance of ``MyOutputClass``",
   "type": "object",
   "properties": {
      "blockNumber": {
         "title": "Blocknumber",
         "description": "Block number in the series",
         "type": "integer"
      },
      "blockTimestamp": {
         "title": "Blocktimestamp",
         "description": "The Timestamp of the Block",
         "type": "integer"
      },
      "sampleTimestamp": {
         "title": "Sampletimestamp",
         "description": "The Sample Block time",
         "type": "integer"
      },
      "output": {
         "title": "Output",
         "description": "Output of the model run for this block"
      }
   },
   "required": [
      "blockNumber",
      "blockTimestamp",
      "sampleTimestamp",
      "output"
   ]
}

Fields
Parameters

  • blockNumber (int) –

  • blockTimestamp (int) –

  • sampleTimestamp (int) –

  • output (DTOCLS) –

Return type

None

field blockNumber: int [Required]

Block number in the series

field blockTimestamp: int [Required]

The Timestamp of the Block

field output: DTOCLS [Required]

Output of the model run for this block

field sampleTimestamp: int [Required]

The Sample Block time