boilercv_pipeline

boilercv_pipeline#

Data pipeline.

Subpackages#

Submodules#

Package Contents#

Functions#

init

Initialize boilercv_pipeline.

run_example

Run an example file, logging the module name containing the function.

Data#

_debug

_preview

_write

_build_docs

DEBUG

Whether to run in debug mode. Log to boilercv.log.

PREVIEW

Whether to run interactive previews.

WRITE

Whether to write to the local media folder.

BUILD_DOCS

API#

boilercv_pipeline._debug#

‘get(…)’

boilercv_pipeline._preview#

‘get(…)’

boilercv_pipeline._write#

‘get(…)’

boilercv_pipeline._build_docs#

‘get(…)’

boilercv_pipeline.DEBUG#

None

Whether to run in debug mode. Log to boilercv.log.

boilercv_pipeline.PREVIEW#

None

Whether to run interactive previews.

boilercv_pipeline.WRITE#

None

Whether to write to the local media folder.

boilercv_pipeline.BUILD_DOCS#

None

boilercv_pipeline.init()#

Initialize boilercv_pipeline.

boilercv_pipeline.run_example(
func: collections.abc.Callable[..., Any],
preview: bool = False,
) → tuple[str, Any]#

Run an example file, logging the module name containing the function.

Args: func: The example function to run. preview: Preview results from the function. Default: False.