keyword_extraction 1.2.1

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

# Rust Keyword Extraction

## Introduction

This is a simple NLP library with a list of algorithms related to keyword extraction:

- Tokenizer for tokenizing text;
- TF-IDF for calculating the importance of a word in one or more documents;
- Co-occurrence for calculating relationships between words within a specific window size;
- RAKE for extracting key phrases from a document;
- TextRank for extracting keywords and key phrases from a document;

## Algorithms

The full list of the algorithms in this library:

- Helper algorithms:
    - [x] Tokenizer
    - [x] Co-occurrence
- Keyword extraction algorithms:
    - [x] TF-IDF
    - [x] RAKE
    - [x] TextRank

Upcoming algorithms:
- YAKE

## Usage

Add the library to your `Cargo.toml`:

```toml
[dependencies]
keyword-extraction = "1.2.0"
```

Or use cargo add:

```bash
cargo add keyword-extraction
```

### Features

It is possible to enable or disable features:

- `"tf_idf"`: TF-IDF algorithm;
- `"rake"`: RAKE algorithm;
- `"text_rank"`: TextRank algorithm;
- `"all"`: all algorithms;
- `"parallel"`: parallelization of the algorithms with Rayon;

Default features: `"tf_idf"`.

NOTE: `"parallel"` feature is only recommended for large documents, it exchanges memory for computation resourses.

## License

This project is licensed under the GNU Lesser General Public License v3.0. See the [Copying](COPYING)
and [Copying Lesser](COPYING.LESSER) files for details.