mirrors/docling
1
0
Fork 0
mirror of https://github.com/DS4SD/docling.git synced 2025-07-27 04:24:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update README

Browse Source 
Signed-off-by: Panos Vagenas <35837085+vagenas@users.noreply.github.com>
This commit is contained in:
Panos Vagenas 2024-09-09 11:27:46 +02:00
parent 6f1811e050
commit dc107fd87a
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -24,7 +24,7 @@ Docling bundles PDF document conversion to JSON and Markdown in an easy, self-co
* 📝 Extracts metadata from the document, such as title, authors, references and language * 📝 Extracts metadata from the document, such as title, authors, references and language
* 🔍 Optionally applies OCR (use with scanned PDFs) * 🔍 Optionally applies OCR (use with scanned PDFs)
Doing RAG or Q/A? Also consider [Quackling](https://github.com/DS4SD/quackling) to get the most out of your documents. For RAG, check out [Quackling](https://github.com/DS4SD/quackling) to get the most out of your docs, be it using LlamaIndex, LangChain or your pipeline.
## Installation ## Installation
@ -144,6 +144,10 @@ results = doc_converter.convert(conv_input)
You can limit the CPU threads used by Docling by setting the environment variable `OMP_NUM_THREADS` accordingly. The default setting is using 4 CPU threads. You can limit the CPU threads used by Docling by setting the environment variable `OMP_NUM_THREADS` accordingly. The default setting is using 4 CPU threads.
## Technical report
For more details on Docling's inner workings, check out the [Docling Technical Report](https://arxiv.org/abs/2408.09869).
## Contributing ## Contributing
Please read [Contributing to Docling](https://github.com/DS4SD/docling/blob/main/CONTRIBUTING.md) for details. Please read [Contributing to Docling](https://github.com/DS4SD/docling/blob/main/CONTRIBUTING.md) for details.
@ -155,14 +159,14 @@ If you use Docling in your projects, please consider citing the following:
```bib ```bib
@techreport{Docling, @techreport{Docling,
author = {Deep Search Team}, author = "Deep Search Team",
month = {8}, month = 8,
title = {{Docling Technical Report}}, title = "Docling Technical Report",
url={https://arxiv.org/abs/2408.09869}, url = "https://arxiv.org/abs/2408.09869",
eprint={2408.09869}, eprint = "2408.09869",
doi = "10.48550/arXiv.2408.09869", doi = "10.48550/arXiv.2408.09869",
version = {1.0.0}, version = "1.0.0",
year = {2024} year = 2024
} }
``` ```