Struct Config

pub struct Config {
    pub ngrams: usize,
    pub punctuation: HashSet<char>,
    pub window_size: usize,
    pub strict_capital: bool,
    pub only_alphanumeric_and_hyphen: bool,
    pub minimum_chars: usize,
    pub remove_duplicates: bool,
    pub deduplication_threshold: f64,
}

Fine-tunes keyword extraction.

Fields

ngrams: usize

How many words a key phrase may contain.

n-gram is a contiguous sequence of n words occurring in the text.

punctuation: HashSet<char>

List of punctuation symbols.

They are known as exclude chars in the original implementation.

window_size: usize

The number of tokens both preceding and following a term to calculate term dispersion metric.

strict_capital: bool

When true, calculate term casing metric by counting capitalized terms without intermediate uppercase letters. Thus, Paypal is counted while PayPal is not.

The original implementation sticks with true.

only_alphanumeric_and_hyphen: bool

When true, key phrases are allowed to have only alphanumeric characters and hyphen.

minimum_chars: usize

Key phrases can’t be too short, less than minimum_chars in total.

remove_duplicates: bool

When true, similar key phrases are deduplicated.

Key phrases are considered similar if their Levenshtein distance is greater than deduplication_threshold.

deduplication_threshold: f64

A threshold in range 0..1. Equal strings have the distance equal to 1.

Effective only when remove_duplicates is true.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Config