budoux 0.1.0

Rust port of BudouX (machine learning powered line break organizer tool).
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

# BudouX-rs

[![Crates.io](https://img.shields.io/crates/v/budoux.svg)](https://crates.io/crates/budoux)
[![API reference](https://docs.rs/budoux/badge.svg)](https://docs.rs/crate/budoux/)
[![Test](https://github.com/sg0hsmt/budoux-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/sg0hsmt/budoux-rs/actions/workflows/test.yaml)
[![License](https://img.shields.io/github/license/sg0hsmt/budoux-rs.svg)](https://github.com/sg0hsmt/budoux-rs/blob/master/LICENSE)

BudouX-rs is a rust port of [BudouX](https://github.com/google/budoux) (machine learning powered line break organizer tool).

Note:
This project contains the deliverables of the [BudouX](https://github.com/google/budoux) project.

Note:
BudouX-rs supported plain text only, not supports html inputs.

## Demo

https://sg0hsmt.github.io/budoux-rs/

## Documentation

https://docs.rs/crate/budoux/

## Usage

Split sentences with internal model.

```rust
let model = budoux::models::default_japanese_model();
let words = budoux::parse(model, "これはテストです。");

assert_eq!(words, vec!["これは", "テストです。"])
```

Load model from json file and split sentences using the loaded model.

```rust
let file = File::open(path_to_json).unwrap();
let reader = BufReader::new(file);
let model: budoux::Model = serde_json::from_reader(reader).unwrap();
let words = budoux::parse(&model, "これはテストです。");

assert_eq!(words, vec!["これは", "テストです。"])
```

## Test

```console
cargo test
```

You can use GitHub Actions locally by [act](https://github.com/nektos/act).

```console
act -j test
```

## Generate model from original BudouX

```console
go generate ./...
```

Note:
Generate model is require Go 1.13 or later.