GatherResourceUsageConfig#

class lsst.analysis.tools.tasks.GatherResourceUsageConfig(*args, **kw)#

Bases: PipelineTaskConfig

Configuration definitions for GatherResourceUsageTask.

Attributes Summary

connections

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

dimensions

The quantum dimensions for the input metadata connection, and the columns (after expansion to include implied dimensions) used to identify rows in the output table.

init_time

Whether to extract the CPU time duration for actually constructing the task.

input_task_label

Label for the top-level task whose metadata is being processed within its own metadata file, if this differs from the prefix of connections.input_metadata.

memory

Whether to extract peak memory usage (maximum resident set size) for this task.

method_times

Names of @lsst.utils.timer.timeMethod-decorated methods for which CPU time durations should also be extracted.

prep_time

Whether to extract the CPU time duration for the work the middleware does prior to initializing the task (mostly checking for input dataset existence).

run_time

Whether to extract the CPU time duration for actually executing the task.

saveLogOutput

Flag to enable/disable saving of log output for a task, enabled by default.

wall_time

Whether to extract the wall_time duration for actually executing the task.

Attributes Documentation

connections: pexConfig.ConfigField#

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

dimensions#

The quantum dimensions for the input metadata connection, and the columns (after expansion to include implied dimensions) used to identify rows in the output table. (List)

init_time#

Whether to extract the CPU time duration for actually constructing the task. (bool, default True)

input_task_label#

Label for the top-level task whose metadata is being processed within its own metadata file, if this differs from the prefix of connections.input_metadata. (str, default None)

memory#

Whether to extract peak memory usage (maximum resident set size) for this task. Note that memory usage cannot be further subdivided because only a per-process peak is available (and hence if multiple quanta are run in one quantum, even per-quantum values may be misleading). (bool, default True)

method_times#

Names of @lsst.utils.timer.timeMethod-decorated methods for which CPU time durations should also be extracted. Use ‘.’ separators to refer to subtask methods at arbitrary depth. (List, default [])

prep_time#

Whether to extract the CPU time duration for the work the middleware does prior to initializing the task (mostly checking for input dataset existence). (bool, default False)

run_time#

Whether to extract the CPU time duration for actually executing the task. (bool, default True)

saveLogOutput#

Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

wall_time#

Whether to extract the wall_time duration for actually executing the task. (bool, default True)