rucrf 0.2.2

Conditional Random Fields implemented in pure Rust
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

# rucrf: Conditional Random Fields implemented in pure Rust

[![Crates.io](https://img.shields.io/crates/v/rucrf)](https://crates.io/crates/rucrf)
[![Documentation](https://docs.rs/rucrf/badge.svg)](https://docs.rs/rucrf)
[![Rust](https://img.shields.io/badge/rust-1.63%2B-blue.svg?maxAge=3600)](https://github.com/daac-tools/rucrf)
[![Build Status](https://github.com/daac-tools/rucrf/actions/workflows/rust.yml/badge.svg)](https://github.com/daac-tools/rucrf)

*rucrf* contains a trainer and an estimator for Conditional Random Fields (CRFs).
This library supports:
- [x] lattices with variable length edges,
- [x] L1 and L2 regularization, and
- [x] multi-threading during training.

## Examples

```rust
use std::num::NonZeroU32;

use rucrf::{Edge, FeatureProvider, FeatureSet, Lattice, Model, Trainer};

// Train:
// 京(kyo) 都(to)
// 東(to) 京(kyo)
// 京(kei) 浜(hin)
// 京(kyo) の(no) 都(miyako)
//
// Test:
// 水(mizu) の(no) 都(miyako)
//
// Features:
// 京: 1, 都: 2, 東: 3, 浜: 4, の: 5, 水: 6
//
// Labels:
// 京kyo: 1, 都to: 2, 東to: 3,  京kei: 4, 浜hin: 5, のno: 6, 都mikako: 7, 水mizu: 8

let mut provider = FeatureProvider::new();
provider.add_feature_set(FeatureSet::new(
    &[NonZeroU32::new(1).unwrap()],
    &[NonZeroU32::new(1)],
    &[NonZeroU32::new(1)],
))?;
provider.add_feature_set(FeatureSet::new(
    &[NonZeroU32::new(2).unwrap()],
    &[NonZeroU32::new(2)],
    &[NonZeroU32::new(2)],
))?;
provider.add_feature_set(FeatureSet::new(
    &[NonZeroU32::new(3).unwrap()],
    &[NonZeroU32::new(3)],
    &[NonZeroU32::new(3)],
))?;
provider.add_feature_set(FeatureSet::new(
    &[NonZeroU32::new(1).unwrap()],
    &[NonZeroU32::new(4)],
    &[NonZeroU32::new(4)],
))?;
provider.add_feature_set(FeatureSet::new(
    &[NonZeroU32::new(4).unwrap()],
    &[NonZeroU32::new(5)],
    &[NonZeroU32::new(5)],
))?;
provider.add_feature_set(FeatureSet::new(
    &[NonZeroU32::new(5).unwrap()],
    &[NonZeroU32::new(6)],
    &[NonZeroU32::new(6)],
))?;
provider.add_feature_set(FeatureSet::new(
    &[NonZeroU32::new(2).unwrap()],
    &[NonZeroU32::new(7)],
    &[NonZeroU32::new(7)],
))?;
provider.add_feature_set(FeatureSet::new(
    &[NonZeroU32::new(6).unwrap()],
    &[NonZeroU32::new(8)],
    &[NonZeroU32::new(8)],
))?;

let mut lattices = vec![];

// 京都 (kyo to)
let mut lattice = Lattice::new(2)?;
lattice.add_edge(0, Edge::new(1, NonZeroU32::new(1).unwrap()))?; // kyo
lattice.add_edge(1, Edge::new(2, NonZeroU32::new(2).unwrap()))?; // to

lattice.add_edge(0, Edge::new(1, NonZeroU32::new(4).unwrap()))?; // kei
lattice.add_edge(1, Edge::new(2, NonZeroU32::new(7).unwrap()))?; // miyako

lattices.push(lattice);

// 東京 (to kyo)
let mut lattice = Lattice::new(2)?;
lattice.add_edge(0, Edge::new(1, NonZeroU32::new(3).unwrap()))?; // to
lattice.add_edge(1, Edge::new(2, NonZeroU32::new(1).unwrap()))?; // kyo

lattice.add_edge(1, Edge::new(2, NonZeroU32::new(4).unwrap()))?; // kei

lattices.push(lattice);

// 京浜 (kei hin)
let mut lattice = Lattice::new(2)?;
lattice.add_edge(0, Edge::new(1, NonZeroU32::new(4).unwrap()))?; // kei
lattice.add_edge(1, Edge::new(2, NonZeroU32::new(5).unwrap()))?; // hin

lattice.add_edge(0, Edge::new(1, NonZeroU32::new(1).unwrap()))?; // kyo

lattices.push(lattice);

// 京の都 (kyo no miyako)
let mut lattice = Lattice::new(3)?;
lattice.add_edge(0, Edge::new(1, NonZeroU32::new(1).unwrap()))?; // kyo
lattice.add_edge(1, Edge::new(2, NonZeroU32::new(6).unwrap()))?; // no
lattice.add_edge(2, Edge::new(3, NonZeroU32::new(7).unwrap()))?; // miyako

lattice.add_edge(0, Edge::new(1, NonZeroU32::new(4).unwrap()))?; // kei
lattice.add_edge(2, Edge::new(3, NonZeroU32::new(2).unwrap()))?; // to

lattices.push(lattice);

// Generates a model
let trainer = Trainer::new();
let model = trainer.train(&lattices, provider);

// 水の都 (mizu no miyako)
let mut lattice = Lattice::new(3)?;
lattice.add_edge(0, Edge::new(1, NonZeroU32::new(8).unwrap()))?; // mizu
lattice.add_edge(1, Edge::new(2, NonZeroU32::new(6).unwrap()))?; // no
lattice.add_edge(2, Edge::new(3, NonZeroU32::new(2).unwrap()))?; // to
lattice.add_edge(2, Edge::new(3, NonZeroU32::new(7).unwrap()))?; // miyako

let (path, _) = model.search_best_path(&lattice);

assert_eq!(vec![
    Edge::new(1, NonZeroU32::new(8).unwrap()),
    Edge::new(2, NonZeroU32::new(6).unwrap()),
    Edge::new(3, NonZeroU32::new(7).unwrap()),
], path);
```

## License

Licensed under either of

 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.