tesseract.js is a JavaScript library that provides Optical Character Recognition (OCR) capabilities. It allows you to extract text from images and PDFs directly in the browser or in a Node.js environment.
What are tesseract.js's main functionalities?
Basic OCR
This feature allows you to perform basic OCR on an image file. The code sample demonstrates how to recognize text from an image using the English language.
This feature allows you to recognize text in multiple languages. The code sample demonstrates how to recognize text from an image using both English and Spanish languages.
This feature allows you to use a worker for better performance, especially for large images or multiple OCR tasks. The code sample demonstrates how to create a worker, load the necessary language, perform OCR, and then terminate the worker.
ocrad.js is a JavaScript port of the OCRAD OCR library. It is designed to be used in the browser and can recognize text from images. Compared to tesseract.js, ocrad.js is lighter but may not be as accurate or feature-rich.
node-tesseract-ocr is a Node.js wrapper for the Tesseract OCR engine. It provides a simpler interface for performing OCR in Node.js environments. While it offers similar functionalities to tesseract.js, it does not support browser usage.
Tesseract.js is a javascript library that gets words in almost any language out of images. (Demo)
Image Recognition
Video Real-time Recognition
Tesseract.js wraps a webassembly port of the Tesseract OCR Engine.
It 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:
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.
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 v5
Version 5 changes are documented in this issue. Highlights are below.
Significantly smaller files by default (54% smaller for English, 73% smaller for Chinese)
This results in a ~50% reduction in runtime for first-time users (who do not have the files cached yet)
Significantly lower memory usage
Compatible with iOS 17 (using default settings)
Breaking changes:
createWorker arguments changed
Setting non-default language and OEM now happens in createWorker
E.g. createWorker("chi_sim", 1)
worker.initialize and worker.loadLanguage functions now do nothing and can be deleted from code
Version 4 includes many new features and bug fixes--see this issue for a full list. Several highlights are below.
Added rotation preprocessing options (including auto-rotate) for significantly better accuracy
Processed images (rotated, grayscale, binary) can now be retrieved
Improved support for parallel processing (schedulers)
Breaking changes:
createWorker is now async
getPDF function replaced by pdf recognize option
Major changes in v3
Significantly faster performance
Runtime reduction of 84% for Browser and 96% for Node.js when recognizing the example images
Upgrade to Tesseract v5.1.0 (using emscripten 3.1.18)
Added SIMD-enabled build for supported devices
Added support:
Node.js version 18
Removed support:
ASM.js version, any other old versions of Tesseract.js-core (<3.0.0)
Node.js versions 10 and 12
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
You can use Gitpod(A free online VS Code like IDE) for contributing. With a single click it will launch a ready to code workspace with the build & start scripts already in process and within a few seconds it will spin up the dev server so that you can start contributing straight away without wasting any time.
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.
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]
FAQs
Pure Javascript Multilingual OCR
The npm package tesseract.js receives a total of 103,991 weekly downloads. As such, tesseract.js popularity was classified as popular.
We found that tesseract.js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 4 open source maintainers collaborating on the project.
Package last updated on 24 Aug 2024
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.