Skip to main content

A2cTrainer

Struct A2cTrainer 

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

Burn-backend A2C trainer.

Generic over:

  • B: AutodiffBackend — the Burn backend (e.g. Autodiff<NdArray<f32>>).
  • P: AutodiffModule<B> — the shared actor-critic policy module.
  • O: Optimizer<P, B> — the Burn optimizer (typically AdamConfig::new().init()).

The policy is held in Option<P> because Burn’s Optimizer::step consumes the module by value; we .take() it and put back the updated copy across the single gradient step.

Implementations§

Source§

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

Source

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

Build a new Burn A2C trainer.

Validates the config and stages the global gradient-norm clip (A2cConfig::max_grad_norm) on the optimizer wrapper.

Source

pub fn config(&self) -> &A2cConfig

Borrow the configuration.

Source

pub fn policy(&self) -> &P

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

Source

pub fn total_steps(&self) -> usize

Total completed gradient updates (one per train_step).

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, observations: Tensor<B, 2>, actions: Tensor<B, 1, Int>, advantages: Tensor<B, 1>, returns: Tensor<B, 1>, evaluate_fn: F, ) -> Result<A2cStats>
where F: FnMut(&P, Tensor<B, 2>, Tensor<B, 1, Int>) -> (Tensor<B, 1>, Tensor<B, 1>, Tensor<B, 1>),

Train for one A2C update.

Performs exactly one gradient step over the whole rollout:

  1. Optionally normalize advantages to zero-mean/unit-variance when A2cConfig::normalize_advantages is set.
  2. Evaluate the policy to get (log_probs, entropy, values).
  3. policy_loss = -mean(log_prob * advantage) (no ratio, no clip).
  4. value_loss = mean((V(s) - returns)^2) (plain MSE, no clip).
  5. entropy_loss = -mean(entropy).
  6. `total = policy_loss + value_coef * value_loss
    • entropy_coef * entropy_loss`.
  7. Backprop, build GradientsParams, step the optimizer once.
  8. Entropy-collapse guard (shared with PPO).

Note the absence of old_log_probs / old_values: A2C is on-policy with a single update, so there is no behaviour policy to form an importance ratio against, and no old value baseline to clip against.

The evaluate_fn closure receives (&policy, obs, actions) and must return (log_probs, entropy, values) — exactly the shape of MlpBurnPolicy::evaluate_actions.

Auto Trait Implementations§

§

impl<B, P, O> Freeze for A2cTrainer<B, P, O>
where P: Freeze, O: Freeze,

§

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

§

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

§

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

§

impl<B, P, O> Unpin for A2cTrainer<B, P, O>
where P: Unpin, O: Unpin, B: Unpin,

§

impl<B, P, O> UnsafeUnpin for A2cTrainer<B, P, O>
where P: UnsafeUnpin, O: UnsafeUnpin,

§

impl<B, P, O> UnwindSafe for A2cTrainer<B, P, O>
where P: UnwindSafe, O: UnwindSafe, B: UnwindSafe,

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