A look at facebookresearch/nougat: 10.1k stars on GitHub, written primarily in Python. Implementation of Nougat Neural Optical Understanding for Academic Documents
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Note, on Windows: If you want to utilize a GPU, make sure you first install the correct PyTorch version. Follow instructions here
There are extra dependencies if you want to call the model from an API or generate a dataset.
Install via
pip install "nougat-ocr[api]" or pip install "nougat-ocr[dataset]"
Get prediction for a PDF
CLI
To get predictions for a PDF run
$ nougat path/to/file.pdf -o output_directory
A path to a directory or to a file where each line is a path to a PDF can also be passed as a positional argument
$ nougat path/to/directory -o output_directory
usage: nougat [-h] [--batchsize BATCHSIZE] [--checkpoint CHECKPOINT] [--model MODEL] [--out OUT]
[--recompute] [--markdown] [--no-skipping] pdf [pdf ...]
positional arguments:
pdf PDF(s) to process.
options:
-h, --help show this help message and exit
--batchsize BATCHSIZE, -b BATCHSIZE
Batch size to use.
--checkpoint CHECKPOINT, -c CHECKPOINT
Path to checkpoint directory.
--model MODEL_TAG, -m MODEL_TAG
Model tag to use.
--out OUT, -o OUT Output directory.
--recompute Recompute already computed PDF, discarding previous predictions.
--full-precision Use float32 instead of bfloat16. Can speed up CPU conversion for some setups.
--no-markdown Do not add postprocessing step for markdown compatibility.
--markdown Add postprocessing step for markdown compatibility (default).
--no-skipping Don't apply failure detection heuristic.
--pages PAGES, -p PAGES
Provide page numbers like '1-4,7' for pages 1 through 4 and page 7. Only works for single PDFs.
The default model tag is 0.1.0-small. If you want to use the base model, use 0.1.0-base.
In the output directory every PDF will be saved as a .mmd file, the lightweight markup language, mostly compatible with Mathpix Markdown (we make use of the LaTeX tables).
Note: On some devices the failure detection heuristic is not working properly. If you experience a lot of [MISSING_PAGE] responses, try to run with the --no-skipping flag. Related: #11, #67
API
With the extra dependencies you use app.py to start an API. Call
$ nougat_api
To get a prediction of a PDF file by making a POST request to http://127.0.0.1:8503/predict/. It also accepts parameters start and stop to limit the computation to select page numbers (boundaries are included).
The response is a string with the markdown text of the document.
Note that the .mmd and .json files in the path/paired/output (here images) are no longer required.
This can be useful for pushing to a S3 bucket by halving the amount of files.
To get the results for the different text modalities, run
python -m nougat.metrics path/to/results.json
FAQ
Why am I only getting [MISSING_PAGE]?
Nougat was trained on scientific papers found on arXiv and PMC. Is the document you're processing similar to that?
What language is the document in? Nougat works best with English papers, other Latin-based languages might work. Chinese, Russian, Japanese etc. will not work.
If these requirements are fulfilled it might be because of false positives in the failure detection, when computing on CPU or older GPUs (#11). Try passing the --no-skipping flag for now.
Where can I download the model checkpoint from.
They are uploaded here on GitHub in the release section. You can also download them during the first execution of the program. Choose the preferred preferred model by passing --model 0.1.0-{base,small}
Citation
@misc{blecher2023nougat,
title={Nougat: Neural Optical Understanding for Academic Documents},
author={Lukas Blecher and Guillem Cucurull and Thomas Scialom and Robert Stojnic},
year={2023},
eprint={2308.13418},
archivePrefix={arXiv},
primaryClass={cs.LG}
}
Acknowledgments
This repository builds on top of the Donut repository.
How active is development on facebookresearch/nougat?
The most recent commit recorded on facebookresearch/nougat was 1.7 years ago, based on the GitHub push timestamp. The repository has 632 forks — one of the better signals of community interest.
How many stars does facebookresearch/nougat have?
facebookresearch/nougat has 10.1k GitHub stars — refresh the page for the live number, or check github.com/facebookresearch/nougat. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is facebookresearch/nougat open source?
Yes — facebookresearch/nougat ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/facebookresearch/nougat.
What is facebookresearch/nougat?
facebookresearch/nougat (facebookresearch/nougat) is a Python project on GitHub. From the project's own README: Implementation of Nougat Neural Optical Understanding for Academic Documents
Where do I read more about facebookresearch/nougat?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/facebookresearch/nougat is the definitive source.
Read full README in the tab above.
Want a second opinion on nougat?
Ask an AI that can read this page — one click and you get its take on nougat.