Layout-Parser /layout-parser
A Unified Toolkit for Deep Learning Based Document Image Analysis
★ 5,779⑂ 527👁 74⑃ 67● 155▤ 10
+0
Daily
5,779
stars
527
forks
74
watchers
67
prs
155
issues
10
releases
README
A unified toolkit for Deep Learning Based Document Image Analysis
---
What is LayoutParser
!Example Usage
LayoutParser aims to provide a wide range of tools that aims to streamline Document Image Analysis (DIA) tasks. Please check the LayoutParser demo video (1 min) or full talk (15 min) for details. And here are some key features:
- LayoutParser provides a rich repository of deep learning models for layout detection as well as a set of unified APIs for using them. For example,
Perform DL layout detection in 4 lines of code
python
import layoutparser as lp
model = lp.AutoLayoutModel('lp://EfficientDete/PubLayNet')
image = Image.open("path/to/image")
layout = model.detect(image)
- LayoutParser comes with a set of layout data structures with carefully designed APIs that are optimized for document image analysis tasks. For example,
Selecting layout/textual elements in the left column of a page
python
image_width = image.size[0]
left_column = lp.Interval(0, image_width/2, axis='x')
layout.filter_by(left_column, center=True) select objects in the left column
Performing OCR for each detected Layout Region
python
ocr_agent = lp.TesseractAgent()
for layout_region in layout:
image_segment = layout_region.crop(image)
text = ocr_agent.detect(image_segment)
Flexible APIs for visualizing the detected layouts
python
lp.draw_box(image, layout, box_width=1, show_element_id=True, box_alpha=0.25)
Loading layout data stored in json, csv, and even PDFs
python
layout = lp.load_json("path/to/json")
layout = lp.load_csv("path/to/csv")
pdf_layout = lp.load_pdf("path/to/pdf")
- LayoutParser is also a open platform that enables the sharing of layout detection models and DIA pipelines among the community.
Check the LayoutParser open platform
Submit your models/pipelines to LayoutParser
Installation
After several major updates, layoutparser provides various functionalities and deep learning models from different backends. But it still easy to install layoutparser, and we designed the installation method in a way such that you can choose to install only the needed dependencies for your project:
bash
pip install layoutparser Install the base layoutparser library with
pip install "layoutparser[layoutmodels]" Install DL layout model toolkit
pip install "layoutparser[ocr]" Install OCR toolkit
Extra steps are needed if you want to use Detectron2-based models. Please check installation.md for additional details on layoutparser installation.
Examples
We provide a series of examples for to help you start using the layout parser library:
1. Table OCR and Results Parsing: layoutparser can be used for conveniently OCR documents and convert the output in to structured data.
2. Deep Layout Parsing Example: With the help of Deep Learning, layoutparser supportTop issues
#7conflicting dependencies37 comments · 2021-01-29#168AssertError: Checkpoint /home/ec2-user/.torch/iopath_cache/s/dgy9c10wykk4lq4/model_final.pth not found!23 comments · 2023-01-04#15Cannot run the model on Windows. 21 comments · 2021-04-09#218Detectron2 Installation issue9 comments · 2024-10-14#140OSError: [Errno 22] on Detectron2LayoutModel()9 comments · 2022-05-24#34Intersect operation9 comments · 2021-04-21#187AttributeError: module 'PIL.Image' has no attribute 'LINEAR'6 comments · 2023-07-24#180_pickle.UnpicklingError: invalid load key, '<'.6 comments · 2023-04-18
Discussions
#221Layout Parser installation error0 comments · 2025-01-01#219The final result is not good.0 comments · 2024-11-26#211Convert app to exe0 comments · 2024-05-20#197Extract tabular data from large set of individual PDF's0 comments · 2023-09-04#150How to train on custom Dataset?0 comments · 2022-08-25#130v0.3.3: Patch Release0 comments · 2022-04-03#127Changing the main branch name to `main`0 comments · 2022-04-02#126Share and discuss your ideas about LayoutParser!1 comments · 2022-04-02
Latest release
v0.3.4: Patch Release v0.3.4 2022-04-06Bug fixes fix one critical bug for visualization mentioned in 131 by @lolipopshock in https://github.com/Layout-Parser/layout-parser/pull/132 Full Changelog: https://github.com/Layout-Parser/layout-parser/compare/v0.3.3...v0.3.4