TargetEncoder

Struct TargetEncoder 

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

TargetEncoder for supervised categorical encoding

This encoder transforms categorical features using the target variable values, encoding each category with a statistic (mean, median, etc.) of the target values for that category. This is useful for high-cardinality categorical features.

§Examples

use ndarray::Array2;
use scirs2_transform::encoding::TargetEncoder;

let x = Array2::from_shape_vec((6, 1), vec![0.0, 1.0, 2.0, 0.0, 1.0, 2.0]).unwrap();
let y = vec![1.0, 2.0, 3.0, 1.5, 2.5, 3.5];

let mut encoder = TargetEncoder::new("mean", 1.0, 0.0).unwrap();
let encoded = encoder.fit_transform(&x, &y).unwrap();

Implementations§

Source§

impl TargetEncoder

Source

pub fn new(_strategy: &str, smoothing: f64, globalstat: f64) -> Result<Self>

Creates a new TargetEncoder

§Arguments
  • strategy - Encoding strategy (‘mean’, ‘median’, ‘count’, ‘sum’)
  • smoothing - Smoothing parameter (0.0 = no smoothing, higher = more smoothing)
  • globalstat - Global statistic fallback for unknown categories
§Returns
  • A new TargetEncoder instance
Source

pub fn with_mean(smoothing: f64) -> Self

Creates a TargetEncoder with mean strategy and default smoothing

Source

pub fn with_median(smoothing: f64) -> Self

Creates a TargetEncoder with median strategy

Source

pub fn fit<S>(&mut self, x: &ArrayBase<S, Ix2>, y: &[f64]) -> Result<()>
where S: Data, S::Elem: Float + NumCast,

Fits the TargetEncoder to the input data and target values

§Arguments
  • x - The input categorical data, shape (n_samples, n_features)
  • y - The target values, length n_samples
§Returns
  • Result<()> - Ok if successful, Err otherwise
Source

pub fn transform<S>(&self, x: &ArrayBase<S, Ix2>) -> Result<Array2<f64>>
where S: Data, S::Elem: Float + NumCast,

Transforms the input data using the fitted TargetEncoder

§Arguments
  • x - The input categorical data, shape (n_samples, n_features)
§Returns
  • Result<Array2<f64>> - The target-encoded data
Source

pub fn fit_transform<S>( &mut self, x: &ArrayBase<S, Ix2>, y: &[f64], ) -> Result<Array2<f64>>
where S: Data, S::Elem: Float + NumCast,

Fits the TargetEncoder and transforms the data in one step

§Arguments
  • x - The input categorical data, shape (n_samples, n_features)
  • y - The target values, length n_samples
§Returns
  • Result<Array2<f64>> - The target-encoded data
Source

pub fn encodings(&self) -> Option<&Vec<HashMap<u64, f64>>>

Returns the learned encodings for each feature

§Returns
  • Option<&Vec<HashMap<u64, f64>>> - The category encodings for each feature
Source

pub fn is_fitted(&self) -> bool

Returns whether the encoder has been fitted

Source

pub fn global_mean(&self) -> f64

Returns the global mean computed during fitting

Source

pub fn fit_transform_cv<S>( &mut self, x: &ArrayBase<S, Ix2>, y: &[f64], cv_folds: usize, ) -> Result<Array2<f64>>
where S: Data, S::Elem: Float + NumCast,

Applies cross-validation target encoding to prevent overfitting

This method performs k-fold cross-validation to compute target encodings, which helps prevent overfitting when the same data is used for both fitting and transforming.

§Arguments
  • x - The input categorical data, shape (n_samples, n_features)
  • y - The target values, length n_samples
  • cv_folds - Number of cross-validation folds (default: 5)
§Returns
  • Result<Array2<f64>> - The cross-validated target-encoded data

Trait Implementations§

Source§

impl Clone for TargetEncoder

Source§

fn clone(&self) -> TargetEncoder

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 Debug for TargetEncoder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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