docs(core): 为 ddddocr-core 全量补充并精简 Rustdoc 文档

This commit is contained in:
2026-08-05 17:40:32 +08:00
parent 84cc97b201
commit 0bddaeba24
17 changed files with 130 additions and 121 deletions

View File

@@ -1,3 +1,5 @@
//! OCR 模型元数据:归一化、缩放策略与模型信息。
// =====================================================================
// 1. 辅助定义的枚举与结构体
// =====================================================================
@@ -5,6 +7,7 @@
use crate::ocr::Charset;
use std::borrow::Cow;
/// 像素归一化策略。
#[derive(Debug, Clone, Copy)]
pub enum Normalization {
/// 映射到 [0.0, 1.0] -> pixel / 255.0
@@ -14,7 +17,6 @@ pub enum Normalization {
}
impl Normalization {
/// 统一归一化计算逻辑
#[inline(always)]
pub fn normalize(&self, pixel: f32) -> f32 {
match self {
@@ -35,17 +37,15 @@ pub enum Resize {
Square(u32),
}
/// OCR 模型元数据:字符集、缩放策略、通道数与归一化配置。
#[derive(Debug, Clone)]
pub struct ModelMetadata {
/// 字符集管理器
pub charset: Charset,
/// 是否为单字识别模型
pub word: bool,
/// 预处理的缩放策略
pub resize: Resize,
/// 图像通道数 (1 或 3)
/// 图像通道数1 或 3
pub channel: u8,
/// 新增:传递给核心业务使用的归一化配置
pub normalization: Normalization,
}
@@ -66,7 +66,7 @@ impl ModelMetadata {
}
}
// --- 优雅的工厂模式构造器 ---
/// 通用的静态切片转换构造器
/// 从静态字符切片构建元数据并自动生成字符集。
pub fn from_static_slice(
slice: &[&'static str],
word: bool,