NUTSSampler

Struct NUTSSampler 

Source
pub struct NUTSSampler { /* private fields */ }
Expand description

No-U-Turn Sampler for Bayesian Mixture Models

NUTS is an adaptive variant of Hamiltonian Monte Carlo that automatically determines the number of leapfrog steps by continuing until the trajectory starts to “turn around” and move back towards its starting point. This makes it highly efficient for exploring complex posterior distributions without requiring manual tuning of the trajectory length.

§Parameters

  • n_components - Number of mixture components
  • n_samples - Number of MCMC samples to draw
  • n_warmup - Number of warmup samples for adaptation
  • step_size - Initial step size for leapfrog integration
  • target_accept_rate - Target acceptance rate for step size adaptation
  • max_tree_depth - Maximum tree depth to prevent infinite loops
  • adapt_step_size - Whether to adapt step size during warmup
  • adapt_mass_matrix - Whether to adapt the mass matrix during warmup
  • random_state - Random state for reproducibility

§Examples

use sklears_mixture::{NUTSSampler, CovarianceType};
use scirs2_core::ndarray::array;

let X = array![[0.0, 0.0], [1.0, 1.0], [2.0, 2.0], [10.0, 10.0], [11.0, 11.0], [12.0, 12.0]];

let nuts = NUTSSampler::new()
    .n_components(2)
    .n_samples(1000)
    .n_warmup(500)
    .target_accept_rate(0.8)
    .max_tree_depth(10);

let result = nuts.sample(&X.view()).unwrap();

Implementations§

Source§

impl NUTSSampler

Source

pub fn new() -> Self

Create a new NUTSSampler instance

Source

pub fn builder() -> Self

Create a new NUTSSampler instance using builder pattern (alias for new)

Source

pub fn n_components(self, n_components: usize) -> Self

Set the number of components

Source

pub fn n_samples(self, n_samples: usize) -> Self

Set the number of samples to draw

Source

pub fn n_warmup(self, n_warmup: usize) -> Self

Set the number of warmup samples

Source

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

Set the initial step size

Source

pub fn target_accept_rate(self, rate: f64) -> Self

Set the target acceptance rate

Source

pub fn max_tree_depth(self, depth: usize) -> Self

Set the maximum tree depth

Source

pub fn adapt_step_size(self, adapt: bool) -> Self

Set whether to adapt step size

Source

pub fn adapt_mass_matrix(self, adapt: bool) -> Self

Set whether to adapt mass matrix

Source

pub fn random_state(self, random_state: u64) -> Self

Set the random state

Source

pub fn build(self) -> Self

Build the NUTSSampler (builder pattern completion)

Source

pub fn sample(&self, X: &ArrayView2<'_, Float>) -> SklResult<NUTSResult>

Sample from the posterior distribution of a Gaussian mixture model

Trait Implementations§

Source§

impl Clone for NUTSSampler

Source§

fn clone(&self) -> NUTSSampler

Returns a duplicate 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 Debug for NUTSSampler

Source§

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

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

impl Default for NUTSSampler

Source§

fn default() -> Self

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

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

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

Source§

fn vzip(self) -> V