Skip to main content

RecurrentPPOTrainer

Struct RecurrentPPOTrainer 

Source
pub struct RecurrentPPOTrainer<B, P, O>
where B: AutodiffBackend, P: AutodiffModule<B>, O: Optimizer<P, B>,
{ /* private fields */ }
Expand description

Recurrent PPO trainer (Burn backend).

Generic over the same three parameters as crate::train::ppo::trainer::PPOTrainerBurn:

  • B: AutodiffBackend — the Burn backend.
  • P: AutodiffModule<B> — the recurrent policy module (e.g. crate::policy::lstm::LstmBurnPolicy).
  • O: Optimizer<P, B> — the Burn optimizer.

The policy is held in Option<P> because Burn’s Optimizer::step consumes the module by value; we .take() / put-back across each gradient step.

Implementations§

Source§

impl<B, P, O> RecurrentPPOTrainer<B, P, O>
where B: AutodiffBackend, P: AutodiffModule<B> + Clone, O: Optimizer<P, B>,

Source

pub fn new( config: PPOConfig, policy: P, optimizer: BurnOptimizer<B, P, O>, device: B::Device, ) -> Result<Self>

Build a new recurrent PPO trainer.

device is the Burn device the sequence-batch tensors are materialized on (the buffer stores host Vec data, so — unlike the feedforward trainer, which reads the device off the observation tensor passed to train_step — the recurrent trainer must be told which device to build minibatches on).

Validates the config and stages the global gradient-norm cap (PPOConfig::max_grad_norm) on the optimizer wrapper; train_step applies it to the gradients of every minibatch step (issue #299).

Source

pub fn set_learning_rate(&mut self, lr: f64)

Override the learning rate used by subsequent train_step calls.

Enables caller-driven schedules (linear annealing, warmup, …). Pass the per-update rate before each train_step. Without a call, the optimizer’s configured rate is used.

Source

pub fn config(&self) -> &PPOConfig

Borrow the configuration.

Source

pub fn policy(&self) -> &P

Borrow the policy. Panics if called mid-step (the policy has been moved into the optimizer); only safe between train_step invocations.

Source

pub fn total_steps(&self) -> usize

Total completed gradient updates.

Source

pub fn total_episodes(&self) -> usize

Total completed episodes (caller increments).

Source

pub fn increment_episodes(&mut self, n: usize)

Increment the episode counter.

Source

pub fn train_step<F>( &mut self, buffer: &RecurrentRolloutBuffer, envs_per_minibatch: usize, evaluate_fn: F, ) -> Result<TrainingStats>
where F: FnMut(&P, Tensor<B, 3>, Tensor<B, 2, Int>, Tensor<B, 2>) -> (Tensor<B, 2>, Tensor<B, 2>, Tensor<B, 2>),

Train for one recurrent PPO update.

Iterates n_epochs passes over the buffer’s env-major minibatches (whole trajectories, envs_per_minibatch at a time), running the rank-3 evaluate_fn forward, flattening to rank-1, and applying the shared PPO surrogate / value / entropy losses. Mirrors crate::train::ppo::trainer::PPOTrainerBurn::train_step step-for-step except for the sequence-batch assembly and the rank-2 → rank-1 flatten.

  • buffer — the recurrent rollout buffer; advantages/returns must already be computed (via buffer.compute_advantages).
  • envs_per_minibatch — whole env-trajectories per minibatch (the recurrent analogue of the feedforward batch_size).
  • evaluate_fn — receives (&policy, obs_seq, actions, episode_starts) and returns (log_probs, entropy, values), each [N_env, T].

Auto Trait Implementations§

§

impl<B, P, O> Freeze for RecurrentPPOTrainer<B, P, O>
where <B as BackendTypes>::Device: Freeze, P: Freeze, O: Freeze,

§

impl<B, P, O> RefUnwindSafe for RecurrentPPOTrainer<B, P, O>

§

impl<B, P, O> Send for RecurrentPPOTrainer<B, P, O>

§

impl<B, P, O> Sync for RecurrentPPOTrainer<B, P, O>
where P: Sync, O: Sync,

§

impl<B, P, O> Unpin for RecurrentPPOTrainer<B, P, O>
where <B as BackendTypes>::Device: Unpin, P: Unpin, O: Unpin, B: Unpin,

§

impl<B, P, O> UnsafeUnpin for RecurrentPPOTrainer<B, P, O>

§

impl<B, P, O> UnwindSafe for RecurrentPPOTrainer<B, P, O>

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