Skip to main content

raygeo.pipeline.execute

Pipeline execution entry point.

Pipeline

cache_budget_bytes

cache_budget_bytes: int

Configured byte budget.

cache_used_bytes

cache_used_bytes: int

Current bytes in use by the cache.

clear_cache()

clear_cache() -> None

Clear the entire cache.

ParameterTypeDescription
ReturnsNone

clear_cache_prefix()

clear_cache_prefix(prefix: str) -> None

Clear all entries whose tag starts with prefix.

ParameterTypeDescription
prefixstr
ReturnsNone

execute()

execute(
nodes: Sequence[request.NodeRequest],
on_completed: Any,
on_batch_progress: Optional[Any],
) -> None

Run all nodes in a single rayon::scope.

ParameterTypeDescription
nodesSequence[request.NodeRequest]List of ~raygeo.pipeline.request.NodeRequest instances.
on_completedAnyCallable (node: CompletedNode) -> None fired for every node.
on_batch_progressOptional[Any]Optional callable (fraction: float, message: str) -> None.
ReturnsNone

set_cache_budget_bytes()

set_cache_budget_bytes(budget: int) -> None

Override the cache byte budget at runtime.

If the new budget is smaller than current usage, entries are evicted (oldest first) until usage fits within the new limit.

ParameterTypeDescription
budgetint
ReturnsNone

Functions

clear_cache()

clear_cache() -> None
ParameterTypeDescription
ReturnsNone

execute_stages()

execute_stages(
nodes: list[pipeline.request.NodeRequest],
on_completed: Callable[[pipeline.completed.CompletedNode], None],
on_batch_progress: Callable[[float, str], None] | None = None,
) -> None

Run all nodes in a single rayon::scope.

Fires on_completed for every node (success, failure, or cancellation) with a CompletedNode carrying the node's key, generation_id, and either output or error. on_batch_progress (optional) fires with the aggregate fraction and a status message on every per-node progress report and every completion.

ParameterTypeDescription
nodeslist[pipeline.request.NodeRequest]
on_completedCallable[[pipeline.completed.CompletedNode], None]
on_batch_progressCallable[[float, str], None] | None = None
ReturnsNone