Persist data to target Args: data (dict): data to save. keys are the self.persist keys and values is data

Load output from task with the workflow parameters Args: task (class): task class keys (list): list of data

Load all or several outputs from task Args: keys (list): list of data to load task (str): if requires multip

``True`` if all of this task's outputs exist.

The outputs of the tasks returned by :py:meth:`requires`.

The output Target(s) this task produces. Default: none.

Run tasks with the workflow parameters. Runs the DAG sequentially in dependency order. Args: tasks (class, list): task c

Get task with the workflow parameters Args: task(class) Retuns: An instance of task class with the workflow par

Preview task flows with the workflow parameters Args: tasks (class, list): task class or list of tasks class

Get task with the workflow parameters for a flow Args: flow (string): The name of the experiment for which the flow is t

Ouputs the Path given a task Args: task (class): task class Returns: list or dict of all task paths

Run tasks with the workflow parameters for a flow. Runs the DAG sequentially in dependency order. Args: flow (string): T

Return all ``(name, Parameter)`` pairs for this task, in declaration order.

The Task(s) this task depends on. Default: none.

Create a flat list of all items in a structured object (dicts, lists, items):: >>> sorted(flatten({'a': 'foo', 'b': 'bar'})) ['b

Reset a task, eg by deleting output file

Runs a function to load data from storage into memory Args: fun (function): loading function cached (bool):

Load all output from task with the workflow parameters Args: task (class): task class keys (list): list of d

Generate output files

Output target(s) this task produces

Load metadata from a single task

Create a new task instance from this one, overriding some args. Parameters common to this task and ``cls`` are carried over; ``kwarg

Check if a task is complete by checking if output exists, eg if output file exists

Convert path to cloud-compatible path if cloud storage is enabled

Load output from task with the workflow parameters for a flow Args: flow (string): The name of the experiment for which

Ouputs the Path given a task Args: task (class): task class flow (string): The name of the experiment for wh

The task computation, to be overridden in a subclass.

Runs a function to save data from memory into storage Args: df (obj): data to save fun (function): saving fu

Get all upstream inputs for a task Args: task (obj): task

Helper method to handle confirmation logic for reset operations Args: confirm (bool): whether to ask for confirm

The task family (class name) for this class.

Normalize a parsed/default/constructor value. Identity by default.

Convert the value ``x`` to a string. Opposite of :py:meth:`parse`.

:param default: the default value for this parameter. If not given, a value must be specified when the task is instan

Internal method to load metadata from input tasks

Remove a directory tree, tolerating Windows read-only/locked files. On Windows (esp. OneDrive-synced dirs) shutil.rmtree can raise Permission

Internal method to save metadata in specified format

Adds params to flow functions. More like declares the params for further use. Parameters ----------

Possibly dangerous! `delete(func)` will delete *all files* in the `data/func` directory of the given func. Useful if you want to delete all fu

Return parameter names. ``include_significant=True`` returns all params.

Resolve parameter values from positional args, kwargs and defaults. :param params: list of ``(param_name, Parameter)`` :para

Map all Tasks in a structured object to their ``.output()``.

Invalidate all tasks upstream tasks in a flow. For example, you have 3 dependant tasks. Normally you run Task3 but you've changed parameters

Loads all or several outputs from flow step. Args: func_to_run: flow step function keys (lis

Load all output from task with the workflow parameters for a flow Args: flow (string): The name of the experiment for wh

Preview task flows Args: tasks (obj, list): task or list of tasks

Preview task flows with the workflow parameters for a flow Args: flow (string): The name of the experiment for which the

Set default task for the workflow object Args: task(obj) The task to be set as a default task

Convert parameters to a ``{name: serialized_value}`` dict. :param bool only_significant: only include parameters marked significant.

Possibly dangerous! Will delete all files in the `data/` directory of the functions attached to the workflow object. Useful if you want to del

Yield tasks on every dependency path from ``start_task`` to ``goal_task_family``.

Initialize cloud storage Uses https://github.com/orgs/fsspec/repositories Args: protocol (str): fsspec eg gcs, s3, dropbox etc.

Whether a default value is available.

Invalidate all downstream tasks in a flow. For example, you have 3 dependant tasks. Normally you run Task3 but you've changed parameters for

Load all or several outputs from task Args: keys (list): list of data to load as_dict (bool): cache data in

Parse a ``bool`` from the string, matching 'true'/'false' case-insensitively.