bund_stdlib_text_classifier 0.5.0

Text classification using Bayes classifier for BUND programming language
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

# Module for BUND standard library: Naive Bayes text classifier

A powerful and flexible text classification module built on top of the bund machine learning framework. This module is part of the
Bund Standard Library (stdlib) and provides a streamlined workflow for training, evaluating, and deploying text classification models.
This module is a library and not designed to be a standalone application, but it can be embedded inside BUND virtual machine.

## Installation

This module required _make_ and _Rust_ framework to be installed first. After that:

```bash
cargo add bund_stdlib_text_classifier
```

## Quick start

Get started with a simple example to classify text data. First, you have to create and train classifier

```rust
:TEST textclassifier.new
    :rust "./scripts/rust.txt" textclassifier.train.from_file
    "{A} tokens for RUST" format println
    :kant "./scripts/kant.txt" textclassifier.train.from_file
    "{A} tokens for KANT" format println
    :astronomy "./scripts/astronomy.txt" textclassifier.train.from_file
    "{A} tokens for ASTRONOMY" format println
    :tolstoy "./scripts/tolstoy.txt" textclassifier.train.from_file
    "{A} tokens for LEO TOLSTOY" format println
    textclassifier.train.finish
```

Then you can classify any text lines.

```rust
:TEST
  "At its simplest, a test in Rust is a function that’s annotated with the test attribute. Attributes are metadata about pieces of Rust code"
    textclassifier.classify
```

The following call will return a DICT value:

```json
{
  "astronomy": 0.8331765363980779,
  "kant": 0.9968812285706273,
  "rust": 1.0,
  "tolstoy": 0.9968812285706273
}
```
## BUND functions exposed in this module

| Name | Stack IN | Stack OUT | Description |
|------|----------|-----------|-------------|
| textclassifier.new | `Classifier name`<br/> | `Classifier name`<br/> | Create new classifier |
| textclassifier.exists | `Classifier name`<br/> | `Classifier name`<br/>`TRUE/FALSE` | Check if classifier exists |
| textclassifier.train.from_file | `Classifier name`<br/>`Category`<br/>`Filename` | `Classifier name`<br/>`Number of tokens` | Train classifier from text file |
| textclassifier.train.finish | `Classifier name`<br/> | `Classifier name`<br/> | Finalize classifier training |
| textclassifier.classify | `Classifier name`<br/>`Text for classification` | `Classifier name`<br/>`DICT with scores` | Classify text string using pre-trained classifier |