task
Base classes for implementing analysis tasks.
Classes:
Name | Description |
---|---|
Task |
Abstract base class from which all analysis tasks are derived. |
ThirdPartyTask |
Class to run a third-party executable binary as a |
Task
Bases: ABC
Abstract base class for analysis tasks.
Attributes:
Name | Type | Description |
---|---|---|
name |
str
|
The name of the Task. |
Source code in lute/tasks/task.py
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 |
|
result: TaskResult
property
TaskResult: Read-only Task Result information.
__init__(*, params, use_mpi=False)
Initialize a Task.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params
|
TaskParameters
|
Parameters needed to properly configure the analysis task. These are NOT related to execution parameters (number of cores, etc), except, potentially, in case of binary executable sub-classes. |
required |
use_mpi
|
bool
|
Whether this Task requires the use of MPI. This determines the behaviour and timing of certain signals and ensures appropriate barriers are placed to not end processing until all ranks have finished. |
False
|
Source code in lute/tasks/task.py
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 |
|
_post_run()
Code to run AFTER the main analysis takes place.
This function may, or may not, be employed by subclasses.
Source code in lute/tasks/task.py
144 145 146 147 148 149 |
|
_pre_run()
Code to run BEFORE the main analysis takes place.
This function may, or may not, be employed by subclasses.
Source code in lute/tasks/task.py
137 138 139 140 141 142 |
|
_report_to_executor(msg)
Send a message to the Executor.
Details of Communicator
choice are hidden from the caller. This
method may be overriden by subclasses with specialized functionality.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
msg
|
Message
|
The message object to send. |
required |
Source code in lute/tasks/task.py
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
|
_run()
abstractmethod
Actual analysis to run. Overridden by subclasses.
Separating the calling API from the implementation allows run
to
have pre and post task functionality embedded easily into a single
function call.
Source code in lute/tasks/task.py
127 128 129 130 131 132 133 134 135 |
|
_signal_result()
Send the signal that results are ready along with the results.
Source code in lute/tasks/task.py
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
|
_signal_start()
Send the signal that the Task will begin shortly.
Source code in lute/tasks/task.py
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
clean_up_timeout()
Perform any necessary cleanup actions before exit if timing out.
Source code in lute/tasks/task.py
217 218 219 |
|
run()
Calls the analysis routines and any pre/post task functions.
This method is part of the public API and should not need to be modified in any subclasses.
Source code in lute/tasks/task.py
115 116 117 118 119 120 121 122 123 124 125 |
|
ThirdPartyTask
Bases: Task
A Task
interface to analysis with binary executables.
Source code in lute/tasks/task.py
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 |
|
__init__(*, params)
Initialize a Task.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params
|
TaskParameters
|
Parameters needed to properly configure
the analysis task. Note that it is NOT recommended to rely on this default behaviour as command-line arguments can be passed in many ways. Refer to the dcoumentation at https://slac-lcls.github.io/lute/tutorial/new_task/ under "Speciyfing a TaskParameters Model for your Task" for more information on how to control parameter parsing from within your TaskParameters model definition. |
required |
Source code in lute/tasks/task.py
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 |
|
_add_to_jinja_context(param_name, value)
Store a parameter as a Jinja template variable.
Variables are stored in a dictionary which is used to fill in a premade Jinja template for a third party configuration file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
param_name
|
str
|
Name to store the variable as. This should be the name defined in the corresponding pydantic model. This name MUST match the name used in the Jinja Template! |
required |
value
|
Any
|
The value to store. If possible, large chunks of the template should be represented as a single dictionary for simplicity; however, any type can be stored as needed. |
required |
Source code in lute/tasks/task.py
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
|
_formatted_command()
Returns the command as it would passed on the command-line.
Source code in lute/tasks/task.py
426 427 428 429 |
|
_pre_run()
Parse the parameters into an appropriate argument list.
Arguments are identified by a flag_type
attribute, defined in the
pydantic model, which indicates how to pass the parameter and its
argument on the command-line. This method parses flag:value pairs
into an appropriate list to be used to call the executable.
Note: ThirdPartyParameter objects are returned by custom model validators. Objects of this type are assumed to be used for a templated config file used by the third party executable for configuration. The parsing of these parameters is performed separately by a template file used as an input to Jinja. This method solely identifies the necessary objects and passes them all along. Refer to the template files and pydantic models for more information on how these parameters are defined and identified.
Source code in lute/tasks/task.py
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 |
|
_run()
Execute the new program by replacing the current process.
Source code in lute/tasks/task.py
416 417 418 419 420 421 422 423 424 |
|
_signal_start()
Override start signal method to switch communication methods.
Source code in lute/tasks/task.py
431 432 433 434 435 436 437 |
|
_template_to_config_file()
Convert a template file into a valid configuration file.
Uses Jinja to fill in a provided template file with variables supplied through the LUTE config file. This facilitates parameter modification for third party tasks which use a separate configuration, in addition to, or instead of, command-line arguments.
Source code in lute/tasks/task.py
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 |
|