Skip to main content

TextCnnLite

Struct TextCnnLite 

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

Lightweight text-CNN classifier.

Extracts n-gram features (bag-of-n-grams) for each filter size and then trains a multinomial logistic regression head using mini-batch stochastic gradient descent.

This is intentionally a “lite” variant — it approximates a CNN’s 1-D convolution by computing frequency counts of character/word n-grams and using the max-pooled (most-frequent) value as the feature. A proper convolutional network would require a full neural-network framework.

§Example

use scirs2_text::text_classification::TextCnnLite;

let mut clf = TextCnnLite::new(vec![2, 3], 8);
let texts  = &["good movie fun", "bad film boring", "great show entertaining", "terrible awful waste"];
let labels = &["pos", "neg", "pos", "neg"];
clf.fit(texts, labels, 20).unwrap();

Implementations§

Source§

impl TextCnnLite

Source

pub fn new(filter_sizes: Vec<usize>, n_filters: usize) -> Self

Create a new TextCnnLite.

§Parameters
  • filter_sizes: n-gram window sizes, e.g. [2, 3, 4].
  • n_filters: number of top n-gram features to keep per filter size.
Source

pub fn fit( &mut self, texts: &[&str], labels: &[&str], epochs: usize, ) -> Result<()>

Train the classifier.

Internally:

  1. Build the n-gram vocabulary from all documents.
  2. Vectorise each document into a frequency vector.
  3. Train multinomial logistic regression with SGD.
§Errors

Returns TextError::InvalidInput when texts and labels lengths differ or when the corpus is empty.

Source

pub fn predict(&self, text: &str) -> Result<String>

Predict the most probable class for text.

§Errors

Returns TextError::ModelNotFitted when the model has not been trained.

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