Skip to main content

FittedMultiLabelBinarizer

Struct FittedMultiLabelBinarizer 

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

A fitted multi-label binarizer holding the discovered class set.

Created by calling Fit::fit on a MultiLabelBinarizer.

Implementations§

Source§

impl FittedMultiLabelBinarizer

Source

pub fn classes(&self) -> &[usize]

Return the sorted class labels discovered during fitting.

Source

pub fn n_classes(&self) -> usize

Return the number of unique classes.

Source

pub fn inverse_transform( &self, y: &Array2<f64>, ) -> Result<Vec<Vec<usize>>, FerroError>

Map a multi-hot indicator matrix back to label sets.

The indicator matrix must contain only exact 0.0 and 1.0 values; a class is included for a sample iff its cell is exactly 1.0. This mirrors scikit-learn 1.5.2 MultiLabelBinarizer.inverse_transform (sklearn/preprocessing/_label.py:941-947), which validates the matrix with np.setdiff1d(yt, [0, 1]) and raises ValueError on any value outside {0, 1} before selecting classes where the cell == 1.

§Errors

Returns FerroError::ShapeMismatch if the number of columns does not match the number of classes. Returns FerroError::InvalidParameter if any cell value is not exactly 0.0 or 1.0.

Trait Implementations§

Source§

impl Clone for FittedMultiLabelBinarizer

Source§

fn clone(&self) -> FittedMultiLabelBinarizer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FittedMultiLabelBinarizer

Source§

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

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

impl Transform<Vec<Vec<usize>>> for FittedMultiLabelBinarizer

Source§

fn transform(&self, y: &Vec<Vec<usize>>) -> Result<Array2<f64>, FerroError>

Transform label sets into a multi-hot indicator matrix.

Each row has a 1.0 in every column corresponding to one of its labels and 0.0 elsewhere.

Labels not seen during fitting are silently ignored: the indicator is built only from known labels (mirroring scikit-learn 1.5.2 MultiLabelBinarizer._transform, sklearn/preprocessing/_label.py:889-902). scikit-learn additionally emits a warnings.warn("unknown class(es) ... will be ignored"); that warning is intentionally not emitted here because the crate has no logging facade and adding one would be out of scope.

The Result return type is retained because the Transform trait requires it; transform always returns Ok.

Source§

type Output = ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>

The transformed output type.
Source§

type Error = FerroError

The error type returned by transform.

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

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

unsafe 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