state_management
logger = logging.getLogger(__name__) module-attribute ¶
AlgorithmStateEntry dataclass ¶
Entry for the algorithm status registry.
This dataclass stores the status of an algorithm for use by AlgorithmStateManager. It contains the algorithm name, unique identifier, current state, associated data segment, and an optional pointer to the algorithm object.
Attributes:
| Name | Type | Description |
|---|---|---|
name | str | Name of the algorithm. |
algorithm_uuid | UUID | Unique identifier for the algorithm. |
algorithm_ptr | Algorithm | Pointer to the algorithm object. |
state | AlgorithmStateEnum | State of the algorithm. |
data_segment | int | Data segment the algorithm is associated with. |
params | dict[str, Any] | Parameters for the algorithm. |
Source code in src/recnexteval/evaluators/core/state_management.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | |
AlgorithmStateManager ¶
Source code in src/recnexteval/evaluators/core/state_management.py
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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | |
values() ¶
Return an iterator over registered AlgorithmStateEntry objects.
Allows iteration over the registered entries.
Returns:
| Type | Description |
|---|---|
Iterator[AlgorithmStateEntry] | An iterator over the registered entries. |
Source code in src/recnexteval/evaluators/core/state_management.py
63 64 65 66 67 68 69 70 71 | |
get(algo_id) ¶
Get the :class:AlgorithmStateEntry for algo_id.
Source code in src/recnexteval/evaluators/core/state_management.py
109 110 111 | |
get_state(algo_id) ¶
Get the current state of the algorithm with algo_id.
Source code in src/recnexteval/evaluators/core/state_management.py
113 114 115 | |
register(algorithm_ptr, name=None, params={}, algo_uuid=None) ¶
Register new algorithm
Source code in src/recnexteval/evaluators/core/state_management.py
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 | |
can_request_training_data(algo_id) ¶
Check if algorithm can request training data
Source code in src/recnexteval/evaluators/core/state_management.py
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | |
can_request_unlabeled_data(algo_id) ¶
Check if algorithm can request unlabeled data
Source code in src/recnexteval/evaluators/core/state_management.py
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | |
can_submit_prediction(algo_id) ¶
Check if algorithm can submit prediction
Source code in src/recnexteval/evaluators/core/state_management.py
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | |
transition(algo_id, new_state, data_segment=None) ¶
Transition algorithm to new state with validation
Source code in src/recnexteval/evaluators/core/state_management.py
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 | |
is_all_predicted() ¶
Return whether every registered algorithm is in PREDICTED state.
Returns:
| Type | Description |
|---|---|
bool | True if all registered entries have state |
bool |
|
Source code in src/recnexteval/evaluators/core/state_management.py
233 234 235 236 237 238 239 240 241 242 | |
get_all_states() ¶
Get state of all algorithms
Source code in src/recnexteval/evaluators/core/state_management.py
244 245 246 | |
is_all_same_data_segment() ¶
Return whether all registered entries share the same data segment.
Returns:
| Type | Description |
|---|---|
bool | True if there is exactly one distinct data segment across all |
bool | registered entries, False otherwise. |
Source code in src/recnexteval/evaluators/core/state_management.py
248 249 250 251 252 253 254 255 256 257 258 | |
all_algo_states() ¶
Return a mapping of identifier strings to algorithm states.
The identifier used is "{name}_{uuid}" for each registered entry.
Returns:
| Type | Description |
|---|---|
dict[str, AlgorithmStateEnum] | Mapping from identifier string to the entry's |
dict[str, AlgorithmStateEnum] | class: |
Source code in src/recnexteval/evaluators/core/state_management.py
260 261 262 263 264 265 266 267 268 269 270 271 272 | |
set_all_ready(data_segment) ¶
Set all registered algorithms to the READY state.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_segment | int | Data segment to assign to every algorithm. | required |
Source code in src/recnexteval/evaluators/core/state_management.py
274 275 276 277 278 279 280 281 | |
get_algorithm_identifier(algo_id) ¶
Return a stable identifier string for the algorithm.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
algo_id | UUID | UUID of the algorithm. | required |
Returns:
| Type | Description |
|---|---|
str | Identifier in the format "{name}_{uuid}". |
Raises:
| Type | Description |
|---|---|
AttributeError | If |
Source code in src/recnexteval/evaluators/core/state_management.py
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | |