Lindera
A morphological analysis library in Rust. This project fork from kuromoji-rs.
Lindera aims to build a library which is easy to install and provides concise APIs for various Rust applications.
The following products are required to build:
- Rust >= 1.46.0
Usage
Make sure you activated the full features of the lindera crate on Cargo.toml:
[dependencies]
lindera = { version = "0.12.0", features = ["full"] }
Basic example
This example covers the basic usage of Lindera.
It will:
- Create a tokenizer in normal mode
- Tokenize the input text
- Output the tokens
use lindera::tokenizer::Tokenizer;
use lindera::LinderaResult;
fn main() -> LinderaResult<()> {
// create tokenizer
let tokenizer = Tokenizer::new()?;
// tokenize the text
let tokens = tokenizer.tokenize("関西国際空港限定トートバッグ")?;
// output the tokens
for token in tokens {
println!("{}", token.text);
}
Ok(())
}The above example can be run as follows:
% cargo run --features=ipadic --example=basic_exampleYou can see the result as follows:
関西国際空港
限定
トートバッグ
User dictionary example
You can give user dictionary entries along with the default system dictionary. User dictionary should be a CSV with following format.
<surface_form>,<part_of_speech>,<reading>
For example:
% cat ./resources/simple_userdic.csv
東京スカイツリー,カスタム名詞,トウキョウスカイツリー
東武スカイツリーライン,カスタム名詞,トウブスカイツリーライン
とうきょうスカイツリー駅,カスタム名詞,トウキョウスカイツリーエキWith an user dictionary, Tokenizer will be created as follows:
use std::path::PathBuf;
use lindera::LinderaResult;
use lindera::{
mode::Mode,
tokenizer::{
DictionaryConfig, DictionaryKind, DictionarySourceType, Tokenizer, TokenizerConfig,
UserDictionaryConfig,
},
};
fn main() -> LinderaResult<()> {
let dictionary = DictionaryConfig {
kind: DictionaryKind::IPADIC,
path: None,
};
let user_dictionary = Some(UserDictionaryConfig {
kind: DictionaryKind::IPADIC,
source_type: DictionarySourceType::Csv,
path: PathBuf::from("./resources/ipadic_simple_userdic.csv"),
});
// create tokenizer
let config = TokenizerConfig {
dictionary,
user_dictionary: user_dictionary,
mode: Mode::Normal,
};
let tokenizer = Tokenizer::with_config(config)?;
// tokenize the text
let tokens = tokenizer.tokenize("東京スカイツリーの最寄り駅はとうきょうスカイツリー駅です")?;
// output the tokens
for token in tokens {
println!("{}", token.text);
}
Ok(())
}The above example can be by cargo run --example:
% cargo run --features=ipadic --example=userdic_example
東京スカイツリー
の
最寄り駅
は
とうきょうスカイツリー駅
ですAPI reference
The API reference is available. Please see following URL: