Struct linfa::composing::platt_scaling::PlattParams

pub struct PlattParams<F, O>(/* private fields */);

Implementations§

impl<F: Float, O> PlattParams<F, O>

pub fn maxiter(self, maxiter: usize) -> Self

Set the maximum number of iterations in the optimization process

The Newton’s method is an iterative optimization process, which uses the first and second order gradients to find optimal A and B. This function caps the maximal number of iterations.

pub fn minstep(self, minstep: F) -> Self

Set the minimum stepsize in the line search

After estimating the Hessian matrix, a line search is performed to find the optimal step size in each optimization step. In each attempt the stepsize is halfed until this threshold is reached. After reaching the threshold the algorithm fails because the desired precision could not be achieved.

pub fn sigma(self, sigma: F) -> Self

Set the Hessian’s sigma value

The Hessian matrix is regularized with H’ = H + sigma I to avoid numerical issues. This function set the amount of regularization.

Trait Implementations§

impl<F: Clone, O: Clone> Clone for PlattParams<F, O>

fn clone(&self) -> PlattParams<F, O>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<F: Debug, O: Debug> Debug for PlattParams<F, O>

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

Formats the value using the given formatter. Read more

impl<F: Float, O> Default for PlattParams<F, O>

fn default() -> Self

Returns the “default value” for a type. Read more

impl<F: Float, O> ParamGuard for PlattParams<F, O>

type Checked = PlattValidParams<F, O>

The checked hyperparameters

type Error = PlattError

Error type resulting from failed hyperparameter checking

fn check_ref(&self) -> Result<&Self::Checked, PlattError>

Checks the hyperparameters and returns a reference to the checked hyperparameters if successful

fn check(self) -> Result<Self::Checked, PlattError>

Checks the hyperparameters and returns the checked hyperparameters if successful

fn check_unwrap(self) -> Self::Checked
where Self: Sized,

Calls check() and unwraps the result

impl<F: PartialEq, O: PartialEq> PartialEq for PlattParams<F, O>

fn eq(&self, other: &PlattParams<F, O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: Eq, O: Eq> Eq for PlattParams<F, O>

impl<F, O> StructuralPartialEq for PlattParams<F, O>

Auto Trait Implementations§

impl<F, O> RefUnwindSafe for PlattParams<F, O>
where F: RefUnwindSafe, O: RefUnwindSafe,

impl<F, O> Send for PlattParams<F, O>
where F: Send, O: Send,

impl<F, O> Sync for PlattParams<F, O>
where F: Sync, O: Sync,

impl<F, O> Unpin for PlattParams<F, O>
where F: Unpin, O: Unpin,

impl<F, O> UnwindSafe for PlattParams<F, O>
where F: UnwindSafe, O: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

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

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

fn is_in_subset(&self) -> bool

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

unsafe fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V