Tesseract Open Source OCR Engine (main repository)
Go to file
James R. Barlow d9ae7ecc49 Pythonize tesstrain.sh -> tesstrain.py
This is a lightweight, semi-Pythonic conversion of tesstrain.sh that currently
supports only LSTM and not the Tesseract 3 training mode.

I attempted to keep source changes minimal so it would be easy to compare
bash to Python in code review and confirm equivalence.

Python 3.6+ is required.  Ubuntu 18.04 ships Python 3.6 and it is a mandatory
package (the package manager is also written in Python), so it is available
in the baseline Tesseract 4.0 system.

There are minor output and behavioral changes, and advantages.  Python's loggingis used.  Temporary files are only deleted on success, so they can be inspected
if training files.  Console output is more terse and the log file is more
verbose.  And there are progress bars!  (The python3-tqdm package is required.)
Where tesstrain.sh would sometimes fail without explanation and return an error
code of 1, it is much easier to find the point of failure in this version.
That was also the main motivation for this work.

Argument checking is also more comprehensive.
2018-11-24 00:45:35 -08:00
.github Fix whitespace issues 2018-08-01 13:19:52 +02:00
abseil@e821380d69 Add Abseil as a submodule (needed for some of the new unit tests) 2018-10-11 22:18:51 +02:00
android Update build rules for Android 2018-05-20 20:50:23 +02:00
cmake Remove tests for function getline 2018-07-19 16:19:58 +02:00
doc add info about unicharambigs file v2; fixes #165 2018-10-21 20:18:48 +02:00
googletest@2fe3bd994b Update googletest submodule to release v1.8.1 2018-10-08 19:54:56 +02:00
java fix building of ScrollView.jar with modern java version; fixes #1289 2018-10-10 10:42:39 +02:00
langtests add langtests for Devanagari and Sanskrit 2018-09-04 04:29:13 +00:00
m4 Remove autoconf-archive dependency 2018-06-30 22:23:22 +02:00
snap Add newline at end of file 2018-09-03 17:13:45 +08:00
src Pythonize tesstrain.sh -> tesstrain.py 2018-11-24 00:45:35 -08:00
tessdata add lstmdebug config to distribution and installation process 2018-10-29 09:38:11 +01:00
test@78281f99df Update test submodule 2018-10-18 19:30:34 +02:00
tests googletest: Add dummy test 2017-07-24 19:45:06 +02:00
unittest unittest: Add more files from Google 2018-10-18 16:39:35 +02:00
unlvtests Fix whitespace issues 2018-08-01 13:19:52 +02:00
.clang-format Update rules for clang-format 2018-07-01 08:11:22 +02:00
.gitignore Pythonize tesstrain.sh -> tesstrain.py 2018-11-24 00:45:35 -08:00
.gitmodules Add Abseil as a submodule (needed for some of the new unit tests) 2018-10-11 22:18:51 +02:00
.lgtm.yml Fix configuration for LGTM 2018-10-19 10:50:11 +02:00
.travis.yml Disable travis os x builds as they do not work well on travis-side. 2017-09-09 21:13:14 +03:00
appveyor.yml Use env variable in AppVeyor configuration 2018-10-09 19:23:40 +02:00
AUTHORS Update AUTHORS 2018-05-08 16:52:32 +03:00
autogen.sh Fix whitespace issues 2018-08-01 13:19:52 +02:00
ChangeLog 4.0.0 Release 2018-10-29 09:53:12 +01:00
CMakeLists.txt Do not build tests by default. 2018-10-14 00:56:42 +03:00
configure.ac 4.0.0 Release 2018-10-29 09:53:12 +01:00
CONTRIBUTING.md Fix whitespace issues 2018-08-01 13:19:52 +02:00
COPYING Result of clang tidy on recent merge 2016-11-07 10:46:33 -08:00
cppan.yml Fix cppan build. 2018-10-15 02:38:56 +03:00
docker-compose.yml Dockerifying using travis build script 2016-03-18 00:32:35 -04:00
Dockerfile Fix and improve Dockerfile 2017-05-18 21:35:53 +02:00
INSTALL Fix file endings 2018-04-25 19:35:33 +02:00
INSTALL.GIT.md adapt info about ScrollView.jar build 2018-10-12 17:56:33 +02:00
LICENSE Added missing license headers 2016-11-18 15:53:11 -08:00
Makefile.am update dist-hook 2018-10-12 20:10:39 +02:00
README.md 4.0.0 Release 2018-10-29 09:53:12 +01:00
tesseract.pc.cmake Require tesseract/ for API header files (fixes potential name conflicts) 2018-06-17 22:01:19 +02:00
tesseract.pc.in improve tesseract.pc.in - fixes #241 2016-03-04 22:25:40 +01:00
VERSION 4.0.0 Release 2018-10-29 09:53:12 +01:00

Tesseract OCR

Build Status Build status
Coverity Scan Build Status Code Quality: Cpp Total Alerts
GitHub license Downloads

About

This package contains an OCR engine - libtesseract and a command line program - tesseract. Tesseract 4 adds a new neural net (LSTM) based OCR engine which is focused on line recognition, but also still supports the legacy Tesseract OCR engine of Tesseract 3 which works by recognizing character patterns. Compatibility with Tesseract 3 is enabled by using the Legacy OCR Engine mode (--oem 0). It also needs traineddata files which support the legacy engine, for example those from the tessdata repository.

The lead developer is Ray Smith. The maintainer is Zdenko Podobny. For a list of contributors see AUTHORS and GitHub's log of contributors.

Tesseract has unicode (UTF-8) support, and can recognize more than 100 languages "out of the box".

Tesseract supports various output formats: plain-text, hocr(html), pdf, tsv, invisible-text-only pdf.

You should note that in many cases, in order to get better OCR results, you'll need to improve the quality of the image you are giving Tesseract.

This project does not include a GUI application. If you need one, please see the 3rdParty wiki page.

Tesseract can be trained to recognize other languages. See Tesseract Training for more information.

Brief history

Tesseract was originally developed at Hewlett-Packard Laboratories Bristol and at Hewlett-Packard Co, Greeley Colorado between 1985 and 1994, with some more changes made in 1996 to port to Windows, and some C++izing in 1998. In 2005 Tesseract was open sourced by HP. Since 2006 it is developed by Google.

The latest stable version is 4.0.0, released on October 29, 2018. Latest source code for 4.0 is available from master branch on GitHub. Open issues can be found in issue tracker, and Planning wiki.

The latest 3.5 version is 3.05.02, released on June 19, 2018. Latest source code for 3.05 is available from 3.05 branch on GitHub. There is no development for this version, but it can be used for special cases (e.g. see Regression of features from 3.0x).

Source code for the new LSTM based 4.0 version is available from the master branch on GitHub. Please note this branch is under active development.

See Release Notes and Change Log for more details of the releases.

Installing Tesseract

You can either Install Tesseract via pre-built binary package or build it from source.

Supported Compilers are:

  • GCC 4.8 and above
  • Clang 3.4 and above
  • MSVC 2015, 2017

Other compilers might work, but are not officially supported.

Running Tesseract

Basic command line usage:

tesseract imagename outputbase [-l lang] [--oem ocrenginemode] [--psm pagesegmode] [configfiles...]

For more information about the various command line options use tesseract --help or man tesseract.

For developers

Developers can use libtesseract C or C++ API to build their own application. If you need bindings to libtesseract for other programming languages, please see the wrapper section on AddOns wiki page.

Documentation of Tesseract generated from source code by doxygen can be found on tesseract-ocr.github.io.

Support

Before you submit an issue, please review the guidelines for this repository.

For support, first read the Wiki, particularly the FAQ to see if your problem is addressed there. If not, search the Tesseract user forum, the Tesseract developer forum and past issues, and if you still can't find what you need, ask for support in the mailing-lists.

Mailing-lists:

Please report an issue only for a bug, not for asking questions.

License

The code in this repository is licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

NOTE: This software depends on other packages that may be licensed under different open source licenses.

Latest Version of README

For the latest online version of the README.md see:

https://github.com/tesseract-ocr/tesseract/blob/master/README.md