pub struct ModelTree<State = Untrained> { /* private fields */ }Expand description
Model Tree for regression with linear models in leaves
Implementations§
Source§impl ModelTree<Untrained>
impl ModelTree<Untrained>
Sourcepub fn min_samples_split(self, min_samples_split: usize) -> Self
pub fn min_samples_split(self, min_samples_split: usize) -> Self
Set the minimum samples required to split
Sourcepub fn min_samples_leaf(self, min_samples_leaf: usize) -> Self
pub fn min_samples_leaf(self, min_samples_leaf: usize) -> Self
Set the minimum samples required at a leaf
Sourcepub fn min_std_dev_reduction(self, min_std_dev_reduction: Float) -> Self
pub fn min_std_dev_reduction(self, min_std_dev_reduction: Float) -> Self
Set the minimum standard deviation reduction
Sourcepub fn leaf_model(self, leaf_model: LeafModelType) -> Self
pub fn leaf_model(self, leaf_model: LeafModelType) -> Self
Set the leaf model type
Source§impl ModelTree<Trained>
impl ModelTree<Trained>
Sourcepub fn n_features(&self) -> usize
pub fn n_features(&self) -> usize
Get the number of features
Sourcepub fn feature_importances(&self) -> &Array1<Float>
pub fn feature_importances(&self) -> &Array1<Float>
Get feature importances
Sourcepub fn tree(&self) -> &ModelTreeNode
pub fn tree(&self) -> &ModelTreeNode
Get the tree structure (root node)
Trait Implementations§
Source§impl Estimator for ModelTree<Untrained>
impl Estimator for ModelTree<Untrained>
Source§type Config = ModelTreeConfig
type Config = ModelTreeConfig
Configuration type for the estimator
Source§type Error = SklearsError
type Error = SklearsError
Error type for the estimator
Source§fn validate_config(&self) -> Result<(), SklearsError>
fn validate_config(&self) -> Result<(), SklearsError>
Validate estimator configuration with detailed error context
Source§fn check_compatibility(
&self,
n_samples: usize,
n_features: usize,
) -> Result<(), SklearsError>
fn check_compatibility( &self, n_samples: usize, n_features: usize, ) -> Result<(), SklearsError>
Check if estimator is compatible with given data dimensions
Source§fn metadata(&self) -> EstimatorMetadata
fn metadata(&self) -> EstimatorMetadata
Get estimator metadata
Source§impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>> for ModelTree<Untrained>
impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>> for ModelTree<Untrained>
Source§fn fit(self, x: &Array2<Float>, y: &Array1<Float>) -> Result<Self::Fitted>
fn fit(self, x: &Array2<Float>, y: &Array1<Float>) -> Result<Self::Fitted>
Fit the model to the provided data with validation
Source§fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
Fit with custom validation and early stopping
Source§impl Predict<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>> for ModelTree<Trained>
impl Predict<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>> for ModelTree<Trained>
Source§fn predict(&self, x: &Array2<Float>) -> Result<Array1<Float>>
fn predict(&self, x: &Array2<Float>) -> Result<Array1<Float>>
Make predictions on the provided data
Source§fn predict_with_uncertainty(
&self,
x: &X,
) -> Result<(Output, UncertaintyMeasure), SklearsError>
fn predict_with_uncertainty( &self, x: &X, ) -> Result<(Output, UncertaintyMeasure), SklearsError>
Make predictions with confidence intervals
Auto Trait Implementations§
impl<State> Freeze for ModelTree<State>
impl<State> RefUnwindSafe for ModelTree<State>where
State: RefUnwindSafe,
impl<State> Send for ModelTree<State>where
State: Send,
impl<State> Sync for ModelTree<State>where
State: Sync,
impl<State> Unpin for ModelTree<State>where
State: Unpin,
impl<State> UnwindSafe for ModelTree<State>where
State: UnwindSafe,
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
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
Source§impl<T> StableApi for Twhere
T: Estimator,
impl<T> StableApi for Twhere
T: Estimator,
Source§const STABLE_SINCE: &'static str = "0.1.0"
const STABLE_SINCE: &'static str = "0.1.0"
API version this type was stabilized in
Source§const HAS_EXPERIMENTAL_FEATURES: bool = false
const HAS_EXPERIMENTAL_FEATURES: bool = false
Whether this API has any experimental features