accumulator
logger = logging.getLogger(__name__) module-attribute ¶
MetricAccumulator ¶
Source code in src/recnexteval/evaluators/core/accumulator.py
14 15 16 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 | |
acc = defaultdict(dict) instance-attribute ¶
user_level_metrics property ¶
window_level_metrics property ¶
add(metric, algorithm_name) ¶
Add a metric to the accumulator.
Takes a Metric object and adds it under the algorithm name. If the specified metric already exists for the algorithm, it will be overwritten with the new metric.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
metric | Metric | Metric to store. | required |
algorithm_name | str | Name of the algorithm. | required |
Source code in src/recnexteval/evaluators/core/accumulator.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | |
df_user_level_metric() ¶
Get user-level metrics across all timestamps.
Returns:
| Type | Description |
|---|---|
DataFrame | DataFrame with user-level metric computations. |
Source code in src/recnexteval/evaluators/core/accumulator.py
78 79 80 81 82 83 84 85 86 87 88 89 | |
df_window_level_metric() ¶
Source code in src/recnexteval/evaluators/core/accumulator.py
91 92 93 94 95 96 97 | |
df_macro_level_metric() ¶
Get macro-level metrics across all timestamps.
Returns:
| Type | Description |
|---|---|
DataFrame | DataFrame with macro-level metric computations. |
Source code in src/recnexteval/evaluators/core/accumulator.py
99 100 101 102 103 104 105 106 107 108 109 110 111 112 | |
df_micro_level_metric() ¶
Get micro-level metrics across all timestamps.
Returns:
| Type | Description |
|---|---|
DataFrame | DataFrame with micro-level metric computations. |
Source code in src/recnexteval/evaluators/core/accumulator.py
114 115 116 117 118 119 120 121 122 123 124 125 126 127 | |
df_metric(filter_timestamp=None, filter_algo=None, level=MetricLevelEnum.MACRO) ¶
Get DataFrame representation of metrics.
Returns a DataFrame representation of the metrics. The DataFrame can be filtered based on algorithm name and timestamp.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filter_timestamp | None | int | Timestamp value to filter on. Defaults to None. | None |
filter_algo | None | str | Algorithm name to filter on. Defaults to None. | None |
level | MetricLevelEnum | Level of the metric to compute. Defaults to MetricLevelEnum.MACRO. | MACRO |
Returns:
| Type | Description |
|---|---|
DataFrame | DataFrame representation of the metrics. |
Source code in src/recnexteval/evaluators/core/accumulator.py
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 | |