trinity.buffer.storage.queue module

trinity.buffer.storage.queue module#

Ray Queue storage

trinity.buffer.storage.queue.is_database_url(path: str) → bool[source]#
trinity.buffer.storage.queue.is_json_file(path: str) → bool[source]#
trinity.buffer.storage.queue.linear_decay_priority(item: List[Experience], decay: float = 0.1)[source]#
class trinity.buffer.storage.queue.QueueBuffer[source]#

Bases: ABC

abstract async put(exps: List[Experience]) → None[source]#

Put a list of experiences into the queue.

abstract async get() → List[Experience][source]#

Get a list of experience from the queue.

abstract qsize() → int[source]#

Get the current size of the queue.

abstract async close() → None[source]#

Close the queue.

abstract stopped() → bool[source]#

Check if there is no more data to read.

classmethod get_queue(storage_config: StorageConfig, config: BufferConfig) → QueueBuffer[source]#

Get a queue instance based on the storage configuration.

class trinity.buffer.storage.queue.AsyncQueue(capacity: int)[source]#

Bases: Queue, QueueBuffer

__init__(capacity: int)[source]#

Initialize the async queue with a specified capacity.

Parameters:

capacity (int) – The maximum number of items the queue can hold.

async close() → None[source]#

Close the queue.

stopped() → bool[source]#

Check if there is no more data to read.

class trinity.buffer.storage.queue.AsyncPriorityQueue(capacity: int, reuse_cooldown_time: float | None = None, priority_fn: str = 'linear_decay', **kwargs)[source]#

Bases: QueueBuffer

An asynchronous priority queue that manages a fixed-size buffer of experience items. Items are prioritized using a user-defined function and reinserted after a cooldown period.

capacity#

Maximum number of items the queue can hold. This value is automatically adjusted to be at most twice the read batch size.

Type:

int

priority_groups#

Maps priorities to deques of items with the same priority.

Type:

SortedDict

priority_fn#

Function used to determine the priority of an item.

Type:

callable

reuse_cooldown_time#

Delay before reusing an item (set to infinity to disable).

Type:

float

__init__(capacity: int, reuse_cooldown_time: float | None = None, priority_fn: str = 'linear_decay', **kwargs)[source]#

Initialize the async priority queue.

Parameters:

  • capacity (int) – The maximum number of items the queue can store.

  • reuse_cooldown_time (float) – Time to wait before reusing an item. Set to None to disable reuse.

  • priority_fn (str) – Name of the function to use for determining item priority.

  • kwargs – Additional keyword arguments for the priority function.

async put(item: List[Experience]) → None[source]#

Put a list of experiences into the queue.

async get() → List[Experience][source]#

Retrieve the highest-priority item from the queue.

Returns:

The highest-priority item (list of experiences).

Return type:

List[Experience]

Notes

  • After retrieval, the item is optionally reinserted after a cooldown period.

qsize()[source]#

Get the current size of the queue.

async close() → None[source]#

Close the queue.

stopped() → bool[source]#

Check if there is no more data to read.

class trinity.buffer.storage.queue.QueueStorage(storage_config: StorageConfig, config: BufferConfig)[source]#

Bases: object

An wrapper of a async queue.

__init__(storage_config: StorageConfig, config: BufferConfig) → None[source]#
async acquire() → int[source]#
async release() → int[source]#

Release the queue.

length() → int[source]#

The length of the queue.

async put_batch(exp_list: List) → None[source]#

Put batch of experience.

async get_batch(batch_size: int, timeout: float) → List[source]#

Get batch of experience.

classmethod get_wrapper(storage_config: StorageConfig, config: BufferConfig)[source]#

Get the queue actor.

Contents