Custom KPI Definition¶
CustomKPIDefinition
¶
Bases: KPIDefinition
Base class of KPI definitions with custom computation logic.
A subclass overrides one of two methods:
compute_batch(): all objects at once, for vectorized operations.compute_for_object(): one object per call, for logic that differs per object.
Examples:
A demand-weighted price per country. objects is a list of names
here: the index of the model flag, for the default
'auto_from_model_flag'. It is the string
'auto_from_batch_generation' only if the definition sets it.
>>> from mesqual.units import Units
>>> class DemandWeightedPrice(CustomKPIDefinition):
... def get_unit(self):
... return Units.EUR_per_MWh
...
... def required_flags(self):
... return {'Country.Results.price', 'Country.Results.demand_total'}
...
... def compute_batch(self, dataset, objects):
... price = dataset.fetch('Country.Results.price')[objects]
... demand = dataset.fetch('Country.Results.demand_total')[objects]
... return ((price * demand).sum() / demand.sum()).to_dict()
>>> definition = DemandWeightedPrice('Country.Results.demand_weighted_price', model_flag='Country.Model')
>>> study.scen.add_kpis_from_definitions_to_all_child_datasets([definition])
>>> {kpi.attributes.object_name: round(kpi.value, 2) for kpi in study.scen.get_dataset('base').kpi_collection}
{'C1': 42.7, 'C2': 46.83}
Source code in src/mesqual/kpis/definitions/custom.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | |
__init__
¶
__init__(kpi_flag: FlagTypeProtocol, model_flag: FlagTypeProtocol | None = None, objects: list[Hashable] | Literal['auto_from_model_flag', 'auto_from_batch_generation'] = 'auto_from_model_flag', name_prefix: str = '', name_suffix: str = '', extra_attributes: dict = None, aggregation: Aggregation | None = None)
Initialize custom KPI definition.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
kpi_flag
|
FlagTypeProtocol
|
Variable flag for the KPI (Can be a hypothetical/custom flag that doesn't exist in datasets), primarily used for naming and optionally for automatic model detection |
required |
model_flag
|
FlagTypeProtocol | None
|
Optional model flag (auto-inferred from kpi_flag if None) |
None
|
objects
|
list[Hashable] | Literal['auto_from_model_flag', 'auto_from_batch_generation']
|
List of objects or 'auto_from_model_flag' / 'auto_from_batch_generation' to discover |
'auto_from_model_flag'
|
name_prefix
|
str
|
Prefix for KPI names |
''
|
name_suffix
|
str
|
Suffix for KPI names |
''
|
aggregation
|
Aggregation | None
|
Optional aggregation (for metadata only, not used in computation) |
None
|
Source code in src/mesqual/kpis/definitions/custom.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 | |
generate_kpis
¶
Generate KPIs using either per-object or batch computation.
Uses compute_batch() if the subclass overrides it, else compute_for_object(). Errors raised inside these methods reach the caller.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset
|
Dataset
|
Dataset to compute KPIs for |
required |
Returns:
| Type | Description |
|---|---|
list[KPI]
|
List of computed KPI instances |
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
If the subclass overrides neither method. |
ValueError
|
If objects is 'auto_from_batch_generation' and compute_batch() is not overridden. |
Source code in src/mesqual/kpis/definitions/custom.py
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | |
compute_for_object
¶
compute_for_object(dataset: Dataset, object_name: Hashable) -> Any
Compute KPI value for a single object.
Override this for per-object computation pattern.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset
|
Dataset
|
Dataset to fetch data from |
required |
object_name
|
Hashable
|
Name of the object to compute for |
required |
Returns:
| Type | Description |
|---|---|
Any
|
Computed KPI value |
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
If not overridden |
Source code in src/mesqual/kpis/definitions/custom.py
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 | |
compute_batch
¶
compute_batch(dataset: Dataset, objects: list[Hashable] | Literal['auto_from_batch_generation']) -> dict[Hashable, Any]
Compute KPI values for all objects at once.
Override this for batch computation pattern.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset
|
Dataset
|
Dataset to fetch data from |
required |
objects
|
list[Hashable] | Literal['auto_from_batch_generation']
|
List of object names to compute for |
required |
Returns:
| Type | Description |
|---|---|
dict[Hashable, Any]
|
Dict mapping object_name → value |
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
If not overridden |
Source code in src/mesqual/kpis/definitions/custom.py
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | |
get_unit
abstractmethod
¶
get_unit() -> Unit
Return the unit for this KPI type.
Returns:
| Type | Description |
|---|---|
Unit
|
Physical unit for the KPI values |
Source code in src/mesqual/kpis/definitions/custom.py
210 211 212 213 214 215 216 217 218 | |