pub struct NoUTurnSampler {
pub initial_stepsize: f64,
pub max_tree_depth: usize,
pub target_acceptance: f64,
pub gamma: f64,
pub t0: f64,
pub kappa: f64,
pub seed: Option<u64>,
}Expand description
No-U-Turn Sampler (NUTS)
NUTS is an extension of HMC that automatically tunes the number of leapfrog steps by stopping when the trajectory starts to double back on itself.
Fields§
§initial_stepsize: f64Initial step size
max_tree_depth: usizeMaximum tree depth
target_acceptance: f64Target acceptance rate for step size adaptation
gamma: f64Step size adaptation parameter
t0: f64Step size adaptation parameter
kappa: f64Step size adaptation parameter
seed: Option<u64>Random seed
Implementations§
Source§impl NoUTurnSampler
impl NoUTurnSampler
Sourcepub fn with_stepsize(self, stepsize: f64) -> Self
pub fn with_stepsize(self, stepsize: f64) -> Self
Set initial step size
Sourcepub fn with_max_depth(self, depth: usize) -> Self
pub fn with_max_depth(self, depth: usize) -> Self
Set maximum tree depth
Sourcepub fn sample<D: LogDensity>(
&self,
target: &D,
n_samples_: usize,
initial_state: ArrayView1<'_, f64>,
) -> Result<NUTSResult>
pub fn sample<D: LogDensity>( &self, target: &D, n_samples_: usize, initial_state: ArrayView1<'_, f64>, ) -> Result<NUTSResult>
Sample using NUTS algorithm
Trait Implementations§
Source§impl Clone for NoUTurnSampler
impl Clone for NoUTurnSampler
Source§fn clone(&self) -> NoUTurnSampler
fn clone(&self) -> NoUTurnSampler
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for NoUTurnSampler
impl Debug for NoUTurnSampler
Auto Trait Implementations§
impl Freeze for NoUTurnSampler
impl RefUnwindSafe for NoUTurnSampler
impl Send for NoUTurnSampler
impl Sync for NoUTurnSampler
impl Unpin for NoUTurnSampler
impl UnsafeUnpin for NoUTurnSampler
impl UnwindSafe for NoUTurnSampler
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.