Skip to main content

Ebm

Struct Ebm 

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

The settings of an explainable boosting machine (booster = ebm; see crate::ebm). Build with Ebm::builder; the defaults are one bag of every row, main effects only, no early stopping, and the classic cyclic EBM.

use std::num::NonZeroUsize;

use hessboost::config::{Ebm, EbmEarlyStopping};

let stopping = EbmEarlyStopping::new(
    NonZeroUsize::new(50).unwrap(),
    EbmEarlyStopping::DEFAULT_TOLERANCE,
)?;
let ebm = Ebm::builder()
    .interactions(2)
    .outer_bags(8)
    .bag_fraction(0.85)
    .early_stopping(stopping)
    .build()?;
assert_eq!((ebm.interactions(), ebm.outer_bags()), (2, 8));
assert_eq!(ebm.early_stopping(), Some(stopping));
// Early stopping scores each bag on the rows it does not train on.
assert!(Ebm::builder().early_stopping(stopping).build().is_err());

Implementations§

Source§

impl Ebm

Source

pub fn builder() -> EbmBuilder

Start a builder at the defaults.

Source

pub fn interactions(&self) -> usize

Number of pairwise interaction terms added after the main effects: the top pairs by FAST (Lou et al., KDD 2013) on the main-effect model’s gradients, each boosted like a main effect on its two features. At most n_features (n_features − 1) / 2 (checked at training). ebm_interactions.

Source

pub fn outer_bags(&self) -> usize

Outer bags (InterpretML’s outer_bags): each bag boosts its own copy of every term on its own row sample, and the model averages them. ebm_outer_bags.

Source

pub fn bag_fraction(&self) -> f64

Fraction of the rows each outer bag trains on, drawn without replacement per bag (InterpretML trains each bag on 1 − validation_size = 0.85). ebm_bag_fraction.

Source

pub fn boulevard(&self) -> bool

Boulevard-regularized EBM (Fang, Tan, Pipping & Hooker, AISTATS 2026, Algorithm 1): every round fits one tree per term to the same residuals, centers it, and averages it into its term with learning rate eta ∈ (0, 1], so the terms converge to a feature-wise kernel ridge regression with confidence bands (EbmInference). Squared error only, with Boulevard’s refusals, one bag of every row, and no early stopping. ebm_boulevard.

Source

pub fn early_stopping(&self) -> Option<EbmEarlyStopping>

Per-bag early stopping of a classic EBM (EbmEarlyStopping), None for none.

Trait Implementations§

Source§

impl Clone for Ebm

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Ebm

Source§

impl Debug for Ebm

Source§

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

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

impl Default for Ebm

Source§

fn default() -> Self

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

impl PartialEq for Ebm

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Ebm

Auto Trait Implementations§

§

impl Freeze for Ebm

§

impl RefUnwindSafe for Ebm

§

impl Send for Ebm

§

impl Sync for Ebm

§

impl Unpin for Ebm

§

impl UnsafeUnpin for Ebm

§

impl UnwindSafe for Ebm

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.