---

新版

版本 v.1.0 包含了一次重大重构。主要变更包括：

• 所有深度学习模型仅支持 PyTorch。
• 支持来自 Hugging Face Hub 的更多微调模型（Bert、RobertA、LayoutLM、LiLT 等）。
• 拆分为多个小型子包：dd-core、dd-datasets 和 deepdoctection。
• 核心数据结构的类型验证。
• 新的测试套件。

---

用于文档理解的软件包

deepdoctection 是一个 Python 库，用于编排扫描和 PDF 文档的布局分析、OCR 以及文档和标记分类。您可以为自己的文档提取任务构建并运行流水线，开发自定义的文档提取工作流，微调预训练模型，并无缝地将其用于推理。

概述

• 使用 Detectron2 和 Transformers 在 PyTorch 中进行文档布局分析和表格识别，
• OCR 支持 Tesseract、DocTr 和 AWS Textract，
• 使用 LayoutLM 系列、LiLT 以及许多基于 Bert 风格的模型进行文档和标记分类，这些模型还包括滑动窗口等功能。
• 使用 pdfplumber 对原生 PDF 进行文本挖掘，
• 基于 Transformer 的 papluca/xlm-roberta-base-language-detection 进行语言检测。
• 使用 jdeskew 或 Tesseract 对图像进行去倾斜和旋转处理。
• 微调目标检测、文档或标记分类模型，并评估整个流水线。
• 多个 教程

请查看 入门笔记本，以便快速上手。

有关最新更新，请参阅 发布说明。

---

Hugging Face Space 演示

在 🤗 Hugging Face spaces 上查看带有 OCR 的文档布局分析流水线演示。

---

示例

以下示例展示了如何使用内置分析器将 PDF 文档分解为其布局结构。

import deepdoctection as dd
from IPython.core.display import HTML
from matplotlib import pyplot as plt

analyzer = dd.get_dd_analyzer()  # 实例化与 Hugging Face space 演示类似的内置分析器

df = analyzer.analyze(path = "/path/to/your/doc.pdf")  # 设置流水线
df.reset_state()                 # 触发一些初始化

doc = iter(df)
page = next(doc) 

image = page.viz(show_figures=True, show_residual_layouts=True)
plt.figure(figsize = (25,17))
plt.axis('off')
plt.imshow(image)

HTML(page.tables[0].html)

print(page.text)

---

要求

• Python >= 3.10
• PyTorch >= 2.6
• 若要微调模型，建议使用 GPU。

---

安装

我们建议使用虚拟环境。

快速安装

对于只需使用默认设置解析文档的简单配置，请安装以下内容：

uv pip install timm  # 默认配置所需
uv pip install transformers
uv pip install python-doctr
uv pip install deepdoctection

此配置足以运行 入门笔记本。

完整安装

以下安装将为您提供一个通用的配置，以便您可以尝试各种不同的设置。请记住，您始终需要单独安装 PyTorch。

首先，由于 Detectron2 不通过 PyPI 发布，因此需要单独安装。请参考 此处 的说明，或尝试：

uv pip install --no-build-isolation detectron2@git+https://github.com/deepdoctection/detectron2.git

然后安装包含所有依赖项的 deepdoctection：

uv pip install deepdoctection[full]

使用 Conda 或 Mamba 安装

您可以使用 Conda 或 Mamba 通过提供的 environment.yml 文件来安装 deepdoctection：

# 使用 conda
conda env create -f environment.yml
conda activate deepdoctection

# 使用 mamba（更快）
mamba env create -f environment.yml
mamba activate deepdoctection

有关更多信息，请参阅 完整安装指南。

从源代码安装

您可以下载仓库或通过以下命令克隆：

git clone https://github.com/deepdoctection/deepdoctection.git

最简单的方式是使用 make 进行安装。需要虚拟环境：

make install-dd

从 Docker Hub 运行 Docker 容器

预先存在的 Docker 镜像可以从 Docker Hub 下载。

此外，还需指定一个工作目录，用于将待处理的文件挂载到容器中。

docker compose up -d

将启动容器。不过，目前尚未暴露任何端点。

---

致谢

我们感谢所有提供高质量代码和预训练模型的开源库。如果没有它们，开发本框架将是不可能的。

如果你喜欢 deepdoctection……

……你可以通过让更多人了解该项目来轻松支持它。留下一颗星或推荐一下都会有所帮助。

许可证

本项目采用 Apache 2.0 许可证进行分发。更多信息请参阅 LICENSE 文件。

deepdoctection 快速上手指南

deepdoctection 是一个用于文档理解的 Python 库，能够编排扫描版和 PDF 文档的布局分析、OCR（光学字符识别）以及文档/令牌分类任务。它基于 PyTorch，集成了 Detectron2、Transformers、Tesseract 等主流工具，帮助用户快速构建文档提取工作流。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统: Linux, macOS 或 Windows (推荐 Linux)
• Python 版本: >= 3.10
• PyTorch 版本: >= 2.6
• 硬件建议: 如果需要进行模型微调（Fine-tuning），强烈建议使用 GPU；仅进行推理任务可使用 CPU。

注意：PyTorch 需要单独安装，未包含在默认依赖中。

安装步骤

推荐使用虚拟环境（如 venv 或 conda）进行隔离安装。

1. 基础安装（推荐新手）

如果您只需要使用默认配置解析文档，运行以下命令即可。此配置足以运行官方入门教程。

uv pip install timm
uv pip install transformers
uv pip install python-doctr
uv pip install deepdoctection

(注：如果您使用国内网络环境较慢，可添加 -i https://pypi.tuna.tsinghua.edu.cn/simple 参数加速下载)

2. 完整安装（高级用户）

如果您需要实验不同的配置或使用对象检测功能，需先单独安装 Detectron2，然后安装完整版的 deepdoctection。

第一步：安装 Detectron2 由于 Detectron2 未通过 PyPI 分发，需从源码安装：

uv pip install --no-build-isolation detectron2@git+https://github.com/deepdoctection/detectron2.git

第二步：安装 deepdoctection 全量依赖

uv pip install deepdoctection[full]

3. 使用 Conda/Mamba 安装

项目提供了 environment.yml 文件，可通过以下命令一键创建环境：

# 使用 conda
conda env create -f environment.yml
conda activate deepdoctection

# 或使用 mamba (速度更快)
mamba env create -f environment.yml
mamba activate deepdoctection

基本使用

以下示例展示了如何使用内置的分析器将 PDF 文档分解为布局结构，并可视化结果。

import deepdoctection as dd
from IPython.core.display import HTML
from matplotlib import pyplot as plt

# 实例化内置分析器（类似 Hugging Face Space 演示中的配置）
analyzer = dd.get_dd_analyzer()

# 设置管道并分析文档 (请替换为您的实际 PDF 路径)
df = analyzer.analyze(path="/path/to/your/doc.pdf")

# 触发初始化
df.reset_state()

# 获取文档迭代器并读取第一页
doc = iter(df)
page = next(doc)

# 可视化页面布局
image = page.viz(show_figures=True, show_residual_layouts=True)
plt.figure(figsize=(25, 17))
plt.axis('off')
plt.imshow(image)
plt.show()

# 提取表格为 HTML 格式
HTML(page.tables[0].html)

# 提取纯文本内容
print(page.text)

运行上述代码后，您将看到带有布局标注的文档图像，并可分别获取结构化的表格数据和提取后的文本内容。