Tesseract Open Source OCR Engine (main repository)
Go to file
Stefan Weil 981c167f8c Improve result message from lstmeval
Old message:

    At iteration 0, stage 0, BCER eval=2.553356, BWER eval=5.586173

New message:

    BCER eval=2.553356, BWER eval=5.586173

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2021-11-17 09:02:49 +01:00
.github Remove spaces at line endings and empty last lines 2021-11-13 22:45:47 +01:00
cmake cmake: Improve configuration 2021-09-24 22:15:46 +02:00
doc combine_tessdata: Print "Version:" instead of "Version string:" 2021-11-14 16:38:52 +01:00
include/tesseract Improve the disable legacy build (#3627) 2021-11-04 18:26:15 +02:00
java Fix some typos (most found by codespell) 2021-04-11 11:06:36 +02: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 Improve result message from lstmeval 2021-11-17 09:02:49 +01:00
tessdata remove legacy parameter disable_character_fragments from lstm.train 2019-10-23 13:15:16 +02:00
test@3ea1099664 Update test submodule 2021-09-05 21:37:34 +02:00
unittest pagesegmode_test.cc: Disable some code for disable legacy build (#3626) 2021-11-04 12:49:32 +01:00
.clang-format clang-format: Clean formatting rules 2021-04-07 18:53:24 +02:00
.gitattributes Create .gitattributes for cross os contributors 2020-10-17 11:23:42 +05:30
.gitignore [gitignore] Ignore some local dirs. 2021-01-02 16:47:47 +03:00
.gitmodules Move googletest to unittest/third_party/googletest 2021-11-01 11:50:50 +01:00
.lgtm.yml Use Python3 for LGTM 2018-11-30 07:11:53 +01:00
.travis.yml Remove spaces at line endings and empty last lines 2021-11-13 22:45:47 +01:00
appveyor.yml [ci] Copy fonts to testdir. 2021-01-05 21:23:35 +03:00
AUTHORS Update AUTHORS 2021-04-11 20:13:58 +03:00
autogen.sh Update autogen.sh 2019-12-04 22:38:09 +01:00
ChangeLog Create new release 5.0.0-rc2 2021-11-14 20:04:23 +01:00
CMakeLists.txt Remove spaces at line endings and empty last lines 2021-11-13 22:45:47 +01:00
configure.ac Create new release 5.0.0-rc2 2021-11-14 20:04:23 +01:00
CONTRIBUTING.md unittest: Remove dependency on absl::StripAsciiWhitespace() 2021-08-06 20:59:10 +02:00
docker-compose.yml Dockerifying using travis build script 2016-03-18 00:32:35 -04:00
Dockerfile Update Dockerfile 2020-12-07 11:33:09 -06:00
INSTALL Fix file endings 2018-04-25 19:35:33 +02:00
INSTALL.GIT.md Update piccolo2d-core and piccolo2d-extras 2020-02-23 16:28:08 +01:00
LICENSE Added missing license headers 2016-11-18 15:53:11 -08:00
Makefile.am Don't use compiler flags -march=native -mtune=native in autoconf builds 2021-11-11 12:29:51 +01:00
README.md README: Remove the reference to version 3.05.02 2021-11-03 17:53:13 +01:00
sw.cpp Move googletest to unittest/third_party/googletest 2021-11-01 11:50:50 +01:00
tesseract.pc.cmake Add missing libraries in configuration for pkg-config 2019-11-02 19:00:05 +01:00
tesseract.pc.in Add missing libraries in configuration for pkg-config 2019-11-02 19:00:05 +01:00
VERSION Create new release 5.0.0-rc2 2021-11-14 20:04:23 +01:00

Tesseract OCR

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

Table of Contents

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, invisible-text-only PDF, TSV. The main branch also has experimental support for ALTO (XML) output.

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 documentation.

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. From 2006 until November 2018 it was developed by Google.

The latest (LSTM based) stable version is 4.1.1, released on December 26, 2019. Latest source code is available from main branch on GitHub. Open issues can be found in issue tracker, and planning documentation.

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.

C++17 support is required for building.

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.

Examples can be found in the documentation.

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 in the AddOns documentation.

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 documentation, 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.

Tesseract uses Leptonica library which essentially uses a BSD 2-clause license.

Dependencies

Tesseract uses Leptonica library for opening input images (e.g. not documents like pdf). It is suggested to use leptonica with built-in support for zlib, png and tiff (for multipage tiff).

Latest Version of README

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

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