Layout-Parser /layout-parser

A Unified Toolkit for Deep Learning Based Document Image Analysis

★ 5,779⑂ 527👁 74⑃ 67● 155▤ 10
PythonApache-2.0Created 2020-06-10layout-parser.github.io/
Download: v0.3.4: Patch Releasev0.3.4 ↓0.3.42022-04-06
+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 support

Top issues

Discussions

Latest release

v0.3.4: Patch Release v0.3.4 2022-04-06
Bug 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

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON