trinity.buffer.buffer_reader module

Contents

trinity.buffer.buffer_reader module#

Reader of the buffer.

class trinity.buffer.buffer_reader.BufferReader[source]#

Bases: ABC

Interface of the buffer reader.

abstract read(batch_size: int | None = None) → List[source]#: Read from buffer.

abstract async read_async(batch_size: int | None = None) → List[source]#: Read from buffer asynchronously.

state_dict() → Dict[source]#: Return the state of the reader as a dict. :returns: A dict containing the reader state. At minimum, it should contain

the current_index field.

load_state_dict(state_dict: Dict) → None[source]#