Struct SvmValidParams

Source
pub struct SvmValidParams<F: Float, T> { /* private fields */ }
Expand description

SVM Hyperparameters

The SVM fitting process can be controlled in different ways. For classification the C and Nu parameters control the ratio of support vectors and accuracy, eps controls the required precision. After setting the desired parameters a model can be fitted by calling fit.

You can specify the expected return type with the turbofish syntax. If you want to enable Platt-Scaling for proper probability values, then use:

use linfa_svm::Svm;
use linfa::dataset::Pr;
let model = Svm::<f64, Pr>::params();

or bool if you only wants to know the binary decision:

use linfa_svm::Svm;
let model = Svm::<f64, bool>::params();

§Example

use linfa_svm::Svm;
let model = Svm::<_, bool>::params()
    .eps(0.1f64)
    .shrinking(true)
    .nu_weight(0.1)
    .fit(&dataset);

Implementations§

Source§

impl<F: Float, T> SvmValidParams<F, T>

Source

pub fn c(&self) -> Option<(F, F)>

Source

pub fn nu(&self) -> Option<(F, F)>

Source

pub fn solver_params(&self) -> &SolverParams<F>

Source

pub fn kernel_params(&self) -> &KernelParams<F>

Source

pub fn platt_params(&self) -> &PlattParams<F, ()>

Trait Implementations§

Source§

impl<F: Clone + Float, T: Clone> Clone for SvmValidParams<F, T>

Source§

fn clone(&self) -> SvmValidParams<F, T>

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

impl<F: Debug + Float, T: Debug> Debug for SvmValidParams<F, T>

Source§

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

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

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<()>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, Array1<()>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<()>, Dim<[usize; 2]>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, Array2<()>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<bool>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, Pr>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, Array1<bool>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<bool>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<F, bool>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, Array1<bool>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CountedTargets<(), ArrayBase<OwnedRepr<()>, Dim<[usize; 1]>>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, CountedTargets<(), Array1<()>>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CountedTargets<(), ArrayBase<OwnedRepr<()>, Dim<[usize; 2]>>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, CountedTargets<(), Array2<()>>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CountedTargets<(), ArrayBase<ViewRepr<&()>, Dim<[usize; 1]>>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, CountedTargets<(), ArrayView1<'_, ()>>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CountedTargets<(), ArrayBase<ViewRepr<&()>, Dim<[usize; 2]>>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, CountedTargets<(), ArrayView2<'_, ()>>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CountedTargets<bool, ArrayBase<OwnedRepr<bool>, Dim<[usize; 1]>>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, Pr>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, CountedTargets<bool, Array1<bool>>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CountedTargets<bool, ArrayBase<OwnedRepr<bool>, Dim<[usize; 1]>>>, SvmError> for SvmValidParams<F, bool>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<F>, CountedTargets<bool, Array1<bool>>>, ) -> Result<Self::Object>

Source§

impl Fit<ArrayBase<OwnedRepr<f32>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f32>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<f32, f32>

Source§

type Object = Svm<f32, f32>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<f32>, Array1<f32>>, ) -> Result<Self::Object>

Source§

impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<f64, f64>

Source§

type Object = Svm<f64, f64>

Source§

fn fit( &self, dataset: &DatasetBase<Array2<f64>, Array1<f64>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<ViewRepr<&F>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&()>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, F>, ArrayView1<'_, ()>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<ViewRepr<&F>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&()>, Dim<[usize; 2]>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, F>, ArrayView2<'_, ()>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<ViewRepr<&F>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&bool>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, Pr>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, F>, ArrayView1<'_, bool>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<ViewRepr<&F>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&bool>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<F, bool>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, F>, ArrayView1<'_, bool>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<ViewRepr<&F>, Dim<[usize; 2]>>, CountedTargets<bool, ArrayBase<OwnedRepr<bool>, Dim<[usize; 1]>>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, Pr>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, F>, CountedTargets<bool, Array1<bool>>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<ViewRepr<&F>, Dim<[usize; 2]>>, CountedTargets<bool, ArrayBase<OwnedRepr<bool>, Dim<[usize; 1]>>>, SvmError> for SvmValidParams<F, bool>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, F>, CountedTargets<bool, Array1<bool>>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<ViewRepr<&F>, Dim<[usize; 2]>>, CountedTargets<bool, ArrayBase<ViewRepr<&bool>, Dim<[usize; 1]>>>, SvmError> for SvmValidParams<F, Pr>

Source§

type Object = Svm<F, Pr>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, F>, CountedTargets<bool, ArrayView1<'_, bool>>>, ) -> Result<Self::Object>

Source§

impl<F: Float> Fit<ArrayBase<ViewRepr<&F>, Dim<[usize; 2]>>, CountedTargets<bool, ArrayBase<ViewRepr<&bool>, Dim<[usize; 1]>>>, SvmError> for SvmValidParams<F, bool>

Source§

type Object = Svm<F, bool>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, F>, CountedTargets<bool, ArrayView1<'_, bool>>>, ) -> Result<Self::Object>

Source§

impl Fit<ArrayBase<ViewRepr<&f32>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&f32>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<f32, f32>

Source§

type Object = Svm<f32, f32>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, f32>, ArrayView1<'_, f32>>, ) -> Result<Self::Object>

Source§

impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&f64>, Dim<[usize; 1]>>, SvmError> for SvmValidParams<f64, f64>

Source§

type Object = Svm<f64, f64>

Source§

fn fit( &self, dataset: &DatasetBase<ArrayView2<'_, f64>, ArrayView1<'_, f64>>, ) -> Result<Self::Object>

Source§

impl<F: PartialEq + Float, T: PartialEq> PartialEq for SvmValidParams<F, T>

Source§

fn eq(&self, other: &SvmValidParams<F, T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<F: Float, T> StructuralPartialEq for SvmValidParams<F, T>

Auto Trait Implementations§

§

impl<F, T> Freeze for SvmValidParams<F, T>
where F: Freeze,

§

impl<F, T> RefUnwindSafe for SvmValidParams<F, T>

§

impl<F, T> Send for SvmValidParams<F, T>
where T: Send,

§

impl<F, T> Sync for SvmValidParams<F, T>
where T: Sync,

§

impl<F, T> Unpin for SvmValidParams<F, T>
where T: Unpin,

§

impl<F, T> UnwindSafe for SvmValidParams<F, T>
where F: UnwindSafe, T: 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> 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> 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