Skip to main content

RecurrentRolloutBatch

Struct RecurrentRolloutBatch 

Source
pub struct RecurrentRolloutBatch<B: Backend> {
    pub obs_seq: Tensor<B, 3>,
    pub actions: Tensor<B, 2, Int>,
    pub episode_starts: Tensor<B, 2>,
    pub old_log_probs: Tensor<B, 2>,
    pub old_values: Tensor<B, 2>,
    pub advantages: Tensor<B, 2>,
    pub returns: Tensor<B, 2>,
}
Expand description

A rank-3 batch of recurrent rollout data, ready to feed LstmBurnPolicy::evaluate_sequences with no shape adapters.

Every field is per-(env, step): obs_seq is rank-3 [N_env, T, obs_dim], the rest are rank-2 [N_env, T]. The recurrent PPO surrogate needs these per-step quantities, not a flattened rank-1 batch. initial_state is intentionally absent — the training forward always starts from a zeroed (h, c) and relies on episode_starts for in-sequence resets (design note Q2, Strategy A).

Fields§

§obs_seq: Tensor<B, 3>

Observations, [N_env, T, obs_dim] — feeds obs_seq.

§actions: Tensor<B, 2, Int>

Discrete actions, [N_env, T] — feeds actions.

§episode_starts: Tensor<B, 2>

Episode-start (state-reset) mask, [N_env, T]: 1.0 where obs[t] is the first step of a new episode, else 0.0. This is the done-flag stream shifted one step later — terminated[t-1] || truncated[t-1] for t >= 1, and the cross-iteration carry-in flag at t == 0. Feeds episode_starts, the hidden-state reset mask consumed by evaluate_sequences; it is distinct from (and one step ahead of) the terminated-only GAE flag.

§old_log_probs: Tensor<B, 2>

Behavior-policy log-probs [N_env, T] for the PPO ratio.

§old_values: Tensor<B, 2>

Behavior-policy value estimates V(s_t), [N_env, T].

§advantages: Tensor<B, 2>

GAE advantages [N_env, T] (terminated-only bootstrap, from GAE).

§returns: Tensor<B, 2>

Value-function targets [N_env, T] (advantages + values).

Implementations§

Source§

impl<B: Backend> RecurrentRolloutBatch<B>

Source

pub fn num_envs(&self) -> usize

Number of env-trajectories (N_env) in the batch.

Source

pub fn seq_len(&self) -> usize

Sequence length (T) of each trajectory.

Trait Implementations§

Source§

impl<B: Debug + Backend> Debug for RecurrentRolloutBatch<B>

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> 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, 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