instant-labs
/
instant-segment
mirror of https://github.com/instant-labs/instant-segment.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

py: add some comments

This commit is contained in:
Dirkjan Ochtman 2021-03-24 11:47:47 +01:00
parent 5d8f1b2fb0
commit 987220c586
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
instant-segment-py/src/lib.rs
View File

@ -14,6 +14,7 @@ fn instant_segment(_: Python, m: &PyModule) -> PyResult<()> {
Ok(())
}
/// Segmenter holding the word lists
#[pyclass]
struct Segmenter {
inner: instant_segment::Segmenter,
@ -21,6 +22,10 @@ struct Segmenter {
#[pymethods]
impl Segmenter {
/// Build a segmenter from `unigrams` and `bigrams` iterators
///
/// The `unigrams` iterator should yield `(str, float)` items, while the `bigrams`
/// iterator should yield `((str, str), float)` items.
#[new]
fn new(unigrams: &PyIterator, bigrams: &PyIterator) -> PyResult<Self> {
let unigrams = unigrams
@ -68,6 +73,12 @@ impl Segmenter {
Ok(())
}
/// Segment the given str `s`
///
/// The `search` object contains buffers used for searching. When the search completes,
/// iterate over the `Search` to get the resulting words.
///
/// For best performance, reusing `Search` objects is recommended.
fn segment(&self, s: &str, search: &mut Search) -> PyResult<()> {
match self.inner.segment(s, &mut search.inner) {
Ok(_) => {