Metadata-Version: 2.1
Name: rapid-layout
Version: 0.0.18
Summary: Tools for document layout analysis based ONNXRuntime.
Home-page: https://github.com/RapidAI/RapidStructure
Author: SWHL
Author-email: liekkaskono@163.com
License: Apache-2.0
Keywords: ppstructure,layout,rapidocr,rapid_layout
Platform: Any
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.6,<=3.11
Description-Content-Type: text/markdown
Requires-Dist: onnxruntime (>=1.7.0)
Requires-Dist: PyYAML (>=6.0)
Requires-Dist: opencv-python (>=4.5.1.48)
Requires-Dist: numpy (>=1.21.6)
Requires-Dist: Pillow

## rapid-layout
<p align="left">
    <a href=""><img src="https://img.shields.io/badge/Python->=3.6,<=3.11-aff.svg"></a>
    <a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Win%2C%20Mac-pink.svg"></a>
    <a href="https://pypi.org/project/rapid-layout/"><img alt="PyPI" src="https://img.shields.io/pypi/v/rapid-layout"></a>
    <a href="https://pepy.tech/project/rapid-layout"><img src="https://static.pepy.tech/personalized-badge/rapid-layout?period=total&units=abbreviation&left_color=grey&right_color=blue&left_text=Downloads"></a>
</p>


### 1. Install package by pypi.
```bash
$ pip install rapid-layout
```

### 2. Run by script.
- RapidLayout has the default `model_path` value, you can set the different value of `model_path` to use different models, e.g. `layout_engine = RapidLayout(model_path='layout_publaynet.onnx')`
- See details, for [README_Layout](https://github.com/RapidAI/RapidStructure/blob/main/docs/README_Layout.md) .
- 📌 `layout.png` source: [link](https://github.com/RapidAI/RapidStructure/blob/main/test_images/layout.png)

```python
from rapid_layout import RapidLayout

layout_engine = RapidLayout()

with open('layout.png', 'rb') as f:
    img = f.read()

layout_res, elapse = layout_engine(img)
print(layout_res)
```

### 3. Run by command line.
- Usage:
    ```bash
    $ rapid_layout -h
    usage: rapid_layout [-h] [-v] -img IMG_PATH [-m MODEL_PATH]

    optional arguments:
    -h, --help            show this help message and exit
    -v, --vis             Wheter to visualize the layout results.
    -img IMG_PATH, --img_path IMG_PATH
                            Path to image for layout.
    -m MODEL_PATH, --model_path MODEL_PATH
                            The model path used for inference.
    ```
- Example:
    ```bash
    $ rapid_layout -v -img layout.png
    ```

### 4. Result.
- Return value.
    ```python
    [
        {'bbox': array([321.4160495, 91.53214898, 562.06141263, 199.85522603]), 'label': 'text'},
        {'bbox': array([58.67292211, 107.29000663, 300.25448676, 199.68142]), 'label': 'table_caption'}
    ]
    ```
- Visualize result.
    <div align="center">
        <img src="https://raw.githubusercontent.com/RapidAI/RapidOCR/947c6958d30f47c7c7b016f7dc308f235acec3ee/python/rapid_structure/test_images/layout_result.jpg" width="80%" height="80%">
    </div>
