seismometer.configuration.model.PredictionDictionary

pydantic model seismometer.configuration.model.PredictionDictionary

The dictionary information for prediction data.

This is the structure of a dictionary corresponding to the prediction frame. Generally, the predictions frame is all the information known near model execution time such as inputs, outputs, and cohort attributes.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "PredictionDictionary",
   "description": "The dictionary information for prediction data.\n\nThis is the structure of a dictionary corresponding to the prediction frame.\nGenerally, the predictions frame is all the information known near model execution time such as inputs, outputs,\nand cohort attributes.",
   "type": "object",
   "properties": {
      "predictions": {
         "default": [],
         "items": {
            "$ref": "#/$defs/DictionaryItem"
         },
         "title": "Predictions",
         "type": "array"
      }
   },
   "$defs": {
      "DictionaryItem": {
         "description": "Defines a generic dictionary item.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "display_name": {
               "default": "",
               "title": "Display Name",
               "type": "string"
            },
            "dtype": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dtype"
            },
            "definition": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Definition"
            }
         },
         "required": [
            "name"
         ],
         "title": "DictionaryItem",
         "type": "object"
      }
   }
}

Fields:

• predictions (list[seismometer.configuration.model.DictionaryItem])

field predictions: list[DictionaryItem] = []

The list of all columns in the predictions data.

get(key, default=None)

Get the definition of an item.

Parameters:

• key (str) – The column name.

• default (Optional[Any]) – The default value to return if the key is not found, defaults to None.

Return type:

The DictionaryItem with name specified or the default value