seismometer.configuration.model.Cohort

pydantic model seismometer.configuration.model.Cohort

The definition of an expected cohort attribute.

This structure defines a cohort attribute that should be available for selection in a notebook. For a categorical data, the splits should all be existing values and the list limits the selections available. For numerical data, the splits should be the inner boundaries of bucketing; with a high and low being added outside theses values.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "Cohort",
   "description": "The definition of an expected cohort attribute.\n\nThis structure defines a cohort attribute that should be available for selection in a notebook.\nFor a categorical data, the splits should all be existing values and the list limits the selections available.\nFor numerical data, the splits should be the inner boundaries of bucketing; with a high and low being added\noutside theses values.",
   "type": "object",
   "properties": {
      "source": {
         "title": "Source",
         "type": "string"
      },
      "display_name": {
         "default": "",
         "title": "Display Name",
         "type": "string"
      },
      "splits": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "title": "Splits"
      }
   },
   "required": [
      "source"
   ]
}

Fields:

• display_name (str)

• source (str)

• splits (list[Any] | None)

Validators:

• default_display_name » display_name

field display_name: str = ''

The display name for the cohort.

If not specified, defaults to the source name. Display names must be unique across the dataset and are what is referenced in usage configuration.

Validated by:

• default_display_name

field source: str [Required]

The source column name for a cohort.

field splits: list[Any] | None = []

An optional list of ‘inner edges’ used to create a set of cohorts from a continuous attribute.

validator default_display_name  »  display_name

Ensures that display_name exists, setting it to the source name if not provided.

Parameters:

• display_name (str)

• values (dict)

Return type:

str