DecisionTree

Struct DecisionTree 

Source
pub struct DecisionTree<State = Untrained> { /* private fields */ }
Expand description

Main Decision Tree structure that can be used for both classification and regression

Implementations§

Source§

impl<State> DecisionTree<State>

Source

pub fn new() -> Self

Create a new DecisionTree with default configuration

Source

pub fn with_config(config: DecisionTreeConfig) -> Self

Create a new DecisionTree with custom configuration

Source

pub fn builder() -> DecisionTreeBuilder<State>

Create a builder for configuring the decision tree

Source

pub fn config(&self) -> &DecisionTreeConfig

Get the configuration of the decision tree

Source

pub fn root(&self) -> Option<&TreeNode>

Get the root node of the tree (if fitted)

Source

pub fn feature_importances(&self) -> Option<&Array1<f64>>

Get feature importances (if available)

Source

pub fn n_features(&self) -> usize

Get the number of features the tree was trained on

Source

pub fn n_samples(&self) -> usize

Get the number of training samples

Source

pub fn depth(&self) -> usize

Get the depth of the tree (returns root node depth if available)

Source

pub fn criterion(self, criterion: SplitCriterion) -> Self

Set the split criterion (fluent API)

Source

pub fn max_depth(self, max_depth: usize) -> Self

Set the maximum depth of the tree (fluent API)

Source

pub fn min_samples_split(self, min_samples_split: usize) -> Self

Set the minimum samples required to split an internal node (fluent API)

Source

pub fn min_samples_leaf(self, min_samples_leaf: usize) -> Self

Set the minimum samples required to be at a leaf node (fluent API)

Source

pub fn missing_values(self, strategy: MissingValueStrategy) -> Self

Set the missing value strategy (fluent API)

Source

pub fn random_state(self, random_state: Option<u64>) -> Self

Set the random seed (fluent API)

Source§

impl DecisionTree<Untrained>

Source

pub fn is_fitted(&self) -> bool

Check if the tree has been fitted (always false for Untrained trees)

Source

pub fn n_classes(&self) -> usize

Get the number of classes (not available for untrained trees)

Source§

impl DecisionTree<Trained>

Source

pub fn is_fitted(&self) -> bool

Check if the tree has been fitted (always true for Trained trees)

Source

pub fn n_classes(&self) -> usize

Get the number of classes (for classification trees)

Trait Implementations§

Source§

impl<State: Clone> Clone for DecisionTree<State>

Source§

fn clone(&self) -> DecisionTree<State>

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<State: Debug> Debug for DecisionTree<State>

Source§

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

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

impl<State> Default for DecisionTree<State>

Source§

fn default() -> Self

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

impl Estimator<Trained> for DecisionTree<Trained>

Source§

type Config = DecisionTreeConfig

Configuration type for the estimator
Source§

type Error = SklearsError

Error type for the estimator
Source§

type Float = f64

The numeric type used by this estimator
Source§

fn config(&self) -> &Self::Config

Get estimator configuration
Source§

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>

Check if estimator is compatible with given data dimensions
Source§

fn metadata(&self) -> EstimatorMetadata

Get estimator metadata
Source§

impl Estimator for DecisionTree<Untrained>

Source§

type Config = DecisionTreeConfig

Configuration type for the estimator
Source§

type Error = SklearsError

Error type for the estimator
Source§

type Float = f64

The numeric type used by this estimator
Source§

fn config(&self) -> &Self::Config

Get estimator configuration
Source§

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>

Check if estimator is compatible with given data dimensions
Source§

fn metadata(&self) -> EstimatorMetadata

Get estimator metadata
Source§

impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>> for DecisionTree<Untrained>

Source§

type Fitted = DecisionTree<Trained>

The fitted model type
Source§

fn fit(self, x: &Array2<f64>, y: &Array1<f64>) -> 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,

Fit with custom validation and early stopping
Source§

impl Predict<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>> for DecisionTree<Trained>

Source§

fn predict(&self, x: &Array2<f64>) -> Result<Array1<f64>>

Make predictions on the provided data
Source§

fn predict_with_uncertainty( &self, x: &X, ) -> Result<(Output, UncertaintyMeasure), SklearsError>

Make predictions with confidence intervals

Auto Trait Implementations§

§

impl<State> Freeze for DecisionTree<State>

§

impl<State> RefUnwindSafe for DecisionTree<State>
where State: RefUnwindSafe,

§

impl<State> Send for DecisionTree<State>
where State: Send,

§

impl<State> Sync for DecisionTree<State>
where State: Sync,

§

impl<State> Unpin for DecisionTree<State>
where State: Unpin,

§

impl<State> UnwindSafe for DecisionTree<State>
where State: UnwindSafe,

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> StableApi for T
where T: Estimator,

Source§

const STABLE_SINCE: &'static str = "0.1.0"

API version this type was stabilized in
Source§

const HAS_EXPERIMENTAL_FEATURES: bool = false

Whether this API has any experimental features
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