Skip to main content

EpsilonGreedy

Struct EpsilonGreedy 

Source
pub struct EpsilonGreedy { /* private fields */ }
Available on crate feature bandit only.
Expand description

Epsilon-Greedy multi-armed bandit.

With probability epsilon, selects a random arm; otherwise selects the arm with the highest observed mean reward. Supports optional epsilon decay.

§Examples

use rill_ml::bandit::{Bandit, EpsilonGreedy, EpsilonGreedyConfig};
use rand::SeedableRng;
use rand_chacha::ChaCha8Rng;

let mut rng = ChaCha8Rng::seed_from_u64(0);
let mut bandit = EpsilonGreedy::new(3, EpsilonGreedyConfig::default()).unwrap();

let arm = bandit.select(&mut rng).unwrap();
bandit.update(arm, 1.0).unwrap();
assert_eq!(bandit.samples_seen(), 1);

Implementations§

Source§

impl EpsilonGreedy

Source

pub fn new( arm_count: usize, config: EpsilonGreedyConfig, ) -> Result<Self, RillError>

Create a new epsilon-greedy bandit.

§Errors

Returns RillError::InvalidArmCount if arm_count is zero. Returns RillError::InvalidEpsilon if epsilon is not in [0, 1]. Returns RillError::InvalidParameter if decay is not in (0, 1].

Source

pub const fn current_epsilon(&self) -> f64

The current (possibly decayed) epsilon value.

Source

pub fn pulls(&self) -> &[u64]

Per-arm pull counts (diagnostic).

Source

pub fn total_rewards(&self) -> &[f64]

Per-arm total rewards (diagnostic).

Source

pub fn validate(&self) -> Result<(), RillError>

Validate all persisted state invariants.

This is also run automatically during deserialization.

Trait Implementations§

Source§

impl Bandit for EpsilonGreedy

Source§

fn arm_count(&self) -> usize

The number of arms (actions) available.
Source§

fn samples_seen(&self) -> u64

How many total samples (arm pulls) the bandit has observed.
Source§

fn select(&self, rng: &mut impl Rng) -> Result<usize, RillError>

Select an arm using the provided RNG for exploration. Read more
Source§

fn update(&mut self, arm: usize, reward: f64) -> Result<(), RillError>

Update the bandit with the observed reward for a previously selected arm. Read more
Source§

fn reset(&mut self)

Reset the bandit to its initial (no-data) state.
Source§

fn arm_stats(&self, arm: usize) -> Result<ArmStats, RillError>

Per-arm diagnostic statistics. Read more
Source§

impl Clone for EpsilonGreedy

Source§

fn clone(&self) -> EpsilonGreedy

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 EpsilonGreedy

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