Skip to main content

RandomTreesEmbedding

Struct RandomTreesEmbedding 

Source
pub struct RandomTreesEmbedding<F> {
    pub n_estimators: usize,
    pub max_depth: Option<usize>,
    pub min_samples_split: usize,
    pub random_state: Option<u64>,
    /* private fields */
}
Expand description

Random trees embedding for unsupervised feature transformation.

Builds an ensemble of randomly split trees (ignoring targets) and represents each sample as a one-hot encoding of its leaf index in each tree, concatenated across all trees.

This is useful for creating a nonlinear feature representation that can be fed into linear models.

§Type Parameters

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

Fields§

§n_estimators: usize

Number of random trees to build.

§max_depth: Option<usize>

Maximum depth of each tree. None means unlimited.

§min_samples_split: usize

Minimum number of samples required to split a node.

§random_state: Option<u64>

Random seed for reproducibility. None means non-deterministic.

Implementations§

Source§

impl<F: Float> RandomTreesEmbedding<F>

Source

pub fn new() -> Self

Create a new RandomTreesEmbedding with default settings.

Defaults: n_estimators = 10, max_depth = Some(5), min_samples_split = 2, random_state = None.

Source

pub fn with_n_estimators(self, n_estimators: usize) -> Self

Set the number of random trees.

Source

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

Set the maximum tree depth.

Source

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

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

Source

pub fn with_random_state(self, seed: u64) -> Self

Set the random seed for reproducibility.

Trait Implementations§

Source§

impl<F: Clone> Clone for RandomTreesEmbedding<F>

Source§

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

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<F: Debug> Debug for RandomTreesEmbedding<F>

Source§

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

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

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

Source§

fn default() -> Self

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

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

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

Source§

fn fit( &self, x: &Array2<F>, _y: &(), ) -> Result<FittedRandomTreesEmbedding<F>, FerroError>

Fit the random trees embedding on the training data.

Builds an ensemble of trees with purely random splits (random feature, random threshold between feature min and max in the current node), ignoring any target variable.

§Errors

Returns FerroError::InsufficientSamples if there are no samples. Returns FerroError::InvalidParameter if hyperparameters are invalid.

Source§

type Fitted = FittedRandomTreesEmbedding<F>

The fitted model type returned by fit.
Source§

type Error = FerroError

The error type returned by fit.
Source§

impl<F: Float + Send + Sync + 'static> PipelineTransformer<F> for RandomTreesEmbedding<F>

Source§

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

Fit this transformer on the given data. Read more
Source§

impl<F> Serialize for RandomTreesEmbedding<F>

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<F> Freeze for RandomTreesEmbedding<F>

§

impl<F> RefUnwindSafe for RandomTreesEmbedding<F>
where F: RefUnwindSafe,

§

impl<F> Send for RandomTreesEmbedding<F>
where F: Send,

§

impl<F> Sync for RandomTreesEmbedding<F>
where F: Sync,

§

impl<F> Unpin for RandomTreesEmbedding<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for RandomTreesEmbedding<F>

§

impl<F> UnwindSafe for RandomTreesEmbedding<F>
where F: 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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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> 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

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,