Skip to main content

TfIdfVectorizer

Struct TfIdfVectorizer 

Source
pub struct TfIdfVectorizer {
    pub min_df: usize,
    pub max_df: f64,
    pub max_features: Option<usize>,
    pub ngram_range: (usize, usize),
    pub char_level: bool,
    pub case_sensitive: bool,
    /* private fields */
}
Expand description

TF-IDF (Term Frequency-Inverse Document Frequency) preprocessor

TF-IDF is a numerical statistic that reflects how important a word is to a document in a collection of documents. It increases proportionally to the number of times a word appears in the document but is offset by the frequency of the word in the corpus.

TF-IDF(t,d,D) = TF(t,d) × IDF(t,D)

where:

  • TF(t,d) = (Number of times term t appears in document d) / (Total number of terms in d)
  • IDF(t,D) = log(Total number of documents / Number of documents containing term t)

Fields§

§min_df: usize

Minimum document frequency (ignore terms that appear in fewer documents)

§max_df: f64

Maximum document frequency (ignore terms that appear in more documents)

§max_features: Option<usize>

Maximum number of features

§ngram_range: (usize, usize)

N-gram range (min_n, max_n)

§char_level: bool

Whether to use character-level n-grams

§case_sensitive: bool

Case sensitivity

Implementations§

Source§

impl TfIdfVectorizer

Source

pub fn new() -> Self

Create a new TF-IDF vectorizer

Source

pub fn with_min_df(self, min_df: usize) -> Self

Set minimum document frequency

Source

pub fn with_max_df(self, max_df: f64) -> Self

Set maximum document frequency

Source

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

Set maximum features

Source

pub fn with_ngram_range(self, min_n: usize, max_n: usize) -> Self

Set n-gram range

Source

pub fn with_char_level(self, char_level: bool) -> Self

Set character level

Source

pub fn with_case_sensitive(self, case_sensitive: bool) -> Self

Set case sensitivity

Source

pub fn fit(&mut self, documents: &[String]) -> Result<()>

Fit the vectorizer on a corpus

Source

pub fn transform(&self, documents: &[String]) -> Result<Array2<f64>>

Transform documents to TF-IDF matrix

Source

pub fn fit_transform(&mut self, documents: &[String]) -> Result<Array2<f64>>

Fit and transform in one step

Source

pub fn get_feature_names(&self) -> Result<Vec<String>>

Get feature names

Trait Implementations§

Source§

impl Clone for TfIdfVectorizer

Source§

fn clone(&self) -> TfIdfVectorizer

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 TfIdfVectorizer

Source§

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

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

impl Default for TfIdfVectorizer

Source§

fn default() -> Self

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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