tesseract.js README

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

Tesseract.js

Lint & Test CodeQL Gitpod Ready-to-Code Financial Contributors on Open Collective npm version Maintenance License Code Style npm jsDelivr hits (npm)

Tesseract.js is a javascript library that gets words in almost any language out of images. (Demo)

Image Recognition

fancy demo gif

Video Real-time Recognition

Tesseract.js Video

Tesseract.js works in the browser using webpack, esm, or plain script tags with a CDN and on the server with Node.js. After you install it, using it is as simple as:

import { createWorker } from 'tesseract.js';

(async () => {
  const worker = await createWorker('eng');
  const ret = await worker.recognize('https://tesseract.projectnaptha.com/img/eng_bw.png');
  console.log(ret.data.text);
  await worker.terminate();
})();

When recognizing multiple images, users should create a worker once, run worker.recognize for each image, and then run worker.terminate() once at the end (rather than running the above snippet for every image).

Installation

Tesseract.js works with a <script> tag via local copy or CDN, with webpack via npm and on Node.js with npm/yarn.

CDN

<!-- v5 -->
<script src='https://cdn.jsdelivr.net/npm/tesseract.js@5/dist/tesseract.min.js'></script>

After including the script the Tesseract variable will be globally available and a worker can be created using Tesseract.createWorker.

Alternatively, an ESM build (used with import syntax) can be found at https://cdn.jsdelivr.net/npm/tesseract.js@5/dist/tesseract.esm.min.js.

Node.js

Tesseract.js v7 requires Node.js v16 or newer. (Tesseract.js v6 requires Node.js v14 or newer.)

# For latest version
npm install tesseract.js
yarn add tesseract.js

# For old versions
npm install [email protected]
yarn add [email protected]

Project Scope

Tesseract.js aims to bring the Tesseract OCR engine (a separate project) to the browser and Node.js, and works by wrapping a WebAssembly port of Tesseract. This project does not modify core Tesseract features. Most notably, Tesseract.js does not support PDF files and does not modify the Tesseract recognition model to improve accuracy.

If your project requires features outside of this scope, consider the Scribe.js library. Scribe.js is an alternative library created to accommodate common feature requests that are outside of the scope of this repo. Scribe.js includes improvements to the Tesseract recognition model and supports extracting text from PDF documents, among other features. For more information see Scribe.js vs. Tesseract.js.

Documentation

Community Projects and Examples

The following are examples and projects built by the community using Tesseract.js. Officially supported examples are found in the examples directory.

If you have a project or example repo that uses Tesseract.js, feel free to add it to this list using a pull request. Examples submitted should be well documented such that new users can run them; projects should be functional and actively maintained.

Major changes in v6

Version 6 changes are documented in this issue. Highlights are below.

Major changes in v5

Version 5 changes are documented in this issue. Highlights are below.

Upgrading from v2 to v5? See this guide.

Major changes in v4

Version 4 includes many new features and bug fixes--see this issue for a full list. Several highlights are below.

Contributing

Development

To run a development copy of Tesseract.js do the following:

# First we clone the repository
git clone https://github.com/naptha/tesseract.js.git
cd tesseract.js

# Then we install the dependencies
npm install

# And finally we start the development server
npm start

The development server will be available at http://localhost:3000/examples/browser/basic-efficient.html in your favorite browser. It will automatically rebuild tesseract.min.js and worker.min.js when you change files in the src folder.

Building Static Files

To build the compiled static files just execute the following:

npm run build

This will output the files into the dist directory.

Run Tests

Always confirm the automated tests pass before submitting a pull request. To run the automated tests locally, run the following commands.

npm run lint
npm run test

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

tesseract.js (naptha/tesseract.js)

Searching Database…

这是什么?Tesseract.js 是一个纯 JavaScript 的 OCR(图片文字识别)库,可以从图片中提取文字,支持 100 多种语言。它运行的是编译为 WebAssembly 的 Tesseract 引擎。
这是独立应用,还是可以接入我自己项目的库?它是一个 JavaScript 库,需要你安装并导入到自己的代码中,而不是独立应用;它以 'tesseract.js' 的名字发布在 npm 上。
我要怎样把它加到项目里?用 'npm install tesseract.js' 或 'yarn add tesseract.js' 进行安装,然后只创建一次 worker,再调用 worker.recognize(image),就能从图片中提取文字。
我还需要单独安装原生的 Tesseract OCR 引擎吗?不需要单独安装 Tesseract 的可执行程序;引擎以 WebAssembly 版本(tesseract.js-core)的形式,随 npm 包一起提供。
连续处理很多张图片时,有什么需要注意的地方吗?有。处理多张图片时,应该只创建一个 worker,对每张图片分别调用 worker.recognize(),全部完成后再调用一次 worker.terminate(),而不是为每张图片都新建一个 worker。
它只能在浏览器里运行,还是也能在服务器上用?两种环境都可以用:在浏览器中,可以通过 webpack、ESM,或从 CDN 引入的普通 script 标签使用;在服务器上,可以配合 Node.js 使用。
它能识别多少种语言的文字?Tesseract.js 可以从图片中提取 100 多种语言的文字,因为它封装的是支持多语言的 Tesseract OCR 引擎。
它能对实时视频或摄像头画面做 OCR 吗?README 中链接了一个专门的实时识别演示,与标准图片识别演示并列,因此实时画面的文字识别是受支持的用法。
这个项目是如何构建和测试的?仓库通过 webpack 和 rollup 构建(运行 'npm run build'),并通过 'npm test' 同时运行浏览器端和 Node 端的测试套件;持续集成通过 CodeQL 以及一个 Node.js 的 GitHub Actions 工作流进行配置。
Creator
naptha
Size
106.7 MB
Stars
38.8K
Age
11y
Commits · 90 Days