Struct linfa_svm::hyperparams::SvmValidParams

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

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

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

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

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

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

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

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, Pr>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, Pr>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<f32, f32>

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

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

type Object = Svm<f64, f64>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, Pr>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, Pr>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<F, Pr>

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

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

type Object = Svm<F, bool>

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

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

type Object = Svm<f32, f32>

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

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

type Object = Svm<f64, f64>

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

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

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

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

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: Float, T> StructuralPartialEq for SvmValidParams<F, T>