Mingxuan Zhao ff351fd40c docs: Describe examples (#2262) ...

* Update .py examples with clearer guidance,
update out of date imports and calls

Signed-off-by: Mingxuan Zhao <43148277+mingxzhao@users.noreply.github.com>

* Fix minimal.py string error, fix ruff format error

Signed-off-by: Mingxuan Zhao <43148277+mingxzhao@users.noreply.github.com>

* fix more CI issues

Signed-off-by: Mingxuan Zhao <43148277+mingxzhao@users.noreply.github.com>

---------

Signed-off-by: Mingxuan Zhao <43148277+mingxzhao@users.noreply.github.com>

2025-09-16 16:00:38 +02:00

..

data

docs: add advanced chunking & serialization example (#1589)

2025-05-14 14:35:07 +02:00

advanced_chunking_and_serialization.ipynb

chore: fix chunking example data link (#1596)

2025-05-16 08:44:47 +02:00

backend_csv.ipynb

feat: Add support for CSV input with new backend to transform CSV files to DoclingDocument (#945)

2025-02-14 08:55:09 +01:00

backend_xml_rag.ipynb

chore: typo fix (#1465)

2025-04-28 08:52:09 +02:00

batch_convert.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

compare_vlm_models.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

custom_convert.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

develop_formula_understanding.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

develop_picture_enrichment.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

dpk-ingest-chunk-tokenize.ipynb

docs: add information extraction example (#2199)

2025-09-05 11:27:09 +02:00

enrich_doclingdocument.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

enrich_simple_pipeline.py

feat: enrichment steps on all convert pipelines (incl docx, html, etc) (#2251)

2025-09-11 15:09:00 +02:00

export_figures.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

export_multimodal.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

export_tables.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

extraction.ipynb

docs: Document VLM support requirement in extraction example (#2231)

2025-09-09 13:45:55 +02:00

full_page_ocr.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

hybrid_chunking.ipynb

docs: add advanced chunking & serialization example (#1589)

2025-05-14 14:35:07 +02:00

index.md

docs: add information extraction example (#2199)

2025-09-05 11:27:09 +02:00

inspect_picture_content.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

minimal_asr_pipeline.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

minimal_vlm_pipeline.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

minimal.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

pictures_description_api.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

pictures_description.ipynb

chore: typo fix (#1465)

2025-04-28 08:52:09 +02:00

rag_azuresearch.ipynb

ci: add coverage and ruff (#1383)

2025-04-14 18:01:26 +02:00

rag_haystack.ipynb

ci: add coverage and ruff (#1383)

2025-04-14 18:01:26 +02:00

rag_langchain.ipynb

ci: add coverage and ruff (#1383)

2025-04-14 18:01:26 +02:00

rag_llamaindex.ipynb

chore: move to docling-project org (#1160)

2025-03-14 12:35:29 +01:00

rag_milvus.ipynb

chore: typo fix (#1465)

2025-04-28 08:52:09 +02:00

rag_opensearch.ipynb

docs: add an example of RAG with OpenSearch (#2238)

2025-09-10 14:37:22 +02:00

rag_weaviate.ipynb

chore: typo fix (#1465)

2025-04-28 08:52:09 +02:00

rapidocr_with_custom_models.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

retrieval_qdrant.ipynb

chore: move to docling-project org (#1160)

2025-03-14 12:35:29 +01:00

run_md.py

ci: add coverage and ruff (#1383)

2025-04-14 18:01:26 +02:00

run_with_accelerator.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

run_with_formats.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

serialization.ipynb

docs: add serialization docs, update chunking docs (#1556)

2025-05-08 21:43:01 +02:00

tesseract_lang_detection.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

translate.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00

visual_grounding.ipynb

ci: add coverage and ruff (#1383)

2025-04-14 18:01:26 +02:00

vlm_pipeline_api_model.py

docs: Describe examples (#2262)

2025-09-16 16:00:38 +02:00