Struct nuts_rs::SamplerArgs

source ·
pub struct SamplerArgs {
    pub num_tune: u64,
    pub maxdepth: u64,
    pub store_gradient: bool,
    pub max_energy_error: f64,
    pub step_size_adapt: DualAverageSettings,
    pub mass_matrix_adapt: GradDiagOptions,
}
Expand description

Settings for the NUTS sampler

Fields§

§num_tune: u64

The number of tuning steps, where we fit the step size and mass matrix.

§maxdepth: u64

The maximum tree depth during sampling. The number of leapfrog steps is smaller than 2 ^ maxdepth.

§store_gradient: bool

Store the gradient in the SampleStats

§max_energy_error: f64

If the energy error is larger than this threshold we treat the leapfrog step as a divergence.

§step_size_adapt: DualAverageSettings

Settings for step size adaptation.

§mass_matrix_adapt: GradDiagOptions

Settings for mass matrix adaptation.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.