Skip to main content

NUM Miner (Tool to create open dataset for Handwritten Text Recognition)

Project description

NUMiner

Build Status security: bandit PyPI version Coverage Status Code style: black

InstallationHow To UseContributingLicense

This is a Python library that creates training images for Handwritten Text Recognition or HTR related researches

Installation

Use the package manager pip to install numiner.

pip install numiner

How To Use

In general, the package has two main modes. One is sheet and another one is letter.

sheet - takes a path called <source> to a folder that's holding all the scanned sheet images or an actual image path and saves the processed images in the <result> path

$ numiner -s/--sheet <source> <result>

letter - takes a path called <source> to a folder that's holding all the cropped raw images or an actual image path and saves the processed images in the <result> path

$ numiner -l/--letter <source> <result>

Also you can override the default sheet labels by giving json file:

$ numiner -c path/to/labels.json -s path/to/source path/to/result

For sure you can also do this:

$ numiner --help

usage: numiner [-h] [-v] [-s <source> <result>] [-l <source> <result>] [-c <path>]

optional arguments:
  -h, --help                    show this help message and exit
  -v, --version                 show program's version number and exit
  -s/--sheet <source> <result>  a path to a folder or file that's holding the <source>
                                sheet image(s) & a path to a folder where all <result>
                                images will be saved
  -l/--letter <source> <result> a path to a folder or a file that's holding the cropped
                                image(s) & a path to a folder where all <result> images
                                will be saved
  -c <path>                     a path to .json file that's holding top to bottom, left
                                to right labels of the sheet with their ids

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

numiner-0.1.2.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

numiner-0.1.2-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file numiner-0.1.2.tar.gz.

File metadata

  • Download URL: numiner-0.1.2.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.2 Darwin/19.4.0

File hashes

Hashes for numiner-0.1.2.tar.gz
Algorithm Hash digest
SHA256 78620fed2dfd09e758eaa69bf9c37cf6a18f21776cd6e9a00c2a9c183c00a16b
MD5 7b39692b48273e10e0115471b6cf1531
BLAKE2b-256 3a98f5ec3d0757ce504d16bdc72746b6554c0dbf8ed1561fc3fee3fc825f9d13

See more details on using hashes here.

File details

Details for the file numiner-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: numiner-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.2 Darwin/19.4.0

File hashes

Hashes for numiner-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 14efa6df904580f28e6086f43d0dd3fe66f28cd8ecfee95d8fcc16a5d03bc9f2
MD5 93974ee7234fc731365ffb5a950f76f8
BLAKE2b-256 87a5a7e19f4377761b5a775e655fb8c3fc6830c7d0a2463c9bffe142f964d06c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page