Skip to main content

PrioritizedBatch

Struct PrioritizedBatch 

Source
pub struct PrioritizedBatch {
    pub observations: Vec<f32>,
    pub actions: Vec<i64>,
    pub rewards: Vec<f32>,
    pub next_observations: Vec<f32>,
    pub dones: Vec<bool>,
    pub is_weights: Vec<f32>,
    pub indices: Vec<usize>,
    pub obs_dim: usize,
}
Expand description

One minibatch sampled from a PrioritizedReplayBuffer.

All fields are CPU-side primitive vectors; convert to Burn tensors via PrioritizedBatch::to_burn_tensors when handing them to the trainer.

Fields§

§observations: Vec<f32>

Flattened current observations, shape [batch_size * obs_dim].

§actions: Vec<i64>

Actions taken, length batch_size.

§rewards: Vec<f32>

Rewards received, length batch_size.

§next_observations: Vec<f32>

Flattened next observations, shape [batch_size * obs_dim].

§dones: Vec<bool>

Episode-end mask, length batch_size.

§is_weights: Vec<f32>

Per-sample importance-sampling weights, length batch_size, normalized so max(weights) == 1.0.

§indices: Vec<usize>

Sum-tree leaf indices for the sampled transitions, length batch_size. Pass these back into PrioritizedReplayBuffer::update_priorities alongside the new TD errors.

§obs_dim: usize

Length of one observation slice.

Implementations§

Source§

impl PrioritizedBatch

Source

pub fn len(&self) -> usize

Number of transitions in the batch.

Source

pub fn is_empty(&self) -> bool

true if the batch is empty.

Source

pub fn to_burn_tensors<B: Backend>( &self, device: &B::Device, ) -> PrioritizedBurnTensors<B>

Stack the batch into Burn tensors on device.

Returns a named PrioritizedBurnTensors struct so the DQN trainer can grab fields by name. Includes the importance-sampling weights that the uniform super::ReplayBatch does not carry.

Shapes (all on device):

  • observations: [batch, obs_dim], f32
  • actions: [batch], i64
  • rewards: [batch], f32
  • next_observations: [batch, obs_dim], f32
  • dones: [batch], f32 (0.0 / 1.0)
  • is_weights: [batch], f32

Note: indices is not a tensor — leaf-index round-trips back into PrioritizedReplayBuffer::update_priorities as a host &[usize], so it stays on self.

Trait Implementations§

Source§

impl Clone for PrioritizedBatch

Source§

fn clone(&self) -> PrioritizedBatch

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 PrioritizedBatch

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