GatherResourceUsageTask¶
- class lsst.analysis.tools.tasks.GatherResourceUsageTask(*, config: PipelineTaskConfig | None = None, log: logging.Logger | LsstLogAdapter | None = None, initInputs: dict[str, Any] | None = None, **kwargs: Any)¶
Bases:
PipelineTask
A
PipelineTask
that gathers resource usage statistics from task metadata.Notes
This is an unusual
PipelineTask
in that its input connection has dynamic dimensions.Its output table has columns for each of the dimensions of the input metadata’s data ID, as well as (subject to configuration):
memory
: the maximum resident set size for the entire quantum (in bytes);prep_time
: the time spent in the pre-initialization step in which the middleware checks which of the quantum’s inputs are available;init_time
: the time spent in task construction;run_time
: the time spent executing the task’s runQuantum method.{method}
: the time spent in a particular task or subtask method decorated withlsst.utils.timer.timeMethod
.
All time durations are CPU times in seconds, and all columns are 64-bit floating point. Methods or steps that did not run are given a duration of zero.
It is expected that this task will be configured to run multiple times in most pipelines, often once for each other task in the pipeline.
Attributes Summary
Methods Summary
Empty (clear) the metadata for this Task and all sub-Tasks.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
Get a dictionary of all tasks as a shallow copy.
makeField
(doc)Make a
lsst.pex.config.ConfigurableField
for this task.makeSubtask
(name, **keyArgs)Create a subtask as a new instance as the
name
attribute of this task.run
(universe, input_metadata)Gather resource usage statistics from per-quantum metadata.
runQuantum
(butlerQC, inputRefs, outputRefs)Do butler IO and transform to provide in memory objects for tasks
run
method.timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Attributes Documentation
Methods Documentation
- getFullMetadata() TaskMetadata ¶
Get metadata for all tasks.
- Returns:
- metadata
TaskMetadata
The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.
- metadata
Notes
The returned metadata includes timing information (if
@timer.timeMethod
is used) and any metadata set by the task. The name of each item consists of the full task name with.
replaced by:
, followed by.
and the name of the item, e.g.:topLevelTaskName:subtaskName:subsubtaskName.itemName
using
:
in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.
- getFullName() str ¶
Get the task name as a hierarchical name including parent task names.
- Returns:
- fullName
str
The full name consists of the name of the parent task and each subtask separated by periods. For example:
The full name of top-level task “top” is simply “top”.
The full name of subtask “sub” of top-level task “top” is “top.sub”.
The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.
- fullName
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
See also
getFullName
Get the full name of the task.
- getTaskDict() dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]] ¶
Get a dictionary of all tasks as a shallow copy.
- Returns:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- classmethod makeField(doc: str) ConfigurableField ¶
Make a
lsst.pex.config.ConfigurableField
for this task.- Parameters:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
Examples
Provides a convenient way to specify this task is a subtask of another task.
Here is an example of use:
class OtherTaskConfig(lsst.pex.config.Config): aSubtask = ATaskClass.makeField("brief description of task")
- makeSubtask(name: str, **keyArgs: Any) None ¶
Create a subtask as a new instance as the
name
attribute of this task.- Parameters:
- name
str
Brief name of the subtask.
- **keyArgs
Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:
config
.parentTask
.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.
- run(universe, input_metadata)¶
Gather resource usage statistics from per-quantum metadata.
- Parameters:
- universe
DimensionUniverse
Object managing all dimensions recognized by the butler; used to standardize and expand
GatherResourceUsageConfig.dimensions
.- input_metadata
list
[DeferredDatasetHandle
] List of
lsst.daf.butler.DeferredDatasetHandle
that can be used to load all input metadata datasets.
- universe
- Returns:
- result
Struct
Structure with a single element:
outout_table
: apandas.DataFrame
that aggregates the configured resource usage statistics.
- result
- runQuantum(butlerQC, inputRefs, outputRefs)¶
Do butler IO and transform to provide in memory objects for tasks
run
method.- Parameters:
- butlerQC
QuantumContext
A butler which is specialized to operate in the context of a
lsst.daf.butler.Quantum
.- inputRefs
InputQuantizedConnection
Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnections
class. The values of these attributes are thelsst.daf.butler.DatasetRef
objects associated with the defined input/prerequisite connections.- outputRefs
OutputQuantizedConnection
Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnections
class. The values of these attributes are thelsst.daf.butler.DatasetRef
objects associated with the defined output connections.
- butlerQC