Struct DecisionTreeParams

pub struct DecisionTreeParams<F, L>(/* private fields */);

Implementations

impl<F: Float, L: Label> DecisionTreeParams<F, L>

pub fn new() -> Self

pub fn split_quality(self, split_quality: SplitQuality) -> Self

Sets the metric used to decide the feature on which to split a node

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

Sets the optional limit to the depth of the decision tree

pub fn min_weight_split(self, min_weight_split: f32) -> Self

Sets the minimum weight of samples required to split a node.

If the observations do not have associated weights, this value represents the minimum number of samples required to split a node.

pub fn min_weight_leaf(self, min_weight_leaf: f32) -> Self

Sets the minimum weight of samples that a split has to place in each leaf

If the observations do not have associated weights, this value represents the minimum number of samples that a split has to place in each leaf.

pub fn min_impurity_decrease(self, min_impurity_decrease: F) -> Self

Sets the minimum decrease in impurity that a split needs to bring in order for it to be applied

Trait Implementations

impl<F: Clone, L: Clone> Clone for DecisionTreeParams<F, L>

fn clone(&self) -> DecisionTreeParams<F, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug, L: Debug> Debug for DecisionTreeParams<F, L>

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

Formats the value using the given formatter.

impl<F: Float, L: Label> Default for DecisionTreeParams<F, L>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float, L> ParamGuard for DecisionTreeParams<F, L>

type Checked = DecisionTreeValidParams<F, L>

The checked hyperparameters

type Error = Error

Error type resulting from failed hyperparameter checking

fn check_ref(&self) -> Result<&Self::Checked>

Checks the hyperparameters and returns a reference to the checked hyperparameters if successful

fn check(self) -> Result<Self::Checked>

Checks the hyperparameters and returns the checked hyperparameters if successful

fn check_unwrap(self) -> Self::Checked

where Self: Sized,

Calls check() and unwraps the result

impl<F: PartialEq, L: PartialEq> PartialEq for DecisionTreeParams<F, L>

fn eq(&self, other: &DecisionTreeParams<F, L>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: Copy, L: Copy> Copy for DecisionTreeParams<F, L>

impl<F, L> StructuralPartialEq for DecisionTreeParams<F, L>