Skip to content

Commit

Permalink
Merge pull request #17 from bertsky/improve-readme
Browse files Browse the repository at this point in the history
further improve README
  • Loading branch information
bertsky authored Nov 20, 2019
2 parents 1aff083 + a7dff23 commit 1c66999
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# ocrd_segment

This repository aims to provide a number of OCR-D-compliant processors for layout analysis and evaluation.
This repository aims to provide a number of [OCR-D-compliant processors](https://ocr-d.github.io/cli) for layout analysis and evaluation.

## Installation

In your virtual environment, run:
```bash
pip install .
```

## Usage

- extracting page images (including results from preprocessing like cropping, deskewing or binarization) along with region polygon coordinates and metadata:
- [ocrd-segment-extract-regions](ocrd_segment/extract_regions.py)
Expand All @@ -14,3 +23,9 @@ This repository aims to provide a number of OCR-D-compliant processors for layou
- `ocrd-segment-via-template` :construction: (unpublished)
- data-driven segmentation (input file groups N=1, based on a statistical model, e.g. Neural Network)
- `ocrd-segment-via-model` :construction: (unpublished)

For detailed description on input/output and parameters, see [ocrd-tool.json](ocrd_segment/ocrd-tool.json)

## Testing

None yet.

0 comments on commit 1c66999

Please sign in to comment.