vertebrae.execution.local

Local execution backend.

Classes

LocalJobHandle	Immediate local job handle.
LocalBackend	Local execution backend.

Module Contents

class vertebrae.execution.local.LocalJobHandle

Immediate local job handle.

result

Completed job result.

state

Job state.

class vertebrae.execution.local.LocalBackend(n_jobs=1, joblib_backend='loky')

Local execution backend.

Parameters:

• n_jobs (int) – Number of local jobs. Values other than one use joblib.

• joblib_backend (str) – Optional joblib backend such as “loky” or “threading”.

submit(fn, job)

Execute a single local job immediately.

Parameters:

• fn (Callable[[Any], Any]) – Callable to execute.

• job (Any) – Job input.

Returns:

Completed local job handle.

Return type:

LocalJobHandle

gather(handles)

Collect local job results.

Parameters:

handles (Iterable[LocalJobHandle]) – Local job handles.

Returns:

Results in handle order.

Return type:

List[Any]

status(handle)

Return local job status.

Parameters:

handle (LocalJobHandle) – Local job handle.

Returns:

Job status string.

Return type:

str

map(fn, jobs)

Map a callable over jobs locally.

Parameters:

• fn (Callable[[Any], Any]) – Callable to execute.

• jobs (Iterable[Any]) – Iterable of job inputs.

Returns:

Results in job order.

Return type:

List[Any]