Skip to main content

DecisionTreeLearner

Struct DecisionTreeLearner 

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

ID3/C4.5-style decision tree learner.

use ipfrs_tensorlogic::{DecisionTreeLearner, DtlSample, DtlLearnerConfig, DtlCriterion};

let mut learner = DecisionTreeLearner::new(
    DtlLearnerConfig { max_depth: 5, ..Default::default() },
    vec!["petal_len".into(), "petal_wid".into()],
);

let samples = vec![
    DtlSample::new(vec![1.0, 0.5], "setosa"),
    DtlSample::new(vec![4.5, 1.5], "versicolor"),
    DtlSample::new(vec![5.0, 2.0], "virginica"),
    DtlSample::new(vec![1.2, 0.4], "setosa"),
    DtlSample::new(vec![4.8, 1.8], "versicolor"),
];
learner.fit(&samples).expect("example: should succeed in docs");

let pred = learner.predict(&[1.1, 0.45]).expect("example: should succeed in docs");
assert_eq!(pred.label, "setosa");

Implementations§

Source§

impl DecisionTreeLearner

Source

pub fn new(config: DtlLearnerConfig, feature_names: Vec<String>) -> Self

Create a new (untrained) learner.

feature_names is optional context: if non-empty its length must match the feature dimension of the first fit call.

Source

pub fn with_defaults(feature_names: Vec<String>) -> Self

Convenience constructor with default configuration.

Source§

impl DecisionTreeLearner

Source

pub fn fit(&mut self, samples: &[DtlSample]) -> Result<(), DtlError>

Train the decision tree on samples.

Clears any previously trained tree. Feature names, if provided at construction, are validated against the sample dimension.

Source§

impl DecisionTreeLearner

Source

pub fn predict(&self, features: &[f64]) -> Result<DtlPrediction, DtlError>

Predict the class label for a single feature vector.

Source

pub fn predict_batch( &self, samples: &[Vec<f64>], ) -> Vec<Result<DtlPrediction, DtlError>>

Predict a batch of feature vectors.

Source§

impl DecisionTreeLearner

Source

pub fn feature_importance(&self) -> Vec<(String, f64)>

Compute normalised feature importances (weighted impurity reduction).

Returns a vector of (feature_name, importance) pairs sorted by importance descending. Values are normalised to sum to 1.0.

Source§

impl DecisionTreeLearner

Source

pub fn depth(&self) -> usize

Return the depth of the trained tree (0 if not trained).

Source

pub fn n_leaves(&self) -> usize

Return the number of leaf nodes (0 if not trained).

Source

pub fn n_nodes(&self) -> usize

Return the total number of nodes (0 if not trained).

Source§

impl DecisionTreeLearner

Source

pub fn prune(&mut self, min_samples: usize)

Post-hoc pruning: collapse split nodes where both children are leaves and neither has at least min_samples samples in the majority class.

This is a conservative bottom-up pruning pass that replaces such split nodes with a single leaf carrying the combined class distribution.

Source§

impl DecisionTreeLearner

Source

pub fn learner_stats(&self) -> DtlLearnerStats

Return a snapshot of learner statistics.

Source

pub fn history(&self) -> &VecDeque<DtlTrainingRecord>

Reference to the training history ring-buffer.

Source

pub fn config(&self) -> &DtlLearnerConfig

Reference to the current configuration.

Source

pub fn feature_names(&self) -> &[String]

Reference to the feature names.

Source

pub fn class_labels(&self) -> &[String]

Reference to the discovered class labels.

Source

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

Access the raw tree root (for serialisation / inspection).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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