From e7803334409a343a59c536c529a03d6f5cdbfe15 Mon Sep 17 00:00:00 2001 From: Panos Vagenas <35837085+vagenas@users.noreply.github.com> Date: Fri, 6 Dec 2024 13:18:14 +0100 Subject: [PATCH] docs: document new integrations (#532) Signed-off-by: Panos Vagenas <35837085+vagenas@users.noreply.github.com> --- docs/integrations/bee.md | 2 +- docs/integrations/cloudera.md | 6 ++++++ docs/integrations/data_prep_kit.md | 13 +++++-------- docs/integrations/docetl.md | 2 +- docs/integrations/instructlab.md | 7 +++---- docs/integrations/kotaemon.md | 4 ++-- docs/integrations/llamaindex.md | 6 ++---- docs/integrations/prodigy.md | 9 ++++++--- docs/integrations/rhel_ai.md | 10 ++++++++++ docs/integrations/spacy.md | 7 ++++--- docs/integrations/txtai.md | 9 +++++++++ mkdocs.yml | 3 +++ 12 files changed, 52 insertions(+), 26 deletions(-) create mode 100644 docs/integrations/cloudera.md create mode 100644 docs/integrations/rhel_ai.md create mode 100644 docs/integrations/txtai.md diff --git a/docs/integrations/bee.md b/docs/integrations/bee.md index 168fd788..f46ea9e3 100644 --- a/docs/integrations/bee.md +++ b/docs/integrations/bee.md @@ -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 diff --git a/docs/integrations/cloudera.md b/docs/integrations/cloudera.md new file mode 100644 index 00000000..748f266e --- /dev/null +++ b/docs/integrations/cloudera.md @@ -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 diff --git a/docs/integrations/data_prep_kit.md b/docs/integrations/data_prep_kit.md index c9b3755a..a071cef4 100644 --- a/docs/integrations/data_prep_kit.md +++ b/docs/integrations/data_prep_kit.md @@ -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/) diff --git a/docs/integrations/docetl.md b/docs/integrations/docetl.md index a03a4044..e61f028c 100644 --- a/docs/integrations/docetl.md +++ b/docs/integrations/docetl.md @@ -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 diff --git a/docs/integrations/instructlab.md b/docs/integrations/instructlab.md index 5f3b3315..a8979039 100644 --- a/docs/integrations/instructlab.md +++ b/docs/integrations/instructlab.md @@ -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] - +- 📖 [InstructLab docs][docs] [home]: https://instructlab.ai [github]: https://github.com/instructlab diff --git a/docs/integrations/kotaemon.md b/docs/integrations/kotaemon.md index 14cfc130..9858dc70 100644 --- a/docs/integrations/kotaemon.md +++ b/docs/integrations/kotaemon.md @@ -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/ diff --git a/docs/integrations/llamaindex.md b/docs/integrations/llamaindex.md index dc61b34f..928d0475 100644 --- a/docs/integrations/llamaindex.md +++ b/docs/integrations/llamaindex.md @@ -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/). @@ -11,7 +9,7 @@ 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 @@ -19,5 +17,5 @@ Reads document files and uses Docling to populate LlamaIndex `Document` objects 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/) diff --git a/docs/integrations/prodigy.md b/docs/integrations/prodigy.md index 8bb40c29..388f64fa 100644 --- a/docs/integrations/prodigy.md +++ b/docs/integrations/prodigy.md @@ -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 diff --git a/docs/integrations/rhel_ai.md b/docs/integrations/rhel_ai.md new file mode 100644 index 00000000..0d603eb9 --- /dev/null +++ b/docs/integrations/rhel_ai.md @@ -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 diff --git a/docs/integrations/spacy.md b/docs/integrations/spacy.md index a0578703..a3940b90 100644 --- a/docs/integrations/spacy.md +++ b/docs/integrations/spacy.md @@ -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 diff --git a/docs/integrations/txtai.md b/docs/integrations/txtai.md new file mode 100644 index 00000000..28b6bf5a --- /dev/null +++ b/docs/integrations/txtai.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index f118edbd..687ae6d6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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