Skip to main content

ReplayBuffer

Struct ReplayBuffer 

Source
pub struct ReplayBuffer { /* private fields */ }
Expand description

Fixed-capacity FIFO replay buffer for off-policy training.

Stores (obs, action, reward, next_obs, done) transitions and supports uniform random sampling via sampling::sample. The buffer is allocated once at construction (vec![0.0; capacity * obs_dim] etc.); no further allocations occur during push.

Implementations§

Source§

impl ReplayBuffer

Source

pub fn new(capacity: usize, obs_dim: usize) -> Self

Create a new replay buffer with the given capacity and observation dimensionality.

§Arguments
  • capacity - Maximum number of transitions stored. Must be > 0.
  • obs_dim - Length of one observation vector. Must be > 0.
§Panics

Panics if capacity == 0 or obs_dim == 0.

Source

pub fn push( &mut self, obs: &[f32], action: i64, reward: f32, next_obs: &[f32], done: bool, )

Push a single transition into the buffer.

When the buffer is at capacity, this overwrites the oldest transition (FIFO eviction).

§Arguments
  • obs - Current observation; must have length obs_dim.
  • action - Discrete action taken.
  • reward - Reward received.
  • next_obs - Resulting observation; must have length obs_dim.
  • done - true if the episode terminated (used to mask the bootstrap term in the TD target).
§Panics

Panics in debug builds if obs.len() != obs_dim or next_obs.len() != obs_dim.

Source

pub fn len(&self) -> usize

Number of transitions currently in the buffer.

Source

pub fn is_empty(&self) -> bool

true if the buffer holds no transitions.

Source

pub fn capacity(&self) -> usize

Maximum number of transitions the buffer can hold.

Source

pub fn obs_dim(&self) -> usize

Observation dimension (length of one obs slice).

Source

pub fn is_ready(&self, min_size: usize) -> bool

true if the buffer holds at least min_size transitions.

Used by the trainer to decide whether to start sampling / performing gradient updates: vanilla DQN normally collects a few thousand transitions before the first update.

Trait Implementations§

Source§

impl Clone for ReplayBuffer

Source§

fn clone(&self) -> ReplayBuffer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ReplayBuffer

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more