trace
OpenMLRunTrace
¶
OpenML Run Trace: parsed output from Run Trace call
Parameters:
Name | Type | Description | Default |
---|---|---|---|
run_id
|
int
|
OpenML run id. |
required |
trace_iterations
|
dict
|
Mapping from key |
required |
Source code in openml/runs/trace.py
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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
|
__init__(run_id, trace_iterations)
¶
Object to hold the trace content of a run.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
run_id
|
int
|
Id for which the trace content is to be stored. |
required |
trace_iterations
|
List[List]
|
The trace content obtained by running a flow on a task. |
required |
Source code in openml/runs/trace.py
generate(attributes, content)
classmethod
¶
Generates an OpenMLRunTrace.
Generates the trace object from the attributes and content extracted while running the underlying flow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
attributes
|
list
|
List of tuples describing the arff attributes. |
required |
content
|
list
|
List of lists containing information about the individual tuning runs. |
required |
Returns:
Type | Description |
---|---|
OpenMLRunTrace
|
|
Source code in openml/runs/trace.py
get_selected_iteration(fold, repeat)
¶
Returns the trace iteration that was marked as selected. In case multiple are marked as selected (should not happen) the first of these is returned
Parameters:
Name | Type | Description | Default |
---|---|---|---|
fold
|
int
|
|
required |
repeat
|
int
|
|
required |
Returns:
Type | Description |
---|---|
int
|
The trace iteration from the given fold and repeat that was selected as the best iteration by the search procedure |
Source code in openml/runs/trace.py
merge_traces(traces)
classmethod
¶
Merge multiple traces into a single trace.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cls
|
type
|
Type of the trace object to be created. |
required |
traces
|
List[OpenMLRunTrace]
|
List of traces to merge. |
required |
Returns:
Type | Description |
---|---|
OpenMLRunTrace
|
A trace object representing the merged traces. |
Raises:
Type | Description |
---|---|
ValueError
|
If the parameters in the iterations of the traces being merged are not equal. If a key (repeat, fold, iteration) is encountered twice while merging the traces. |
Source code in openml/runs/trace.py
trace_from_arff(arff_obj)
classmethod
¶
Generate trace from arff trace.
Creates a trace file from arff object (for example, generated by a local run).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
arff_obj
|
dict
|
LIAC arff obj, dict containing attributes, relation, data. |
required |
Returns:
Type | Description |
---|---|
OpenMLRunTrace
|
|
Source code in openml/runs/trace.py
trace_from_xml(xml)
classmethod
¶
Generate trace from xml.
Creates a trace file from the xml description.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
xml
|
string | file-like object
|
An xml description that can be either a |
required |
Returns:
Name | Type | Description |
---|---|---|
run |
OpenMLRunTrace
|
Object containing the run id and a dict containing the trace iterations. |
Source code in openml/runs/trace.py
trace_to_arff()
¶
Generate the arff dictionary for uploading predictions to the server.
Uses the trace object to generate an arff dictionary representation.
Returns:
Name | Type | Description |
---|---|---|
arff_dict |
dict
|
Dictionary representation of the ARFF file that will be uploaded. Contains information about the optimization trace. |
Source code in openml/runs/trace.py
OpenMLTraceIteration
dataclass
¶
OpenML Trace Iteration: parsed output from Run Trace call
Exactly one of setup_string
or parameters
must be provided.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
repeat
|
int
|
repeat number (in case of no repeats: 0) |
required |
fold
|
int
|
fold number (in case of no folds: 0) |
required |
iteration
|
int
|
iteration number of optimization procedure |
required |
setup_string
|
str
|
json string representing the parameters
If not provided, |
None
|
evaluation
|
double
|
The evaluation that was awarded to this trace iteration. Measure is defined by the task |
required |
selected
|
bool
|
Whether this was the best of all iterations, and hence selected for making predictions. Per fold/repeat there should be only one iteration selected |
required |
parameters
|
OrderedDict
|
Dictionary specifying parameter names and their values.
If not provided, |
None
|
Source code in openml/runs/trace.py
get_parameters()
¶
Get the parameters of this trace iteration.