Skip to content

Commit

Permalink
docs: document new integrations (#532)
Browse files Browse the repository at this point in the history
Signed-off-by: Panos Vagenas <[email protected]>
  • Loading branch information
vagenas authored Dec 6, 2024
1 parent 0d11e30 commit e780333
Show file tree
Hide file tree
Showing 12 changed files with 52 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/integrations/bee.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Docling is available as an extraction backend in the [Bee][github] framework.

- πŸ’» [Bee GitHub][github]
- πŸ“– [Bee Docs][docs]
- πŸ“– [Bee docs][docs]
- πŸ“¦ [Bee NPM][package]

[github]: https://github.com/i-am-bee
Expand Down
6 changes: 6 additions & 0 deletions docs/integrations/cloudera.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Docling is available in [Cloudera](https://www.cloudera.com/) through the *RAG Studio*
Accelerator for Machine Learning Projects (AMP).

- πŸ’» [RAG Studio AMP GitHub][github]

[github]: https://github.com/cloudera/CML_AMP_RAG_Studio
13 changes: 5 additions & 8 deletions docs/integrations/data_prep_kit.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
## Get started

Docling is used by the [Data Prep Kit](https://ibm.github.io/data-prep-kit/) open-source toolkit for preparing unstructured data for LLM application development ranging from laptop scale to datacenter scale.

Below you find the Data Prep Kit modules powered by Docling.

## PDF ingestion to Parquet
## Components
### PDF ingestion to Parquet
- πŸ’» [PDF-to-Parquet GitHub](https://github.com/IBM/data-prep-kit/tree/dev/transforms/language/pdf2parquet)
- πŸ“– [PDF-to-Parquet Docs](https://ibm.github.io/data-prep-kit/transforms/language/pdf2parquet/python/)
- πŸ“– [PDF-to-Parquet docs](https://ibm.github.io/data-prep-kit/transforms/language/pdf2parquet/python/)

## Document chunking
### Document chunking
- πŸ’» [Doc Chunking GitHub](https://github.com/IBM/data-prep-kit/tree/dev/transforms/language/doc_chunk)
- πŸ“– [Doc Chunking Docs](https://ibm.github.io/data-prep-kit/transforms/language/doc_chunk/python/)
- πŸ“– [Doc Chunking docs](https://ibm.github.io/data-prep-kit/transforms/language/doc_chunk/python/)
2 changes: 1 addition & 1 deletion docs/integrations/docetl.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Docling is available as a file conversion method in [DocETL](https://github.com/ucbepic/docetl):

- πŸ’» [DocETL GitHub][github]
- πŸ“– [DocETL Docs][docs]
- πŸ“– [DocETL docs][docs]
- πŸ“¦ [DocETL PyPI][pypi]

[github]: https://github.com/ucbepic/docetl
Expand Down
7 changes: 3 additions & 4 deletions docs/integrations/instructlab.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
Docling is powering document processing in [InstructLab](https://instructlab.ai/),
Docling is powering document processing in [InstructLab][home],
enabling users to unlock the knowledge hidden in documents and present it to
InstructLab's fine-tuning for aligning AI models to the user's specific data.

More details can be found in this [blog post][blog].

- 🏠 [InstructLab Home][home]
- 🏠 [InstructLab home][home]
- πŸ’» [InstructLab GitHub][github]
- πŸ§‘πŸ»β€πŸ’» [InstructLab UI][ui]
- πŸ“– [InstructLab Docs][docs]
<!-- - πŸ“ [Blog post]() -->
- πŸ“– [InstructLab docs][docs]

[home]: https://instructlab.ai
[github]: https://github.com/instructlab
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/kotaemon.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Docling is available in [Kotaemon](https://cinnamon.github.io/kotaemon/) as the `DoclingReader` loader:

- πŸ’» [Kotaemon GitHub][github]
- πŸ“– [DoclingReader Docs][docs]
- βš™οΈ [Docling Setup in Kotaemon][setup]
- πŸ“– [DoclingReader docs][docs]
- βš™οΈ [Docling setup in Kotaemon][setup]

[github]: https://github.com/Cinnamon/kotaemon
[docs]: https://cinnamon.github.io/kotaemon/reference/loaders/docling_loader/
Expand Down
6 changes: 2 additions & 4 deletions docs/integrations/llamaindex.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Get started

Docling is available as an official [LlamaIndex](https://docs.llamaindex.ai/) extension.

To get started, check out the [step-by-step guide in LlamaIndex](https://docs.llamaindex.ai/en/stable/examples/data_connectors/DoclingReaderDemo/).
Expand All @@ -11,13 +9,13 @@ To get started, check out the [step-by-step guide in LlamaIndex](https://docs.ll
Reads document files and uses Docling to populate LlamaIndex `Document` objects β€” either serializing Docling's data model (losslessly, e.g. as JSON) or exporting to a simplified format (lossily, e.g. as Markdown).

- πŸ’» [Docling Reader GitHub](https://github.com/run-llama/llama_index/tree/main/llama-index-integrations/readers/llama-index-readers-docling)
- πŸ“– [Docling Reader Docs](https://docs.llamaindex.ai/en/stable/api_reference/readers/docling/)
- πŸ“– [Docling Reader docs](https://docs.llamaindex.ai/en/stable/api_reference/readers/docling/)
- πŸ“¦ [Docling Reader PyPI](https://pypi.org/project/llama-index-readers-docling/)

### Docling Node Parser

Reads LlamaIndex `Document` objects populated in Docling's format by Docling Reader and, using its knowledge of the Docling format, parses them to LlamaIndex `Node` objects for downstream usage in LlamaIndex applications, e.g. as chunks for embedding.

- πŸ’» [Docling Node Parser GitHub](https://github.com/run-llama/llama_index/tree/main/llama-index-integrations/node_parser/llama-index-node-parser-docling)
- πŸ“– [Docling Node Parser Docs](https://docs.llamaindex.ai/en/stable/api_reference/node_parser/docling/)
- πŸ“– [Docling Node Parser docs](https://docs.llamaindex.ai/en/stable/api_reference/node_parser/docling/)
- πŸ“¦ [Docling Node Parser PyPI](https://pypi.org/project/llama-index-node-parser-docling/)
9 changes: 6 additions & 3 deletions docs/integrations/prodigy.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
Docling is available in [Prodigy][home] as a [Prodigy-PDF plugin][plugin] recipe.

- 🌐 [Prodigy Home][home]
- πŸ”Œ [Prodigy-PDF Plugin][plugin]
- πŸ§‘πŸ½β€πŸ³ [pdf-spans.manual Recipe][recipe]
More details can be found in this [blog post][blog].

- 🌐 [Prodigy home][home]
- πŸ”Œ [Prodigy-PDF plugin][plugin]
- πŸ§‘πŸ½β€πŸ³ [pdf-spans.manual recipe][recipe]

[home]: https://prodi.gy/
[plugin]: https://prodi.gy/docs/plugins#pdf
[recipe]: https://prodi.gy/docs/plugins#pdf-spans.manual
[blog]: https://explosion.ai/blog/pdfs-nlp-structured-data
10 changes: 10 additions & 0 deletions docs/integrations/rhel_ai.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Docling is powering document processing in [Red Hat Enterprise Linux AI][home] (RHEL AI),
enabling users to unlock the knowledge hidden in documents and present it to
InstructLab's fine-tuning for aligning AI models to the user's specific data.

More details can be found in this [blog post][blog].

- 🏠 [RHEL AI home][home]

[home]: https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux/ai
[blog]: https://www.redhat.com/en/blog/docling-missing-document-processing-companion-generative-ai
7 changes: 4 additions & 3 deletions docs/integrations/spacy.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# spaCy
Docling is available in [spaCy](https://spacy.io/) as the *spaCy Layout* plugin.

Docling is available in [spaCy](https://spacy.io/) as the "SpaCy Layout" plugin:
More details can be found in this [blog post][blog].

- πŸ’» [SpacyLayout GitHub][github]
- πŸ“– [SpacyLayout Docs][docs]
- πŸ“– [SpacyLayout docs][docs]
- πŸ“¦ [SpacyLayout PyPI][pypi]

[github]: https://github.com/explosion/spacy-layout
[docs]: https://github.com/explosion/spacy-layout?tab=readme-ov-file#readme
[pypi]: https://pypi.org/project/spacy-layout/
[blog]: https://explosion.ai/blog/pdfs-nlp-structured-data
9 changes: 9 additions & 0 deletions docs/integrations/txtai.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Docling is available as a text extraction backend for [txtai](https://neuml.github.io/txtai/).

- πŸ’» [txtai GitHub][github]
- πŸ“– [txtai docs][docs]
- πŸ“– [txtai Docling backend][integration_docs]

[github]: https://github.com/neuml/txtai
[docs]: https://neuml.github.io/txtai
[integration_docs]: https://neuml.github.io/txtai/pipeline/data/filetohtml/#docling
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,16 @@ nav:
- Integrations:
- Integrations: integrations/index.md
- "🐝 Bee": integrations/bee.md
- "Cloudera": integrations/cloudera.md
- "Data Prep Kit": integrations/data_prep_kit.md
- "DocETL": integrations/docetl.md
- "🐢 InstructLab": integrations/instructlab.md
- "Kotaemon": integrations/kotaemon.md
- "πŸ¦™ LlamaIndex": integrations/llamaindex.md
- "Prodigy": integrations/prodigy.md
- "Red Hat Enterprise Linux AI": integrations/rhel_ai.md
- "spaCy": integrations/spacy.md
- "txtai": integrations/txtai.md
# - "LangChain πŸ¦œπŸ”—": integrations/langchain.md
- API reference:
- Document Converter: api_reference/document_converter.md
Expand Down

0 comments on commit e780333

Please sign in to comment.