From f7e1cbf629ae5f3e279296e72f656b7a453ab7a3 Mon Sep 17 00:00:00 2001 From: "Peter W. J. Staar" <91719829+PeterStaar-IBM@users.noreply.github.com> Date: Wed, 15 Jan 2025 06:51:15 +0100 Subject: [PATCH] docs: Example to translate documents (#739) * added example to translate documents Signed-off-by: Peter Staar * updated the mkdocs Signed-off-by: Peter Staar * fix PR hooks Signed-off-by: Michele Dolfi --------- Signed-off-by: Peter Staar Signed-off-by: Michele Dolfi Co-authored-by: Michele Dolfi --- docs/examples/translate.py | 75 ++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 76 insertions(+) create mode 100644 docs/examples/translate.py diff --git a/docs/examples/translate.py b/docs/examples/translate.py new file mode 100644 index 00000000..a36c6f71 --- /dev/null +++ b/docs/examples/translate.py @@ -0,0 +1,75 @@ +import logging +import time +from pathlib import Path + +from docling_core.types.doc import ImageRefMode, PictureItem, TableItem, TextItem + +from docling.datamodel.base_models import FigureElement, InputFormat, Table +from docling.datamodel.pipeline_options import PdfPipelineOptions +from docling.document_converter import DocumentConverter, PdfFormatOption + +_log = logging.getLogger(__name__) + +IMAGE_RESOLUTION_SCALE = 2.0 + + +# FIXME: put in your favorite translation code .... +def translate(text: str, src: str = "en", dest: str = "de"): + + _log.warning("!!! IMPLEMENT HERE YOUR FAVORITE TRANSLATION CODE!!!") + # from googletrans import Translator + + # Initialize the translator + # translator = Translator() + + # Translate text from English to German + # text = "Hello, how are you?" + # translated = translator.translate(text, src="en", dest="de") + + return text + + +def main(): + logging.basicConfig(level=logging.INFO) + + input_doc_path = Path("./tests/data/2206.01062.pdf") + output_dir = Path("scratch") + + # Important: For operating with page images, we must keep them, otherwise the DocumentConverter + # will destroy them for cleaning up memory. + # This is done by setting PdfPipelineOptions.images_scale, which also defines the scale of images. + # scale=1 correspond of a standard 72 DPI image + # The PdfPipelineOptions.generate_* are the selectors for the document elements which will be enriched + # with the image field + pipeline_options = PdfPipelineOptions() + pipeline_options.images_scale = IMAGE_RESOLUTION_SCALE + pipeline_options.generate_page_images = True + pipeline_options.generate_picture_images = True + + doc_converter = DocumentConverter( + format_options={ + InputFormat.PDF: PdfFormatOption(pipeline_options=pipeline_options) + } + ) + + start_time = time.time() + + conv_res = doc_converter.convert(input_doc_path) + conv_doc = conv_res.document + + # Save markdown with embedded pictures in original text + md_filename = output_dir / f"{doc_filename}-with-images-orig.md" + conv_doc.save_as_markdown(md_filename, image_mode=ImageRefMode.EMBEDDED) + + for element, _level in conv_res.document.iterate_items(): + if isinstance(element, TextItem): + element.orig = element.text + element.text = translate(text=element.text) + + elif isinstance(element, TableItem): + for cell in element.data.table_cells: + cell.text = translate(text=element.text) + + # Save markdown with embedded pictures in translated text + md_filename = output_dir / f"{doc_filename}-with-images-translated.md" + conv_doc.save_as_markdown(md_filename, image_mode=ImageRefMode.EMBEDDED) diff --git a/mkdocs.yml b/mkdocs.yml index 8d9f6591..8f8d86d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -76,6 +76,7 @@ nav: - "Multimodal export": examples/export_multimodal.py - "Force full page OCR": examples/full_page_ocr.py - "Accelerator options": examples/run_with_accelerator.py + - "Simple translation": examples/translate.py - ✂️ Chunking: - "Hybrid chunking": examples/hybrid_chunking.ipynb - 💬 RAG / QA: