From 476affeb647b832481e3af3aa2ce1a58c98030af Mon Sep 17 00:00:00 2001 From: Swaymaw Date: Wed, 20 Nov 2024 14:10:36 +0530 Subject: [PATCH] original readme for pull request Signed-off-by: Swaymaw --- README.md | 116 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 93 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index d3bafa11..4fa9a242 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,101 @@ -## Additional Features: -- Integrated PaddleOCR - For improved OCR capabilities. +

+ + Docling + +

-To know more about the original repository refer to the readme and documentation available at:
-[Docling Github Repo](https://github.com/DS4SD/docling) -[Docling Documentation](https://ds4sd.github.io/docling/) +# Docling -## PaddleOCR Usage - Demo: -```python -from docling.datamodel.base_models import InputFormat -from docling.document_converter import DocumentConverter, ImageFormatOption, PdfFormatOption -from docling.datamodel.pipeline_options import PdfPipelineOptions, TableFormerMode, TableStructureOptions +

+ DS4SD%2Fdocling | Trendshift +

-pipeline_options = PdfPipelineOptions(do_table_structure=True, generate_page_images=True, images_scale=2.0) -pipeline_options.table_structure_options.mode = TableFormerMode.ACCURATE # use more accurate TableFormer model -pipeline_options.table_structure_options = TableStructureOptions(do_cell_matching=True) -pipeline_options.ocr_options = PaddleOcrOptions(lang="en") +[![arXiv](https://img.shields.io/badge/arXiv-2408.09869-b31b1b.svg)](https://arxiv.org/abs/2408.09869) +[![Docs](https://img.shields.io/badge/docs-live-brightgreen)](https://ds4sd.github.io/docling/) +[![PyPI version](https://img.shields.io/pypi/v/docling)](https://pypi.org/project/docling/) +![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue) +[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) +[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) +[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev) +[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) +[![License MIT](https://img.shields.io/github/license/DS4SD/docling)](https://opensource.org/licenses/MIT) -doc_converter = DocumentConverter( - format_options={ - InputFormat.PDF: PdfFormatOption(pipeline_options=pipeline_options), - InputFormat.IMAGE: ImageFormatOption(pipeline_options=pipeline_options) - } -) -result = doc_converter.convert("sample_file.pdf") -print(result.document.export_to_markdown()) +Docling parses documents and exports them to the desired format with ease and speed. +## Features + +* πŸ—‚οΈ Reads popular document formats (PDF, DOCX, PPTX, Images, HTML, AsciiDoc, Markdown) and exports to Markdown and JSON +* πŸ“‘ Advanced PDF document understanding including page layout, reading order & table structures +* 🧩 Unified, expressive [DoclingDocument](https://ds4sd.github.io/docling/concepts/docling_document/) representation format +* πŸ€– Easy integration with LlamaIndex πŸ¦™ & LangChain πŸ¦œπŸ”— for powerful RAG / QA applications +* πŸ” OCR support for scanned PDFs +* πŸ’» Simple and convenient CLI + +Explore the [documentation](https://ds4sd.github.io/docling/) to discover plenty examples and unlock the full power of Docling! + +### Coming soon + +* ♾️ Equation & code extraction +* πŸ“ Metadata extraction, including title, authors, references & language +* πŸ¦œπŸ”— Native LangChain extension + +## Installation + +To use Docling, simply install `docling` from your package manager, e.g. pip: +```bash +pip install docling ``` + +Works on macOS, Linux and Windows environments. Both x86_64 and arm64 architectures. + +More [detailed installation instructions](https://ds4sd.github.io/docling/installation/) are available in the docs. + +## Getting started + +To convert individual documents, use `convert()`, for example: + +```python +from docling.document_converter import DocumentConverter + +source = "https://arxiv.org/pdf/2408.09869" # document per local path or URL +converter = DocumentConverter() +result = converter.convert(source) +print(result.document.export_to_markdown()) # output: "## Docling Technical Report[...]" +``` + +Check out [Getting started](https://ds4sd.github.io/docling/). +You will find lots of tuning options to leverage all the advanced capabilities. + +## Get help and support + +Please feel free to connect with us using the [discussion section](https://github.com/DS4SD/docling/discussions). + +## Technical report + +For more details on Docling's inner workings, check out the [Docling Technical Report](https://arxiv.org/abs/2408.09869). + +## Contributing + +Please read [Contributing to Docling](https://github.com/DS4SD/docling/blob/main/CONTRIBUTING.md) for details. + +## References + +If you use Docling in your projects, please consider citing the following: + +```bib +@techreport{Docling, + author = {Deep Search Team}, + month = {8}, + title = {Docling Technical Report}, + url = {https://arxiv.org/abs/2408.09869}, + eprint = {2408.09869}, + doi = {10.48550/arXiv.2408.09869}, + version = {1.0.0}, + year = {2024} +} +``` + ## License The Docling codebase is under MIT license. @@ -33,4 +103,4 @@ For individual model usage, please refer to the model licenses found in the orig ## IBM ❀️ Open Source AI -Docling has been brought to you by IBM. +Docling has been brought to you by IBM. \ No newline at end of file