docling README

The project's README from github.com/docling-project/docling. As one markdown file: README.md.

Docling

Docling

DS4SD%2Fdocling | Trendshift

arXiv Docs PyPI version PyPI - Python Version uv Ruff Pydantic v2 prek License MIT PyPI Downloads Docling Actor Chat with Dosu Discord OpenSSF Best Practices LF AI & Data

What is Docling ?

Docling simplifies document processing by parsing diverse formats — including advanced PDF understanding — and providing seamless integrations with the generative AI ecosystem.

Features

What's new

Coming soon

Quickstart

1. Install

pip install docling

Note: Python 3.9 support was dropped in docling version 2.70.0. Please use Python 3.10 or higher.

Works on macOS, Linux and Windows environments for both x86_64 and arm64 architectures.

More detailed installation instructions are available in the docs.

2. Convert a document (CLI)

docling https://arxiv.org/pdf/2206.01062

This generates a .md file in the current directory containing structured document content.

You can also use 🥚GraniteDocling and other VLMs via Docling CLI:

docling --pipeline vlm --vlm-model granite_docling https://arxiv.org/pdf/2206.01062
from docling.document_converter import DocumentConverter

source = "https://arxiv.org/pdf/2408.09869"  # a document via a local path or URL
converter = DocumentConverter()
result = converter.convert(source)
print(result.document.export_to_markdown())  # output: "## Docling Technical Report[...]"

More advanced usage and configuration options.

Documentation

Check out Docling's documentation for details on installation, usage, concepts, recipes, extensions, and more.

Examples

Go hands-on with our examples, demonstrating how to address different application use cases with Docling.

Integrations

To further accelerate your AI application development, check out Docling's native integrations with popular frameworks and tools.

Get help and support

Please feel free to connect with us using the discussion section.

Technical report

For more details on Docling's inner workings, check out the Docling Technical Report.

Contributing

Please read Contributing to Docling for details.

References

If you use Docling in your projects, please consider citing the following:

@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. For individual model usage, please refer to the model licenses found in the original packages.

LF AI & Data

Docling is hosted as a project in the LF AI & Data Foundation.

IBM ❤️ Open Source AI

The project was started by the AI for knowledge team at IBM Research Zurich.

docling (docling-project/docling)

Searching Database…

这是什么?Docling 可以解析多种文档格式,例如 PDF、DOCX、PPTX、XLSX、HTML 等,并将它们转换为统一的表示形式,便于用于生成式 AI 流程。
这是 Python 库还是命令行工具?两者都是:Docling 主要是一个供代码调用的 Python 库,但它也提供了一个简单的 CLI 用于快速转换,另外还有可选的 API 服务器(docling-serve)和 MCP 服务器,让智能体可以直接调用它。
我该如何开始使用?先为 Python 安装该软件包,然后可以运行 CLI,把文档生成为 Markdown 文件;或者在自己的代码中使用 Python API,进行更高级的配置。
我需要特定的 Python 版本吗?需要。Docling 要求 Python 3.10 或更高版本;在 2.70.0 版本中已停止支持 Python 3.9。
它在 macOS、Linux 和 Windows 上的表现一样吗?是的,它支持 macOS、Linux 和 Windows,同时支持 x86_64 和 arm64 架构。但由于已不再支持 Python 3.9,你需要使用较新的 Python 版本。
Docling 能否在完全离线的情况下处理敏感文档?可以,它支持本地运行,因此敏感数据可以在完全离线的隔离环境中处理,无需调用外部服务。
Docling 能转换哪些文件格式?它支持 PDF、DOCX、PPTX、XLSX、HTML、EPUB、Apple Pages、邮件(EML/MSG)、图片、LaTeX、纯文本,甚至包括音频(WAV/MP3)和视频(MP4/AVI/MOV/MKV/WebM)文件。
它能输出哪些导出格式?文档可以通过统一的“DoclingDocument”表示形式,转换为 Markdown、HTML、WebVTT、DocTags 或无损 JSON。
它能与 LangChain 等 AI 框架集成吗?可以。Docling 提供与 LangChain、LlamaIndex、Crew AI 和 Haystack 的即插即用集成,便于构建智能体 AI 应用。
什么是 GraniteDocling?它是 Docling 支持的视觉语言模型(VLM)之一,用于提升 PDF 和文档的理解能力,可以直接在 CLI 中选择使用。
Size
439.7 MB
Stars
69K
Age
2y
Commits · 90 Days