EntropyRegularization

Struct EntropyRegularization 

Source
pub struct EntropyRegularization<A: Float + FromPrimitive + Debug> {
    pub lambda: A,
    pub epsilon: A,
    pub reg_type: EntropyRegularizerType,
}
Expand description

Entropy regularization for probability distributions

This regularizer can either encourage high entropy (more uniform distributions) or low entropy (more peaked distributions) depending on the selected regularizer type.

It’s commonly used in reinforcement learning algorithms, semi-supervised learning, and some classification tasks where controlling the certainty of outputs is desired.

Fields§

§lambda: A

Regularization strength

§epsilon: A

Small value for numerical stability

§reg_type: EntropyRegularizerType

Type of entropy regularization

Implementations§

Source§

impl<A: Float + FromPrimitive + Debug + Send + Sync> EntropyRegularization<A>

Source

pub fn new(lambda: A, regtype: EntropyRegularizerType) -> Self

Create a new entropy regularization

§Arguments
  • lambda - Regularization strength coefficient
  • reg_type - Type of entropy regularization (maximize or minimize)
§Returns

An entropy regularization with default epsilon

Source

pub fn new_with_epsilon( lambda: A, epsilon: A, regtype: EntropyRegularizerType, ) -> Self

Create a new entropy regularization with custom epsilon

§Arguments
  • lambda - Regularization strength coefficient
  • epsilon - Small value for numerical stability
  • reg_type - Type of entropy regularization (maximize or minimize)
§Returns

An entropy regularization with custom epsilon

Source

pub fn calculate_entropy<S, D>(&self, probs: &ArrayBase<S, D>) -> A
where S: Data<Elem = A>, D: Dimension,

Calculate the entropy of a probability distribution

§Arguments
  • probs - Probability distribution (should sum to 1 along the appropriate axis)
§Returns

The entropy value

Trait Implementations§

Source§

impl<A: Clone + Float + FromPrimitive + Debug> Clone for EntropyRegularization<A>

Source§

fn clone(&self) -> EntropyRegularization<A>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<A: Debug + Float + FromPrimitive + Debug> Debug for EntropyRegularization<A>

Source§

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

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

impl<A, D> Regularizer<A, D> for EntropyRegularization<A>

Source§

fn apply(&self, params: &Array<A, D>, gradients: &mut Array<A, D>) -> Result<A>

Apply regularization to parameters and gradients Read more
Source§

fn penalty(&self, params: &Array<A, D>) -> Result<A>

Compute the regularization penalty value Read more
Source§

impl<A: Copy + Float + FromPrimitive + Debug> Copy for EntropyRegularization<A>

Auto Trait Implementations§

§

impl<A> Freeze for EntropyRegularization<A>
where A: Freeze,

§

impl<A> RefUnwindSafe for EntropyRegularization<A>
where A: RefUnwindSafe,

§

impl<A> Send for EntropyRegularization<A>
where A: Send,

§

impl<A> Sync for EntropyRegularization<A>
where A: Sync,

§

impl<A> Unpin for EntropyRegularization<A>
where A: Unpin,

§

impl<A> UnwindSafe for EntropyRegularization<A>
where A: UnwindSafe,

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