Skip to main content

GaussianProcessRegressor

Struct GaussianProcessRegressor 

Source
pub struct GaussianProcessRegressor<K: Kernel> { /* private fields */ }
Expand description

Gaussian Process Regressor with scikit-learn compatible API

§Examples

use scirs2_stats::gaussian_process::{GaussianProcessRegressor, SquaredExponential};
use scirs2_core::ndarray::{array, Array2};

let kernel = SquaredExponential::default();
let mut gpr = GaussianProcessRegressor::new(kernel);

let x_train = Array2::from_shape_vec((3, 1), vec![0.0, 1.0, 2.0]).expect("Operation failed");
let y_train = array![0.0, 1.0, 0.5];

gpr.fit(&x_train, &y_train).expect("Operation failed");

let x_test = Array2::from_shape_vec((1, 1), vec![1.5]).expect("Operation failed");
let predictions = gpr.predict(&x_test).expect("Operation failed");

Implementations§

Source§

impl<K: Kernel> GaussianProcessRegressor<K>

Source

pub fn new(kernel: K) -> Self

Create a new Gaussian Process Regressor

§Arguments
  • kernel - The covariance kernel
§Returns

A new GaussianProcessRegressor with default settings

Source

pub fn with_options(kernel: K, alpha: f64, normalize_y: bool) -> Self

Create a new GP Regressor with custom options

§Arguments
  • kernel - The covariance kernel
  • alpha - Noise level / regularization parameter
  • normalize_y - Whether to normalize target values
Source

pub fn fit(&mut self, x: &Array2<f64>, y: &Array1<f64>) -> StatsResult<()>

Fit the Gaussian Process model

§Arguments
  • x - Training features (n_samples, n_features)
  • y - Training targets (n_samples,)
§Returns

Result indicating success or failure

Source

pub fn predict(&self, x: &Array2<f64>) -> StatsResult<Array1<f64>>

Predict mean values

§Arguments
  • x - Test features (n_samples, n_features)
§Returns

Predicted mean values

Source

pub fn predict_with_std( &self, x: &Array2<f64>, ) -> StatsResult<(Array1<f64>, Array1<f64>)>

Predict with uncertainty estimates

§Arguments
  • x - Test features (n_samples, n_features)
  • return_std - Whether to return standard deviation
§Returns

(predictions, standard_deviations) if return_std is true

Source

pub fn kernel(&self) -> &K

Get the kernel

Source

pub fn kernel_mut(&mut self) -> &mut K

Get the kernel (mutable)

Source

pub fn log_marginal_likelihood(&self) -> StatsResult<f64>

Compute log marginal likelihood

Source

pub fn n_train_samples(&self) -> usize

Get number of training samples

Source

pub fn score(&self, x: &Array2<f64>, y: &Array1<f64>) -> StatsResult<f64>

Score the model using R² metric

§Arguments
  • x - Test features
  • y - True test targets
§Returns

R² score

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<T> Ungil for T
where T: Send,

Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more