API Reference#

Classes#

Pipeline([providers, params])

A container for providers that can be assembled into a task graph.

Scope(x)

Helper for defining a generic type alias.

ScopeTwoParams(x)

Helper for defining a generic type alias.

scheduler.Scheduler(*args, **kwargs)

Scheduler interface compatible with sciline.Pipeline.

scheduler.DaskScheduler([scheduler])

Wrapper for a Dask scheduler.

scheduler.NaiveScheduler()

A naive scheduler that computes intermediate results and results in order.

TaskGraph(*, graph, targets[, scheduler])

Holds a concrete task graph and keys to compute.

HandleAsBuildTimeException(*args, **kwargs)

Error handler used by default.

HandleAsComputeTimeException(*args, **kwargs)

Error handler used for Pipeline.visualize().

Top-level functions#

compute_mapped(pipeline, base_name, *[, ...])

Given a graph with a mapped node with given base_name, return a series of computed results.

get_mapped_node_names(graph, base_name, *[, ...])

Given a graph with a mapped node with given base_name, return a series of corresponding mapped names.

Exceptions#

UnboundTypeVar

Raised when a parameter of a generic provider is not bound to a concrete type.

UnsatisfiedRequirement

Raised when a type cannot be provided.

Submodules#

serialize

Serialization of task graphs.

sphinxext

Sphinx extensions for projects using Sciline.