burn-rl 0.21.0

RL crate for the Burn framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

/// The result of taking a step in an environment.
pub struct StepResult<S> {
    /// The updated state.
    pub next_state: S,
    /// The reward.
    pub reward: f64,
    /// If the environment reached a terminal state.
    pub done: bool,
    /// If the environment reached its max length.
    pub truncated: bool,
}

/// Trait to be implemented for a RL environment.
pub trait Environment {
    /// The type of the state.
    type State;
    /// The type of actions.
    type Action;

    /// The maximum number of step for one episode.
    const MAX_STEPS: usize;

    /// Returns the current state.
    fn state(&self) -> Self::State;
    /// Take a step in the environment given an action.
    fn step(&mut self, action: Self::Action) -> StepResult<Self::State>;
    /// Reset the environment to an initial state.
    fn reset(&mut self);
}

/// Trait to define how to initialize an environment.
/// By default, any function returning an environment implements it.
pub trait EnvironmentInit<E: Environment>: Clone {
    /// Initialize the environment.
    fn init(&self) -> E;
}

impl<F, E> EnvironmentInit<E> for F
where
    F: Fn() -> E + Clone,
    E: Environment,
{
    fn init(&self) -> E {
        (self)()
    }
}