Skip to main content

PPOConfig

Struct PPOConfig 

Source
pub struct PPOConfig {
    pub learning_rate: f64,
    pub n_epochs: usize,
    pub batch_size: usize,
    pub gamma: f64,
    pub gae_lambda: f64,
    pub clip_range: f64,
    pub clip_range_vf: f64,
    pub vf_coef: f64,
    pub ent_coef: f64,
    pub max_grad_norm: f64,
    pub target_kl: f64,
    pub seed: u64,
}
Expand description

PPO configuration parameters

These hyperparameters control the PPO training process. Default values are based on common settings that work well for simple environments like CartPole.

Fields§

§learning_rate: f64

Learning rate for policy and value function

§n_epochs: usize

Number of training epochs per rollout

§batch_size: usize

Minibatch size for training

§gamma: f64

Discount factor (gamma)

§gae_lambda: f64

GAE lambda parameter

§clip_range: f64

PPO clipping parameter (epsilon)

§clip_range_vf: f64

Value function clipping parameter

§vf_coef: f64

Value function loss coefficient

§ent_coef: f64

Entropy bonus coefficient

§max_grad_norm: f64

Maximum gradient norm for clipping.

Applied by both PPOTrainerBurn and RecurrentPPOTrainer as a global L2-norm clip (see clip_grads_by_global_norm) over the concatenation of every parameter’s gradient, immediately before each optimizer step (issue #299; prior to that fix the field was silently ignored by both trainers). Must be positive — validate rejects non-positive values — so to effectively disable clipping set a very large cap (e.g. 1e9).

§target_kl: f64

Target KL divergence for early stopping

§seed: u64

Seed for the inner-loop RNG used to shuffle minibatch indices.

Plumbed through the trainer so that two trainers built with the same seed produce bit-identical updates on the same rollout (issue #109). The PPO trainer constructs an internal StdRng::seed_from_u64(seed) at new() time and uses it for every minibatch shuffle.

Implementations§

Source§

impl PPOConfig

Source

pub fn new() -> Self

Create a new default configuration

Source

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

Validate configuration parameters

Source

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

Set learning rate

Source

pub fn n_epochs(self, epochs: usize) -> Self

Set number of training epochs

Source

pub fn batch_size(self, size: usize) -> Self

Set minibatch size

Source

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

Set discount factor

Source

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

Set GAE lambda

Source

pub fn clip_range(self, clip: f64) -> Self

Set PPO clipping parameter

Source

pub fn clip_range_vf(self, clip: f64) -> Self

Set value function clipping parameter

Source

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

Set value function loss coefficient

Source

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

Set entropy bonus coefficient

Source

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

Set maximum gradient norm

Source

pub fn target_kl(self, kl: f64) -> Self

Set target KL divergence

Source

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

Set the seed for the inner-loop RNG used for minibatch shuffling.

See PPOConfig::seed.

Trait Implementations§

Source§

impl Clone for PPOConfig

Source§

fn clone(&self) -> PPOConfig

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 PPOConfig

Source§

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

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

impl Default for PPOConfig

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