Struct DecisionTreeClassifier 

pub struct DecisionTreeClassifier<F> {
    pub max_depth: Option<usize>,
    pub min_samples_split: usize,
    pub min_samples_leaf: usize,
    pub criterion: ClassificationCriterion,
    /* private fields */
}

CART decision tree classifier.

Builds a binary tree by recursively finding the feature and threshold that maximises the reduction in the chosen impurity criterion (Gini or Entropy).

Type Parameters

• F: The floating-point type (f32 or f64).

Fields

max_depth: Option<usize>

Maximum depth of the tree. None means unlimited.

min_samples_split: usize

Minimum number of samples required to split an internal node.

min_samples_leaf: usize

Minimum number of samples required in a leaf node.

criterion: ClassificationCriterion

Splitting criterion.

Implementations

impl<F: Float> DecisionTreeClassifier<F>

pub fn new() -> Self

Create a new DecisionTreeClassifier with default settings.

Defaults: max_depth = None, min_samples_split = 2, min_samples_leaf = 1, criterion = Gini.

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

Set the maximum tree depth.

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

Set the minimum number of samples required to split a node.

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

Set the minimum number of samples required in a leaf node.

pub fn with_criterion(self, criterion: ClassificationCriterion) -> Self

Set the splitting criterion.

Trait Implementations

impl<F: Clone> Clone for DecisionTreeClassifier<F>

fn clone(&self) -> DecisionTreeClassifier<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for DecisionTreeClassifier<F>

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

Formats the value using the given formatter.

impl<F: Float> Default for DecisionTreeClassifier<F>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, F> Deserialize<'de> for DecisionTreeClassifier<F>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Float + Send + Sync + 'static> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<usize>, Dim<[usize; 1]>>> for DecisionTreeClassifier<F>

fn fit( &self, x: &Array2<F>, y: &Array1<usize>, ) -> Result<FittedDecisionTreeClassifier<F>, FerroError>

Fit the decision tree classifier on the training data.

Errors

Returns FerroError::ShapeMismatch if x and y have different numbers of samples. Returns FerroError::InsufficientSamples if there are no samples. Returns FerroError::InvalidParameter if hyperparameters are invalid.

type Fitted = FittedDecisionTreeClassifier<F>

The fitted model type returned by fit.

type Error = FerroError

The error type returned by fit.

impl<F: Float + ToPrimitive + FromPrimitive + Send + Sync + 'static> PipelineEstimator<F> for DecisionTreeClassifier<F>

fn fit_pipeline( &self, x: &Array2<F>, y: &Array1<F>, ) -> Result<Box<dyn FittedPipelineEstimator<F>>, FerroError>

Fit this estimator on the given data.

impl<F> Serialize for DecisionTreeClassifier<F>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.