Skip to main content

ReinforcementLearningAgent

Struct ReinforcementLearningAgent 

Source
pub struct ReinforcementLearningAgent { /* private fields */ }
Expand description

Production-quality tabular RL agent supporting multiple algorithms and policies.

Register states and their valid actions, then call update after each environment step to learn Q-values. Call run_episode to process a complete episode at once.

Implementations§

Source§

impl ReinforcementLearningAgent

Source

pub fn new(config: AgentConfig) -> Self

Create a new agent with the given configuration.

Returns RlAgentError::InvalidConfig if hyperparameters are out of range.

Source

pub fn register_state( &mut self, state: RlState, actions: Vec<RlAction>, ) -> Result<(), RlAgentError>

Register state as a valid environment state with actions as its legal action set. Can be called multiple times to add more actions; duplicate actions are ignored.

§Errors

Returns RlAgentError::InvalidConfig when actions is empty.

Source

pub fn select_action( &self, state: &RlState, rng_seed: &mut u64, ) -> Result<RlAction, RlAgentError>

Select an action for state according to the configured policy.

§Errors
Source

pub fn best_action(&self, state: &RlState) -> Result<RlAction, RlAgentError>

Return the greedy (argmax Q) action for state.

§Errors
Source

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

V(s) = max_a Q(s, a). Returns 0.0 if the state is unregistered.

Source

pub fn update(&mut self, transition: &Transition) -> Result<f64, RlAgentError>

Apply a single TD update from transition.

Returns the absolute TD error |δ| so callers can track convergence.

§Errors
Source

pub fn run_episode( &mut self, transitions: Vec<Transition>, _rng_seed: u64, ) -> Result<EpisodeStats, RlAgentError>

Process a complete sequence of transitions as one episode.

Epsilon is decayed once after all transitions are processed. Episode statistics are accumulated into AgentStats.

§Errors

Propagates any error from update.

Source

pub fn decay_epsilon(&mut self)

Decay epsilon for EpsilonGreedy policies: ε ← max(min_ε, ε × decay). No-op for other policies.

Source

pub fn add_experience(&mut self, t: Transition)

Push t into the experience replay buffer.

Source

pub fn sample_experience( &self, n: usize, rng_seed: u64, ) -> Result<Vec<Transition>, RlAgentError>

Draw n transitions uniformly at random from the replay buffer.

§Errors
Source

pub fn stats(&self) -> AgentStats

Return a snapshot of aggregate statistics.

Trait Implementations§

Source§

impl Debug for ReinforcementLearningAgent

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> 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, 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