Skip to main content

BcTrainer

Struct BcTrainer 

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

Burn-backend Behavioral Cloning trainer.

Generic over:

  • B: AutodiffBackend — the Burn backend (e.g. Autodiff<NdArray<f32>>).
  • P: AutodiffModule<B> — the policy module (only its logits head is trained; the value head is ignored).
  • 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; each minibatch .take()s it and puts back the updated copy.

Implementations§

Source§

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

Source

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

Build a new Burn behavioral-cloning trainer.

Validates the config and seeds the trainer’s minibatch-shuffle RNG from BcConfig::seed.

Source

pub fn config(&self) -> &BcConfig

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_epoch invocations.

Source

pub fn total_steps(&self) -> usize

Total completed gradient updates (one per minibatch across all epochs).

Source

pub fn total_epochs(&self) -> usize

Total completed epochs.

Source

pub fn train_epoch<F>( &mut self, demos: &Demonstrations, forward_fn: F, ) -> Result<BcEpochStats>
where F: FnMut(&P, Tensor<B, 2>) -> Tensor<B, 2>,

Train for one full supervised pass over the demonstration dataset.

  1. Draw a seeded shuffle of all example indices, partitioned into minibatches of BcConfig::batch_size (ceil(len / batch_size) minibatches).
  2. For each minibatch: gather (obs, actions), produce logits via forward_fn, compute the cross-entropy compute_bc_loss, backprop, and step the optimizer once.
  3. Aggregate the example-weighted mean loss and action-match accuracy over the epoch.

forward_fn lets the caller pick how logits are produced from the policy — e.g. |p, o| p.forward(o).0 to drop MlpBurnPolicy’s value head.

Returns finite loss and accuracy in [0, 1]. Returns an Err if the dataset is empty.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<B, P, O> UnwindSafe for BcTrainer<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