rlx-ocr 0.2.0

OCR engine for RLX — text detection + recognition
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

// RLX — versatile ML compiler + runtime.
// Copyright (C) 2026 Eugene Hauptmann, Nataliya Kosmyna.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! OCR configuration — detection thresholds, alphabet, decode method.

/// Default character alphabet matching ocrs pretrained recognition models.
pub const DEFAULT_ALPHABET: &str = " 0123456789!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~€ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";

/// Post-processing parameters for the text detection segmentation mask.
#[derive(Clone, Debug, PartialEq)]
pub struct DetectionParams {
    /// Minimum area of word bounding boxes returned from connected components.
    pub min_area: f32,
    /// Per-pixel score threshold for classifying a pixel as text.
    pub text_threshold: f32,
}

impl Default for DetectionParams {
    fn default() -> Self {
        Self {
            min_area: 100.,
            text_threshold: 0.2,
        }
    }
}

/// Method used to decode CRNN sequence outputs.
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub enum DecodeMethod {
    #[default]
    Greedy,
    BeamSearch {
        width: u32,
    },
}

/// Fixed input height for the recognition model (ocrs default).
pub const RECOGNITION_INPUT_HEIGHT: u32 = 64;

/// Shared OCR settings.
#[derive(Clone, Debug)]
pub struct OcrConfig {
    pub detection: DetectionParams,
    pub decode_method: DecodeMethod,
    pub alphabet: String,
}

impl Default for OcrConfig {
    fn default() -> Self {
        Self {
            detection: DetectionParams::default(),
            decode_method: DecodeMethod::default(),
            alphabet: DEFAULT_ALPHABET.to_string(),
        }
    }
}