Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encord.com/llms.txt

Use this file to discover all available pages before exploring further.

​
BundlablePayload Objects

class BundlablePayload(Protocol[BundlablePayloadT])
All payloads that work with bundles need to provide “add” method that would allow bundler to combine multiple payloads into one or few aggregates.

​
Bundle Objects

class Bundle()
This class allows to perform operations in bundles to improve performance by reducing number of network calls. It is not supposed to be instantiated directly by a user. Use create_bundle() method to initiate bundled operations. To execute batch you can either call execute() directly, or use a Context Manager.

​
add

def add(operation: Callable[..., List[R]],
        result_mapper: Optional[BundleResultMapper[R]],
        payload: BundlablePayloadT, limit: int) -> None
This is an internal method and normally is not supposed to be used externally. Adds an operation to a bundle for delayed execution.

​
execute

def execute() -> None
Executes all scheduled operations in bundles and populates results