kedro.framework.project.find_pipelines¶

kedro.framework.project.find_pipelines(raise_errors=False)[source]¶

Automatically find modular pipelines having a create_pipeline function. By default, projects created using Kedro 0.18.3 and higher call this function to autoregister pipelines upon creation/addition.

Projects that require more fine-grained control can still define the pipeline registry without calling this function. Alternatively, they can modify the mapping generated by the find_pipelines function.

For more information on the pipeline registry and autodiscovery, see https://docs.kedro.org/en/stable/nodes_and_pipelines/pipeline_registry.html

Parameters:: raise_errors (bool) – If True, raise an error upon failed discovery.
Return type:: dict[str, Pipeline]
Returns:: A generated mapping from pipeline names to Pipeline objects.
Raises:: ImportError – When a module does not expose a create_pipeline function, the create_pipeline function does not return a Pipeline object, or if the module import fails up front. If raise_errors is False, see Warns section instead.
Warns:: UserWarning – When a module does not expose a create_pipeline function, the create_pipeline function does not return a Pipeline object, or if the module import fails up front. If raise_errors is True, see Raises section instead.