GraphBuilder¶

class lsst.pipe.base.GraphBuilder(registry, skipExistingIn=None, clobberOutputs=True)¶

GraphBuilder class is responsible for building task execution graph from a Pipeline.

Parameters:

registry : Registry: Data butler instance.
skipExistingIn: Expressions representing the collections to search for existing output datasets that should be skipped. May be any of the types accepted by lsst.daf.butler.CollectionSearch.fromExpression.
clobberOutputs : bool, optional: If True (default), allow quanta to created even if partial outputs exist; this requires the same behavior behavior to be enabled when executing.

Methods Summary

makeGraph(pipeline, collections, run, …) Create execution graph for a pipeline.

Methods Documentation

makeGraph(pipeline, collections, run, userQuery, metadata: Optional[Mapping[str, Any]] = None)¶

Create execution graph for a pipeline.

Parameters:	pipeline : `Pipeline` Pipeline definition, task names/classes and their configs. collections Expressions representing the collections to search for input datasets. May be any of the types accepted by `lsst.daf.butler.CollectionSearch.fromExpression`. run : `str`, optional Name of the `RUN` collection for output datasets, if it already exists. userQuery : `str` String which defines user-defined selection for registry, should be empty or `None` if there is no restrictions on data selection. metadata : Optional Mapping of `str` to primitives This is an optional parameter of extra data to carry with the graph. Entries in this mapping should be able to be serialized in JSON.
Returns:	graph : `QuantumGraph`
Raises:	UserExpressionError Raised when user expression cannot be parsed. OutputExistsError Raised when output datasets already exist. Exception Other exceptions types may be raised by underlying registry classes.