Skip to main content

LinearSoftmaxPolicy

Struct LinearSoftmaxPolicy 

Source
pub struct LinearSoftmaxPolicy<T: Float + Debug + Send + Sync + 'static> { /* private fields */ }
Expand description

Categorical policy π(a|s) = softmax(W φ(s)) with an analytic score function.

Actions are one-hot rows of width n_actions. The score function is the textbook softmax result

∇_W log π(a|s) = (e_a − p(s)) φ(s)ᵀ ,  p(s) = softmax(W φ(s))

which is exactly rank one — so this policy is also an exact source of Kronecker factors for K-FAC (φ is the input factor, e_a − p the output factor).

Implementations§

Source§

impl<T: Float + Debug + Send + Sync + 'static> LinearSoftmaxPolicy<T>

Source

pub fn new(n_actions: usize, n_features: usize) -> Result<Self>

Create a zero-initialized policy (uniform over actions).

Source

pub fn from_weights(weights: Array2<T>) -> Result<Self>

Create a policy from an explicit weight matrix (n_actions, n_features).

Source

pub fn n_actions(&self) -> usize

Number of discrete actions.

Source

pub fn n_features(&self) -> usize

Observation/feature dimension.

Source

pub fn weights(&self) -> &Array2<T>

Current logit weights.

Source

pub fn logits(&self, observations: &Array2<T>) -> Result<Array2<T>>

Logits W φ(s) for a batch, shape (n, n_actions).

Source

pub fn probabilities(&self, observations: &Array2<T>) -> Result<Array2<T>>

Action probabilities for a batch, shape (n, n_actions).

Source

pub fn one_hot(&self, index: usize) -> Result<Array1<T>>

One-hot encode an action index.

Source

pub fn sample_actions_with( &self, observations: &Array2<T>, uniform: impl FnMut() -> f64, ) -> Result<(Array2<T>, Array1<T>, Vec<usize>)>

Sample one action per observation using a caller-supplied uniform source.

Returns the one-hot action matrix together with the log-probabilities of the sampled actions — exactly the two arrays a super::TrajectoryBatch needs. Taking the uniform source as a closure keeps rollouts fully reproducible in tests.

Trait Implementations§

Source§

impl<T: Clone + Float + Debug + Send + Sync + 'static> Clone for LinearSoftmaxPolicy<T>

Source§

fn clone(&self) -> LinearSoftmaxPolicy<T>

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<T: Debug + Float + Debug + Send + Sync + 'static> Debug for LinearSoftmaxPolicy<T>

Source§

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

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

impl<T: Float + Debug + Send + Sync + 'static> PolicyNetwork<T> for LinearSoftmaxPolicy<T>

Source§

fn evaluate_actions( &self, observations: &Array2<T>, actions: &Array2<T>, ) -> Result<PolicyEvaluation<T>>

Evaluate actions for given observations
Source§

fn get_action_distribution( &self, observations: &Array2<T>, ) -> Result<ActionDistribution<T>>

Get action distribution for given observations
Source§

fn update_parameters( &mut self, deltas: &HashMap<String, Array1<T>>, ) -> Result<()>

Add a parameter delta to the policy parameters (see the trait docs).
Source§

fn get_parameters(&self) -> HashMap<String, Array1<T>>

Get current policy parameters
Source§

fn log_prob_gradient( &self, observations: &Array2<T>, actions: &Array2<T>, coefficients: &Array1<T>, ) -> Result<HashMap<String, Array1<T>>>

Gradient of a coefficient-weighted sum of log-probabilities: ∂/∂θ Σᵢ cᵢ · log π(aᵢ | sᵢ). Read more
Source§

fn entropy_gradient( &self, observations: &Array2<T>, ) -> Result<HashMap<String, Array1<T>>>

Gradient of the batch-mean entropy ∂/∂θ (1/N) Σᵢ H[π(·|sᵢ)]. Read more
Source§

fn score_matrix( &self, observations: &Array2<T>, actions: &Array2<T>, ) -> Result<Array2<T>>

Per-sample score vectors g_i = ∇_θ log π(aᵢ|sᵢ), one per row, flattened with flatten_named’s canonical layout. Read more
Source§

fn kronecker_factors( &self, observations: &Array2<T>, actions: &Array2<T>, ) -> Result<Vec<KroneckerBlock<T>>>

Per-sample Kronecker factors of the Fisher information matrix. Read more
Source§

fn mean_action_gradient( &self, observations: &Array2<T>, weights: &Array2<T>, ) -> Result<HashMap<String, Array1<T>>>

Gradient of a weighted sum of the distribution mean: ∂/∂θ Σᵢ Σⱼ w[i,j] · μⱼ(sᵢ). 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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