xq-vision 0.1.3

High-performance ONNX recognition pipeline for Chinese chessboard corners and pieces.
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use image::RgbImage;

use crate::board::BoardDetector;
use crate::board::BoardDetectorConfig;
use crate::board::warp_board;
use crate::config::GraphOptimization;
use crate::config::ModelSource;
use crate::config::SessionConfig;
use crate::error::Result;
use crate::error::XqVisionError;
use crate::pieces::PieceRecognizer;
use crate::pieces::PieceRecognizerConfig;
use crate::session::ProviderFailure;
use crate::types::RecognitionResult;

pub struct XqVision {
    board_detector: BoardDetector,
    piece_recognizer: PieceRecognizer,
}

impl XqVision {
    #[must_use]
    pub fn builder() -> XqVisionBuilder { XqVisionBuilder::default() }

    pub fn recognize(&mut self, image: &RgbImage) -> Result<RecognitionResult> {
        let board_detection = self.board_detector.detect(image)?;
        let board = warp_board(image, board_detection.corners)?;
        let pieces = self.piece_recognizer.recognize(&board)?;
        let user_side = pieces.user_side()?;
        Ok(RecognitionResult::new(board_detection.corners, board_detection.scores, board, pieces, user_side))
    }

    #[must_use]
    pub fn board_detector(&self) -> &BoardDetector { &self.board_detector }

    #[must_use]
    pub fn board_detector_mut(&mut self) -> &mut BoardDetector { &mut self.board_detector }

    #[must_use]
    pub fn piece_recognizer(&self) -> &PieceRecognizer { &self.piece_recognizer }

    #[must_use]
    pub fn piece_recognizer_mut(&mut self) -> &mut PieceRecognizer { &mut self.piece_recognizer }
}

#[derive(Debug, Default, Clone)]
pub struct XqVisionBuilder {
    board_model: Option<ModelSource>,
    piece_model: Option<ModelSource>,
    board_config: BoardDetectorConfig,
    piece_config: PieceRecognizerConfig,
    session_config: SessionConfig,
}

impl XqVisionBuilder {
    #[must_use]
    pub fn board_model(mut self, model: impl Into<ModelSource>) -> Self {
        self.board_model = Some(model.into());
        self
    }

    #[must_use]
    pub fn piece_model(mut self, model: impl Into<ModelSource>) -> Self {
        self.piece_model = Some(model.into());
        self
    }

    #[must_use]
    pub fn board_config(mut self, config: BoardDetectorConfig) -> Self {
        self.board_config = config;
        self
    }

    #[must_use]
    pub fn piece_config(mut self, config: PieceRecognizerConfig) -> Self {
        self.piece_config = config;
        self
    }

    #[must_use]
    pub fn session_config(&self) -> &SessionConfig { &self.session_config }

    #[must_use]
    pub fn with_session_config(mut self, config: SessionConfig) -> Self {
        self.session_config = config;
        self
    }

    #[must_use]
    pub fn provider_failure(mut self, failure: ProviderFailure) -> Self {
        self.session_config = self.session_config.with_provider_failure(failure);
        self
    }

    #[must_use]
    pub fn graph_optimization(mut self, level: GraphOptimization) -> Self {
        self.session_config = self.session_config.with_graph_optimization(level);
        self
    }

    #[must_use]
    pub fn intra_threads(mut self, threads: usize) -> Self {
        self.session_config = self.session_config.with_intra_threads(threads);
        self
    }

    #[must_use]
    pub fn inter_threads(mut self, threads: usize) -> Self {
        self.session_config = self.session_config.with_inter_threads(threads);
        self
    }

    #[must_use]
    pub fn parallel_execution(mut self, enabled: bool) -> Self {
        self.session_config = self.session_config.with_parallel_execution(enabled);
        self
    }

    pub fn build(self) -> Result<XqVision> {
        let board_model = self.board_model.ok_or(XqVisionError::MissingModel { role: "board" })?;
        let piece_model = self.piece_model.ok_or(XqVisionError::MissingModel { role: "piece" })?;
        let board_detector = BoardDetector::with_config(board_model, self.board_config, self.session_config.clone())?;
        let piece_recognizer = PieceRecognizer::with_config(piece_model, self.piece_config, self.session_config)?;
        Ok(XqVision { board_detector, piece_recognizer })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn builder_requires_board_model() {
        let result = XqVision::builder().piece_model(ModelSource::memory([1_u8])).build();
        assert!(matches!(result, Err(XqVisionError::MissingModel { role: "board" })));
    }

    #[test]
    fn builder_requires_piece_model() {
        let result = XqVision::builder().board_model(ModelSource::memory([1_u8])).build();
        assert!(matches!(result, Err(XqVisionError::MissingModel { role: "piece" })));
    }
}