Skip to main content

A2cConfig

Struct A2cConfig 

Source
pub struct A2cConfig {
Show 13 fields pub learning_rate: f64, pub gamma: f64, pub gae_lambda: f64, pub value_coef: f64, pub entropy_coef: f64, pub n_steps: usize, pub num_envs: usize, pub max_grad_norm: f64, pub normalize_advantages: bool, pub use_vtrace: bool, pub vtrace_rho_bar: f32, pub vtrace_c_bar: f32, pub seed: u64,
}
Expand description

A2C configuration parameters.

These hyperparameters control the synchronous Advantage Actor-Critic training process. Default values target classic discrete-control tasks like CartPole: a single gradient update per n_steps-long rollout collected across num_envs synchronous actors, full n-step returns (gae_lambda = 1.0), and global gradient-norm clipping.

Fields§

§learning_rate: f64

Learning rate for the shared actor-critic optimizer.

§gamma: f64

Discount factor (gamma).

§gae_lambda: f64

GAE lambda parameter. The classic A2C default of 1.0 recovers full n-step returns (no GAE smoothing).

§value_coef: f64

Value function loss coefficient.

§entropy_coef: f64

Entropy bonus coefficient.

§n_steps: usize

Rollout length: number of environment steps collected per update (Mnih et al. 2016 use 5-step rollouts).

§num_envs: usize

Number of parallel synchronous actors.

§max_grad_norm: f64

Maximum global gradient norm for clipping.

§normalize_advantages: bool

Whether to normalize advantages to zero-mean/unit-variance per rollout before computing the policy loss.

§use_vtrace: bool

If true, replace GAE with V-trace (Espeholt et al. 2018) for off-policy correction. Requires that target-policy log-probs be supplied to the rollout preprocessing step. Defaults to false, leaving existing A2C behavior unchanged.

§vtrace_rho_bar: f32

V-trace rho clipping threshold (Espeholt 2018, eq. 1). Ignored when use_vtrace = false. Typical value: 1.0 (the IMPALA paper default).

§vtrace_c_bar: f32

V-trace c clipping threshold (Espeholt 2018, eq. 2). Ignored when use_vtrace = false. Typical value: 1.0.

§seed: u64

Seed threaded into seeded network init (e.g. MlpBurnConfig::with_seed) for reproducibility. Two trainers built with the same seed produce bit-identical initialization.

Implementations§

Source§

impl A2cConfig

Source

pub fn new() -> Self

Create a new default configuration.

Source

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

Validate configuration parameters.

Returns an Err describing the first invalid field encountered.

Source

pub fn learning_rate(self, lr: f64) -> Self

Set the learning rate.

Source

pub fn gamma(self, gamma: f64) -> Self

Set the discount factor gamma.

Source

pub fn gae_lambda(self, lambda: f64) -> Self

Set the GAE lambda parameter.

Source

pub fn value_coef(self, coef: f64) -> Self

Set the value function loss coefficient.

Source

pub fn entropy_coef(self, coef: f64) -> Self

Set the entropy bonus coefficient.

Source

pub fn n_steps(self, steps: usize) -> Self

Set the rollout length (steps collected per update).

Source

pub fn num_envs(self, envs: usize) -> Self

Set the number of parallel synchronous actors.

Source

pub fn max_grad_norm(self, norm: f64) -> Self

Set the maximum global gradient norm for clipping.

Source

pub fn normalize_advantages(self, enabled: bool) -> Self

Enable or disable per-rollout advantage normalization.

Source

pub fn use_vtrace(self, enabled: bool) -> Self

Enable or disable V-trace off-policy correction (replaces GAE).

Source

pub fn vtrace_rho_bar(self, rho_bar: f32) -> Self

Set the V-trace rho clipping threshold (Espeholt 2018, eq. 1).

Source

pub fn vtrace_c_bar(self, c_bar: f32) -> Self

Set the V-trace c clipping threshold (Espeholt 2018, eq. 2).

Source

pub fn seed(self, seed: u64) -> Self

Set the reproducibility seed.

Trait Implementations§

Source§

impl Clone for A2cConfig

Source§

fn clone(&self) -> A2cConfig

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 A2cConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for A2cConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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<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> 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