pub struct TfIdfLogisticClassifier { /* private fields */ }Expand description
Logistic regression classifier trained on TF-IDF features.
Uses the existing TfidfVectorizer to compute features and mini-batch
stochastic gradient descent (SGD) to train the model.
§Example
use scirs2_text::text_classification::TfIdfLogisticClassifier;
let mut clf = TfIdfLogisticClassifier::new();
let texts = &["good great excellent", "bad terrible awful", "okay decent fine", "poor mediocre subpar"];
let labels = &["pos", "neg", "pos", "neg"];
clf.fit(texts, labels, 50, 0.1).unwrap();
let pred = clf.predict("excellent wonderful").unwrap();
assert!(!pred.is_empty());Implementations§
Source§impl TfIdfLogisticClassifier
impl TfIdfLogisticClassifier
Sourcepub fn fit(
&mut self,
texts: &[&str],
labels: &[&str],
max_iter: usize,
lr: f64,
) -> Result<()>
pub fn fit( &mut self, texts: &[&str], labels: &[&str], max_iter: usize, lr: f64, ) -> Result<()>
Fit the classifier.
§Parameters
texts: Training documents.labels: Corresponding class labels.max_iter: Number of SGD epochs.lr: Learning rate for SGD.
§Errors
Returns TextError::InvalidInput when inputs are inconsistent.
Sourcepub fn predict(&self, text: &str) -> Result<String>
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.
Sourcepub fn predict_proba(&self, text: &str) -> Result<Vec<f64>>
pub fn predict_proba(&self, text: &str) -> Result<Vec<f64>>
Return the probability distribution over classes for text.
§Errors
Returns TextError::ModelNotFitted when the model has not been trained.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for TfIdfLogisticClassifier
impl !RefUnwindSafe for TfIdfLogisticClassifier
impl Send for TfIdfLogisticClassifier
impl Sync for TfIdfLogisticClassifier
impl Unpin for TfIdfLogisticClassifier
impl UnsafeUnpin for TfIdfLogisticClassifier
impl !UnwindSafe for TfIdfLogisticClassifier
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.