keyword_extraction 1.5.0

Collection of algorithms for keyword extraction from text
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

// Copyright (C) 2024 Afonso Barracha
//
// Rust Keyword Extraction is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Rust Keyword Extraction is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Rust Keyword Extraction. If not, see <http://www.gnu.org/licenses/>.

use crate::common::{Punctuation, Stopwords, Text, WindowSize};

type Threshold = f32;
type Ngram = usize;

pub enum YakeParams<'a> {
    /// ## Arguments
    /// 1. `text` - The text to be analyzed.
    /// 2. `stop_words` - A list of stop words.
    /// ### Defaults values:
    /// * `punctuation` - A list of punctuation symbols, defaults to those in Latin and Germanic languages.
    /// * `threshold` - 0.85
    /// * `ngram` - 3
    /// * `window_size` - 2
    WithDefaults(Text<'a>, Stopwords<'a>),

    /// ## Arguments
    /// 1. `text` - The text to be analyzed.
    /// 2. `stop_words` - A list of stop words.
    /// 3. `threshold` - The threshold to be used for candidate filtering.
    /// 4. `ngram` - The size of the n-grams to be used for keyword.
    /// 5. `window_size` - The size of the window to be used for keyword extraction.
    All(
        Text<'a>,
        Stopwords<'a>,
        Punctuation<'a>,
        Threshold,
        Ngram,
        WindowSize,
    ),
}

impl<'a> YakeParams<'a> {
    pub fn get_params(
        &self,
    ) -> (
        Text<'a>,
        Stopwords<'a>,
        Punctuation<'a>,
        Threshold,
        Ngram,
        WindowSize,
    ) {
        match self {
            YakeParams::WithDefaults(text, stop_words) => (*text, *stop_words, None, 0.85, 3, 2),
            YakeParams::All(text, stop_words, punctuation, threshold, ngram, window_size) => (
                *text,
                *stop_words,
                *punctuation,
                *threshold,
                *ngram,
                *window_size,
            ),
        }
    }
}