Struct Model

Source

pub struct Model { /* private fields */ }

Expand description

UDPipe model wrapper.

This is the main type for loading and using UDPipe models. Models can be loaded from files or from memory.

Implementations§

Source §

impl Model

Source

pub fn load(path: impl AsRef<Path>) -> Result<Self, UdpipeError>

Load a model from a file path.

§Errors

Returns an error if the path contains a null byte or if the model cannot be loaded.

§Example

use udpipe_rs::Model;
let model = Model::load("english-ewt-ud-2.5-191206.udpipe").expect("Failed to load model");

Source

pub fn load_from_memory(data: &[u8]) -> Result<Self, UdpipeError>

Load a model from a byte slice.

This is useful for loading models from network sources or embedded data.

§Errors

Returns an error if the data is empty or not a valid UDPipe model.

§Example

use udpipe_rs::Model;
let model_data = std::fs::read("english-ewt-ud-2.5-191206.udpipe").expect("Failed to read model");
let model = Model::load_from_memory(&model_data).expect("Failed to load model");

Source

pub fn parse(&self, text: &str) -> Result<Vec<Word>, UdpipeError>

Parse text and return all words with their UD annotations.

The text is tokenized, tagged, lemmatized, and parsed for dependencies.

§Errors

Returns an error if the text contains a null byte or if parsing fails.

§Example

use udpipe_rs::Model;
let model = Model::load("english-ewt-ud-2.5-191206.udpipe").expect("Failed to load");
let words = model.parse("The quick brown fox.").expect("Failed to parse");
for word in words {
    println!("{} -> {} ({})", word.form, word.lemma, word.upostag);
}