Skip to main content

LinearSVC

Struct LinearSVC 

Source
#[non_exhaustive]
pub struct LinearSVC { /* private fields */ }
Expand description

Linear Support Vector Classifier.

Uses the Pegasos SGD algorithm to minimize hinge loss with L2 regularisation. Binary problems use a single weight vector; multiclass problems use one-vs-rest (one weight vector per class, prediction = argmax of decision function scores).

§Example

use scry_learn::dataset::Dataset;
use scry_learn::svm::LinearSVC;

let features = vec![
    vec![0.0, 0.0, 10.0, 10.0],
    vec![0.0, 0.0, 10.0, 10.0],
];
let target = vec![0.0, 0.0, 1.0, 1.0];
let data = Dataset::new(features, target, vec!["x".into(), "y".into()], "class");

let mut svc = LinearSVC::new().c(1.0).max_iter(500);
svc.fit(&data).unwrap();

let preds = svc.predict(&[vec![1.0, 1.0]]).unwrap();
assert_eq!(preds[0] as usize, 0);

Implementations§

Source§

impl LinearSVC

Source

pub fn new() -> Self

Create a new LinearSVC with default parameters.

Defaults: C = 1.0, max_iter = 1000, tol = 1e-4.

Source

pub fn c(self, c: f64) -> Self

Set the regularisation parameter C.

Larger values penalise misclassification more (tighter margin).

Source

pub fn max_iter(self, n: usize) -> Self

Set the maximum number of SGD epochs.

Source

pub fn tol(self, t: f64) -> Self

Set convergence tolerance on the max weight change per epoch.

Source

pub fn class_weight(self, cw: ClassWeight) -> Self

Set class weighting strategy for imbalanced datasets.

Source

pub fn probability(self, enable: bool) -> Self

Enable Platt scaling for probability estimates.

When true, predict_proba returns calibrated class probabilities after fitting.

Source

pub fn fit(&mut self, data: &Dataset) -> Result<()>

Train the SVM on the given dataset.

Uses Pegasos-style SGD with one-vs-rest decomposition for multiclass problems (≥ 3 classes). Auto-dispatches to sparse kernels when the dataset uses sparse storage.

Source

pub fn predict_sparse(&self, csr: &CsrMatrix) -> Result<Vec<f64>>

Predict class labels from sparse input (CSR format).

Source

pub fn predict(&self, features: &[Vec<f64>]) -> Result<Vec<f64>>

Predict class labels for the given row-major feature matrix.

Returns the class whose OVR decision function is largest.

Source

pub fn decision_function(&self, features: &[Vec<f64>]) -> Result<Vec<Vec<f64>>>

Compute the raw decision function score for each class.

Returns scores[sample][class] = w · x + b for each OVR sub-problem.

§Example
use scry_learn::dataset::Dataset;
use scry_learn::svm::LinearSVC;

let features = vec![
    vec![0.0, 0.0, 10.0, 10.0],
    vec![0.0, 0.0, 10.0, 10.0],
];
let target = vec![0.0, 0.0, 1.0, 1.0];
let data = Dataset::new(features, target, vec!["x".into(), "y".into()], "class");

let mut svc = LinearSVC::new();
svc.fit(&data).unwrap();

let scores = svc.decision_function(&[vec![1.0, 1.0]]).unwrap();
assert_eq!(scores[0].len(), 2); // two classes
Source

pub fn predict_proba(&self, features: &[Vec<f64>]) -> Result<Vec<Vec<f64>>>

Predict class probabilities using Platt scaling.

Requires .probability(true) to have been set before fitting. Returns probabilities[sample][class] normalised to sum to 1.

Trait Implementations§

Source§

impl CalibrableClassifier for LinearSVC

Source§

fn fit(&mut self, data: &Dataset) -> Result<()>

Train on a dataset.
Source§

fn predict(&self, features: &[Vec<f64>]) -> Result<Vec<f64>>

Predict class labels.
Source§

fn predict_proba(&self, features: &[Vec<f64>]) -> Result<Vec<Vec<f64>>>

Predict class probabilities. Returns [n_samples][n_classes].
Source§

fn clone_box(&self) -> Box<dyn CalibrableClassifier>

Clone into a boxed trait object.
Source§

impl Clone for LinearSVC

Source§

fn clone(&self) -> LinearSVC

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 Default for LinearSVC

Source§

fn default() -> Self

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

impl PipelineModel for LinearSVC

Source§

fn fit(&mut self, data: &Dataset) -> Result<()>

Train the model on a dataset.
Source§

fn predict(&self, features: &[Vec<f64>]) -> Result<Vec<f64>>

Predict on row-major feature matrix.
Source§

impl Tunable for LinearSVC

Source§

fn set_param(&mut self, name: &str, _value: ParamValue) -> Result<()>

Apply a named hyperparameter. Read more
Source§

fn clone_box(&self) -> Box<dyn Tunable>

Clone this model into a boxed trait object.
Source§

fn fit(&mut self, data: &Dataset) -> Result<()>

Train on a dataset.
Source§

fn predict(&self, features: &[Vec<f64>]) -> Result<Vec<f64>>

Predict on row-major features.

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