Skip to main content

ReinforcementLearner

Struct ReinforcementLearner 

Source
pub struct ReinforcementLearner {
    pub algorithm: RlAlgorithm,
    pub q_table: HashMap<StateId, Vec<f64>>,
    pub q_table2: HashMap<StateId, Vec<f64>>,
    pub n_actions: usize,
    pub total_steps: u64,
    pub total_episodes: u64,
    pub episode_returns: VecDeque<f64>,
    pub rng_state: u64,
}
Expand description

Tabular reinforcement-learning agent supporting Q-learning, SARSA, and Double Q-learning.

Q-values are stored in a HashMap and initialised lazily to 0.0 on first access, so memory consumption grows only with the number of visited states.

Fields§

§algorithm: RlAlgorithm

The learning algorithm and its hyper-parameters.

§q_table: HashMap<StateId, Vec<f64>>

Primary Q-table: q_table[s][a] = Q(s, a).

§q_table2: HashMap<StateId, Vec<f64>>

Secondary Q-table used only by Double Q-learning.

§n_actions: usize

Number of discrete actions.

§total_steps: u64

Total environment steps executed via update.

§total_episodes: u64

Total episodes recorded via start_episode / end_episode.

§episode_returns: VecDeque<f64>

Sliding window of episode returns (capped at 1 000 entries).

§rng_state: u64

Current xorshift64 PRNG state (always non-zero).

Implementations§

Source§

impl ReinforcementLearner

Source

pub fn new(algorithm: RlAlgorithm, n_actions: usize, seed: u64) -> Self

Create a new learner with the given algorithm, action-space size, and random seed.

A seed of 0 is promoted to 1 to satisfy the xorshift64 requirement.

Source

pub fn select_action(&mut self, state: StateId, policy: &Policy) -> ActionId

Select an action for state according to policy.

Source

pub fn update(&mut self, experience: &Experience) -> f64

Apply one temporal-difference update from experience; return the TD error δ.

Also increments total_steps.

Source

pub fn batch_update(&mut self, experiences: &[Experience]) -> Vec<f64>

Apply TD updates for a slice of experiences in order; return the corresponding TD errors.

Source

pub fn best_action(&self, state: StateId) -> ActionId

Return the action with the highest Q-value in the primary table. Falls back to ActionId(0) when the state has never been visited.

Source

pub fn q_value(&self, state: StateId, action: ActionId) -> f64

Return Q(s, a) from the primary table; 0.0 if the pair is unseen.

Source

pub fn value(&self, state: StateId) -> f64

Return V(s) = max_a Q(s, a) from the primary table; 0.0 if unseen.

Source

pub fn explored_states(&self) -> usize

Number of distinct states whose Q-values have been initialised.

Source

pub fn start_episode(&mut self)

Signal the start of a new episode.

Pushes a placeholder return of 0.0 and increments total_episodes.

Source

pub fn end_episode(&mut self, total_return: f64)

Signal the end of the current episode, recording its total return.

Updates the last entry in episode_returns and caps the deque at 1 000 entries (oldest entries are dropped).

Source

pub fn avg_return(&self, last_n: usize) -> f64

Return the mean episode return over the last last_n episodes. Returns 0.0 if no episodes have been recorded.

Source

pub fn stats(&self) -> RlStats

Return a snapshot of the current learning statistics.

Trait Implementations§

Source§

impl Clone for ReinforcementLearner

Source§

fn clone(&self) -> ReinforcementLearner

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ReinforcementLearner

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> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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