Skip to main content

TrainingSession

Struct TrainingSession 

Source
pub struct TrainingSession<E: Environment, A> { /* private fields */ }
Expand description

A self-contained, loop-agnostic training coordinator.

TrainingSession wires together a LearningAgent, an optional TrainingRun, and a StatsTracker. It is driven purely by incoming data – it does not own a training loop. Feed it experiences and episode boundaries from wherever your loop lives: a plain for loop, Bevy’s ECS, or anything else.

§Usage

let session = TrainingSession::new(agent)
    .with_run(TrainingRun::create("cartpole", "v1")?)
    .with_max_steps(200_000)
    .with_checkpoint_freq(10_000);

// Each environment step:
session.observe(experience);

// Each episode end:
session.on_episode(total_reward, steps, status, env_extras);

if session.is_done() { break; }

Implementations§

Source§

impl<E, A> TrainingSession<E, A>
where E: Environment, E::Observation: Clone + Send + Sync + 'static, E::Action: Clone + Send + Sync + 'static, A: LearningAgent<E>,

Source

pub fn new(agent: A) -> Self

Create a session with no run attached.

Stats are tracked in memory but nothing is persisted. Attach a run with with_run to enable checkpointing and JSONL logging.

Source

pub fn with_run(self, run: TrainingRun) -> Self

Attach a TrainingRun for checkpointing and JSONL episode logging.

Source

pub fn with_max_steps(self, n: usize) -> Self

Maximum number of steps before is_done() returns true. Default: no limit.

Source

pub fn with_checkpoint_freq(self, freq: usize) -> Self

Checkpoint frequency in steps. Default: 10_000.

Source

pub fn with_keep_checkpoints(self, keep: usize) -> Self

Number of numbered checkpoints to retain on disk. Default: 3.

Source

pub fn with_stats(self, stats: StatsTracker) -> Self

Replace the default StatsTracker with a custom one.

Source

pub fn act(&mut self, obs: &E::Observation, mode: ActMode) -> E::Action

Select an action for obs according to mode.

Source

pub fn observe(&mut self, experience: Experience<E::Observation, E::Action>)

Record a transition. Checkpoints + prunes if a step milestone is hit.

Source

pub fn on_episode( &mut self, total_reward: f64, steps: usize, status: EpisodeStatus, env_extras: HashMap<String, f64>, )

Record an episode boundary.

Merges agent and environment extras into the record, updates stats, and appends to the training JSONL log (if a run is attached).

env_extras should come from [crate::traits::EpisodeStats::episode_extras] if the environment implements it, or an empty map otherwise.

Source

pub fn on_episode_start(&mut self)

Signal the start of a new episode (resets per-episode agent aggregators).

Source

pub fn total_steps(&self) -> usize

Total environment steps observed so far.

Source

pub fn steps_per_sec(&self) -> f64

Average environment steps per wall-clock second since the session was created.

Source

pub fn is_done(&self) -> bool

Returns true when total_steps >= max_steps.

Source

pub fn on_eval_episode(&self, record: &EpisodeRecord)

Log an eval episode to the run (if attached).

Source

pub fn maybe_save_best(&mut self, mean_reward: f64)

Save best.mpk if mean_reward exceeds the best seen so far.

Source

pub fn agent(&self) -> &A

Read-only access to the agent.

Source

pub fn agent_mut(&mut self) -> &mut A

Mutable access to the agent.

Source

pub fn stats_summary(&self) -> HashMap<String, f64>

Current stats summary.

Source

pub fn run(&self) -> Option<&TrainingRun>

Read-only access to the run (if attached).

Source

pub fn into_agent(self) -> A

Consume the session and return the inner agent.

Source

pub fn eval_report(&self, n_episodes: usize) -> EvalReport

Snapshot the current stats as an EvalReport.

Auto Trait Implementations§

§

impl<E, A> Freeze for TrainingSession<E, A>
where A: Freeze,

§

impl<E, A> !RefUnwindSafe for TrainingSession<E, A>

§

impl<E, A> Send for TrainingSession<E, A>
where A: Send, E: Send,

§

impl<E, A> Sync for TrainingSession<E, A>
where A: Sync, E: Sync,

§

impl<E, A> Unpin for TrainingSession<E, A>
where A: Unpin, E: Unpin,

§

impl<E, A> UnsafeUnpin for TrainingSession<E, A>
where A: UnsafeUnpin,

§

impl<E, A> !UnwindSafe for TrainingSession<E, A>

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> IntoComptime for T

Source§

fn comptime(self) -> Self

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