Booster

Enum Booster 

Source
pub enum Booster {
    Tree(SerializableTreeBooster),
    Linear(LinearBooster),
    LinearTree(LinearTreeBooster),
}
Expand description

Unified booster enum for gradient boosting

Provides type-safe dispatch between different learner types while maintaining serialization compatibility.

§Design

Uses enum dispatch instead of trait objects for:

  • Zero-cost abstraction (no vtable overhead)
  • rkyv serialization compatibility
  • Compile-time optimization opportunities

Variants§

§

Tree(SerializableTreeBooster)

Decision tree weak learner

Works on BinnedDataset. Best for:

  • Capturing non-linear relationships
  • Feature interactions
  • Most tabular data problems
§

Linear(LinearBooster)

Linear model with Ridge regularization

Works on raw features. Best for:

  • Capturing global trends
  • Extrapolation beyond training range
  • Time-series with drift
§

LinearTree(LinearTreeBooster)

Linear Tree: decision tree with linear models in leaves

Requires both BinnedDataset (for tree structure) and raw features (for linear models). Best for:

  • 10-100x fewer trees than standard GBDT
  • Capturing local linear relationships
  • Smoother predictions

Implementations§

Source§

impl Booster

Source

pub fn tree(config: TreeConfig) -> Self

Create a new tree booster

Source

pub fn linear(num_features: usize, config: LinearConfig) -> Self

Create a new linear booster

Source

pub fn linear_tree(config: LinearTreeConfig) -> Self

Create a new linear tree booster

Linear trees combine decision tree partitioning with linear models in leaves. This requires both binned data (for tree structure) and raw features (for linear models).

Source

pub fn fit_tree( &mut self, dataset: &BinnedDataset, gradients: &[f32], hessians: &[f32], row_indices: Option<&[usize]>, ) -> Result<()>

Fit tree booster on binned data

§Errors

Returns TreeBoostError::Config if called on a Linear or LinearTree booster.

Source

pub fn fit_linear( &mut self, features: &[f32], num_features: usize, gradients: &[f32], hessians: &[f32], ) -> Result<()>

Fit linear booster on raw features

§Errors

Returns TreeBoostError::Config if called on a Tree or LinearTree booster.

Source

pub fn fit_linear_tree( &mut self, dataset: &BinnedDataset, raw_features: &[f32], num_features: usize, gradients: &[f32], hessians: &[f32], ) -> Result<()>

Fit linear tree booster on binned data and raw features

Linear trees require both binned data (for tree structure) and raw features (for fitting linear models in each leaf).

§Arguments
  • dataset: Binned dataset for tree structure
  • raw_features: Raw feature values (row-major: [row0_f0, row0_f1, …, row1_f0, …])
  • num_features: Number of features
  • gradients: Negative gradient of loss
  • hessians: Second derivative of loss
§Errors

Returns TreeBoostError::Config if called on a Tree or Linear booster.

Source

pub fn predict_tree(&self, dataset: &BinnedDataset) -> Vec<f32>

Predict using tree booster on binned data

Returns zero vector if called on non-Tree booster.

Source

pub fn predict_tree_add(&self, dataset: &BinnedDataset, predictions: &mut [f32])

Add tree predictions to existing buffer

No-op if called on non-Tree booster or if tree not fitted.

Source

pub fn predict_linear(&self, features: &[f32], num_features: usize) -> Vec<f32>

Predict using linear booster on raw features

Returns zero vector if called on non-Linear booster.

Source

pub fn predict_linear_tree( &self, dataset: &BinnedDataset, raw_features: &[f32], num_features: usize, ) -> Vec<f32>

Predict using linear tree booster on binned data and raw features

Returns zero vector if called on non-LinearTree booster.

Source

pub fn predict_linear_tree_add( &self, dataset: &BinnedDataset, raw_features: &[f32], num_features: usize, predictions: &mut [f32], )

Add linear tree predictions to existing buffer

No-op if called on non-LinearTree booster.

Source

pub fn is_tree(&self) -> bool

Check if this is a tree booster

Source

pub fn is_linear(&self) -> bool

Check if this is a linear booster

Source

pub fn is_linear_tree(&self) -> bool

Check if this is a linear tree booster

Source

pub fn num_params(&self) -> usize

Get number of parameters

Source

pub fn is_fitted(&self) -> bool

Check if the booster is fitted

Source

pub fn as_tree(&self) -> Option<&Tree>

Get tree reference (if tree booster)

Source

pub fn as_linear(&self) -> Option<&LinearBooster>

Get linear booster reference (if linear booster)

Source

pub fn as_linear_tree(&self) -> Option<&LinearTreeBooster>

Get linear tree booster reference (if linear tree booster)

Source

pub fn reset(&mut self)

Reset the booster to initial state

Trait Implementations§

Source§

impl Archive for Booster

Source§

type Archived = ArchivedBooster

The archived representation of this type. Read more
Source§

type Resolver = BoosterResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.
Source§

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output. Read more
Source§

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize. Read more
Source§

impl Clone for Booster

Source§

fn clone(&self) -> Booster

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 Booster

Source§

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

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

impl<'de> Deserialize<'de> for Booster

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<__D: Fallible + ?Sized> Deserialize<Booster, __D> for Archived<Booster>

Source§

fn deserialize( &self, deserializer: &mut __D, ) -> Result<Booster, <__D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl From<LinearBooster> for Booster

Source§

fn from(booster: LinearBooster) -> Self

Converts to this type from the input type.
Source§

impl From<LinearTreeBooster> for Booster

Source§

fn from(booster: LinearTreeBooster) -> Self

Converts to this type from the input type.
Source§

impl From<TreeBooster> for Booster

Source§

fn from(booster: TreeBooster) -> Self

Converts to this type from the input type.
Source§

impl<__S: Fallible + ?Sized> Serialize<__S> for Booster

Source§

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.
Source§

impl Serialize for Booster

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> ArchiveUnsized for T
where T: Archive,

Source§

type Archived = <T as Archive>::Archived

The archived counterpart of this type. Unlike Archive, it may be unsized. Read more
Source§

fn archived_metadata( &self, ) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata

Creates the archived version of the metadata for this value.
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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Key for T
where T: Clone,

Source§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
Source§

fn size(&self) -> usize

The size of the key in bytes.
Source§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
Source§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
Source§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
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> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, S> SerializeUnsized<S> for T
where T: Serialize<S>, S: Fallible + Writer + ?Sized,

Source§

fn serialize_unsized( &self, serializer: &mut S, ) -> Result<usize, <S as Fallible>::Error>

Writes the object and returns the position of the archived type.
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

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> PlanCallbackArgs for T

Source§

impl<T> PlanCallbackOut for T