Skip to main content

CalibratedClassifierCV

Struct CalibratedClassifierCV 

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

A calibrated classifier wrapper.

Uses internal cross-validation to produce calibrated probability estimates from any classifier that supports predict_proba.

During fit, the data is split into n_folds folds. For each fold, the base classifier is trained on the training portion, predictions are made on the held-out portion, and those predictions are used to fit a calibration model (per class in the OVR scheme). At predict time, the full model’s raw probabilities are transformed through the calibrator.

§Example

use scry_learn::calibration::{CalibratedClassifierCV, CalibrationMethod};
use scry_learn::tree::DecisionTreeClassifier;
use scry_learn::dataset::Dataset;

let data = Dataset::from_csv("iris.csv", "species").unwrap();
let mut cal = CalibratedClassifierCV::new(
    DecisionTreeClassifier::new(),
    CalibrationMethod::Isotonic,
).n_folds(5);

cal.fit(&data).unwrap();
let probs = cal.predict_proba(&data.feature_matrix()).unwrap();

Implementations§

Source§

impl CalibratedClassifierCV

Source

pub fn new<C: CalibrableClassifier + 'static>( classifier: C, method: CalibrationMethod, ) -> Self

Create a new calibrated classifier wrapper.

Source

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

Set the number of cross-validation folds (default: 5).

Source

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

Fit the calibrated classifier.

  1. Splits data into n_folds stratified folds.
  2. For each fold, trains a clone of the base classifier on the training portion and collects predict_proba on held-out.
  3. Fits a per-class calibrators on the aggregated out-of-fold predictions.
  4. Re-trains the base classifier on the full dataset.
Source

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

Predict calibrated probabilities.

Returns [n_samples][n_classes] with calibrated probabilities that sum to 1 for each sample.

Source

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

Predict class labels (argmax of calibrated probabilities).

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