fiftyone.core.utils.Batcher

class documentation

class Batcher(abc.ABC): (source)

Known subclasses: fiftyone.core.utils.BaseDynamicBatcher, fiftyone.core.utils.StaticBatcher

Constructor: Batcher(iterable, return_views, progress, total)

View In Hierarchy

Base class for iterating over the elements of an iterable in batches.

Method __enter__ Undocumented
Method __exit__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __next__ Undocumented
Method apply_backpressure Apply backpressure needed to rightsize the next batch.
Class Variable manual_backpressure Undocumented
Instance Variable iterable Undocumented
Instance Variable progress Undocumented
Instance Variable return_views Undocumented
Instance Variable total Undocumented
Method _compute_batch_size Return next batch size. Concrete classes must implement.
Instance Variable _in_context Undocumented
Instance Variable _iter Undocumented
Instance Variable _last_batch_size Undocumented
Instance Variable _last_offset Undocumented
Instance Variable _manually_applied_backpressure Undocumented
Instance Variable _num_samples Undocumented
Instance Variable _pb Undocumented
Instance Variable _render_progress Undocumented
def __enter__(self): (source)

Undocumented

def __exit__(self, *args): (source)

Undocumented

def __init__(self, iterable, return_views=False, progress=False, total=None): (source)
overridden in fiftyone.core.utils.BaseDynamicBatcher, fiftyone.core.utils.StaticBatcher

Undocumented

def __iter__(self): (source)

Undocumented

def __next__(self): (source)

Undocumented

def apply_backpressure(self, *args, **kwargs): (source)
overridden in fiftyone.core.utils.ContentSizeDynamicBatcher

Apply backpressure needed to rightsize the next batch.

Required to be implemented and called every iteration, if self.manual_backpressure == True.

Subclass defines arguments and behavior of this method.

manual_backpressure: bool = (source)
overridden in fiftyone.core.utils.ContentSizeDynamicBatcher

Undocumented

iterable = (source)

Undocumented

progress = (source)
overridden in fiftyone.core.utils.ContentSizeDynamicBatcher, fiftyone.core.utils.LatencyDynamicBatcher, fiftyone.core.utils.StaticBatcher

Undocumented

return_views = (source)
overridden in fiftyone.core.utils.ContentSizeDynamicBatcher, fiftyone.core.utils.LatencyDynamicBatcher, fiftyone.core.utils.StaticBatcher

Undocumented

total = (source)
overridden in fiftyone.core.utils.ContentSizeDynamicBatcher, fiftyone.core.utils.LatencyDynamicBatcher, fiftyone.core.utils.StaticBatcher

Undocumented

@abc.abstractmethod
def _compute_batch_size(self): (source)
overridden in fiftyone.core.utils.BaseDynamicBatcher, fiftyone.core.utils.StaticBatcher

Return next batch size. Concrete classes must implement.

_in_context: bool = (source)

Undocumented

_iter = (source)

Undocumented

_last_batch_size = (source)
overridden in fiftyone.core.utils.BaseDynamicBatcher

Undocumented

_last_offset: int = (source)

Undocumented

_manually_applied_backpressure: bool = (source)
overridden in fiftyone.core.utils.ContentSizeDynamicBatcher

Undocumented

_num_samples = (source)

Undocumented

_pb = (source)

Undocumented

_render_progress = (source)

Undocumented