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…

38.8K ·GitHub
Tesseract.js
Что это такое?Tesseract.js — это библиотека OCR на чистом JavaScript, которая извлекает текст из изображений на более чем 100 языках и работает на движке Tesseract, скомпилированном в WebAssembly.
Это самостоятельное приложение или библиотека, которую я подключаю к своему проекту?Это библиотека на JavaScript, которую вы устанавливаете и импортируете в свой код, а не самостоятельное приложение; она опубликована в npm под названием 'tesseract.js'.
Как добавить её в проект?Установите командой '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 или обычный script-тег с CDN), и на сервере с Node.js.
Сколько языков может распознавать текст?Tesseract.js может извлекать слова из изображений на более чем 100 языках, так как он оборачивает многоязычный движок Tesseract OCR.
Можно ли выполнять OCR для видео в реальном времени или с веб-камеры?В README есть ссылка на отдельную демонстрацию распознавания в реальном времени наряду со стандартной демонстрацией распознавания изображений, так что OCR для живого видеопотока поддерживается как сценарий использования.
Как собирается и тестируется проект?Репозиторий собирается через webpack и rollup ('npm run build') и запускает тесты для браузера и Node.js командой 'npm test'; CI настроен через CodeQL и workflow Node.js в GitHub Actions.
What are similar projects?tesseract, supertonic, lodash, tfjs, transformers.js, pglite, squoosh, ua-parser-js
Which topics is it in?tesseract, cdn, esm, text-processing, webassembly, image, webpack, ocr, wasm, multilingual, real-time, image-processing
Creator
naptha
Size
106.7 MB
Stars
38.8K
Updated
CommitMay 17Releasev7.0.0Dec 15
Age
11y
Commits · 90 Days