mirror of
https://github.com/docling-project/docling-core.git
synced 2026-05-17 13:10:44 +00:00
Christoph Auer
c4a8c2aa3a
* Remove 3.9 from python version badge Signed-off-by: Christoph Auer <60343111+cau-git@users.noreply.github.com> * Update python range on README Signed-off-by: Christoph Auer <60343111+cau-git@users.noreply.github.com> --------- Signed-off-by: Christoph Auer <60343111+cau-git@users.noreply.github.com>
100 lines
4.0 KiB
Markdown
100 lines
4.0 KiB
Markdown
# Docling Core
|
||
|
||
[](https://pypi.org/project/docling-core/)
|
||
|
||
[](https://github.com/astral-sh/uv)
|
||
[](https://github.com/psf/black)
|
||
[](https://pycqa.github.io/isort/)
|
||
[](https://mypy-lang.org/)
|
||
[](https://pydantic.dev)
|
||
[](https://github.com/pre-commit/pre-commit)
|
||
[](https://opensource.org/licenses/MIT)
|
||
|
||
Docling Core is a library that defines core data types and transformations in [Docling](https://github.com/docling-project/docling).
|
||
|
||
## Installation
|
||
|
||
To use Docling Core, simply install `docling-core` from your package manager, e.g. pip:
|
||
```bash
|
||
pip install docling-core
|
||
```
|
||
|
||
### Development setup
|
||
|
||
To develop for Docling Core, you need Python 3.10 through 3.14 and the `uv` package. You can then install it from your local clone's root directory:
|
||
```bash
|
||
uv sync --all-extras
|
||
```
|
||
|
||
To run the pytest suite, execute:
|
||
```
|
||
uv run pytest -s test
|
||
```
|
||
|
||
## Main features
|
||
|
||
Docling Core provides the foundational DoclingDocument data model and API, as well as
|
||
additional APIs for tasks like serialization and chunking, which are key to developing
|
||
generative AI applications using Docling.
|
||
|
||
### DoclingDocument
|
||
|
||
Docling Core defines the DoclingDocument as a Pydantic model, allowing for advanced
|
||
data model control, customizability, and interoperability.
|
||
|
||
In addition to specifying the schema, it provides a handy API for building documents,
|
||
as well as for basic operations, e.g. exporting to various formats, like Markdown, HTML,
|
||
and others.
|
||
|
||
👉 More details:
|
||
- [Architecture docs](https://docling-project.github.io/docling/concepts/architecture/)
|
||
- [DoclingDocument docs](https://docling-project.github.io/docling/concepts/docling_document/)
|
||
|
||
### Serialization
|
||
|
||
Different users can have varying requirements when it comes to serialization.
|
||
To address this, the Serialization API introduces a design that allows easy extension,
|
||
while providing feature-rich built-in implementations (on which the respective
|
||
DoclingDocument helpers are actually based).
|
||
|
||
👉 More details:
|
||
- [Serialization docs](https://docling-project.github.io/docling/concepts/serialization/)
|
||
- [Serialization example](https://docling-project.github.io/docling/examples/serialization/)
|
||
|
||
### Chunking
|
||
|
||
Similarly to above, the Chunking API provides built-in chunking capabilities as well as
|
||
a design that enables easy extension, this way tackling customization requirements of
|
||
different use cases.
|
||
|
||
👉 More details:
|
||
- [Chunking docs](https://docling-project.github.io/docling/concepts/chunking/)
|
||
- [Hybrid chunking example](https://docling-project.github.io/docling/examples/hybrid_chunking/)
|
||
- [Advanced chunking and serialization](https://docling-project.github.io/docling/examples/advanced_chunking_and_serialization/)
|
||
|
||
## Contributing
|
||
|
||
Please read [Contributing to Docling Core](./CONTRIBUTING.md) for details.
|
||
|
||
## References
|
||
|
||
If you use Docling Core 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 Core codebase is under MIT license.
|
||
For individual model usage, please refer to the model licenses found in the original packages.
|