tesseract README

The project's README from github.com/tesseract-ocr/tesseract. As one markdown file: README.md.

Tesseract OCR

Coverity Scan Build Status CodeQL 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.

Stefan Weil is the current lead developer. Ray Smith was the lead developer until 2017. 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 image formats including PNG, JPEG and TIFF.

Tesseract supports various output formats: plain text, hOCR (HTML), PDF, invisible-text-only PDF, TSV, ALTO and PAGE.

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 UK and at Hewlett-Packard Co, Greeley Colorado USA 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 August 2017 it was developed by Google.

Major version 5 is the current stable version and started with release 5.0.0 on November 30, 2021. Newer minor versions and bugfix versions are available from GitHub.

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.

Before building Tesseract from source, please check that your system has a compiler which is one of the supported compilers.

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 the 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

tesseract (tesseract-ocr/tesseract)

Searching Database…

77.1K ·GitHub
这是干什么用的?Tesseract 是一个开源的 OCR(光学字符识别)引擎:它以 libtesseract 库的形式发布,外加一个叫 tesseract 的命令行程序,可以从图片里识别出文字。
它有图形界面,还是只有命令行?这个项目本身没有图形界面——你通过 tesseract 命令来使用它,第三方开发的图形界面前端列在 3rdParty 文档里。
装好之后,基本的用法是什么样的?先安装预编译的二进制包或从源码构建,然后运行 tesseract imagename outputbase,还可以选择加上 -l 指定语言,以及 --oem 和 --psm 参数。
它到底是怎么读取我的图片文件的?它借助 Leptonica 库来打开 PNG、JPEG、TIFF 这类输入图片;PDF 之类的文档不是它能直接打开的格式。
我的扫描件质量不太高,识别结果还能干净吗?很多时候不行:想获得更好的 OCR 效果,往往需要先提高喂给它的图片质量。
它能在 Windows、macOS 和 Linux 上运行吗?可以:主流桌面系统都有预编译的二进制包,而且项目的 CI 在 macOS 和 Linux 上用 autotools 构建,在 64 位 Windows 上用 CMake 构建。
它里面的所有内容都用同一个开源许可证吗?Tesseract 的代码采用 Apache License 2.0,但它的依赖各不相同——用于图片输入的 Leptonica 基本上是 BSD 2-clause 许可证。
它开箱即用能识别多少种语言?支持 100 多种语言,并且支持 unicode(UTF-8);你还可以训练 Tesseract 来识别更多的语言。
我能得到哪些输出格式?纯文本、hOCR(HTML)、PDF、仅含不可见文字的 PDF、TSV、ALTO 和 PAGE。
LSTM 引擎和旧版引擎有什么区别?Tesseract 4 新增了基于神经网络的(LSTM)引擎,主打整行识别;旧版 Tesseract 3 引擎则按字符模式进行识别,需要用 --oem 0 并搭配支持旧引擎的 traineddata 文件来启用。
我能从 Python 或其他语言调用它吗?可以,通过封装来实现:libtesseract 提供了 C 和 C++ API,其他语言的绑定列在 AddOns 文档里。
Size
53.6 MB
Stars
77.1K
Age
12y
Commits · 90 Days