From 8a61f25eeff973df1f8cbd337a0b60c4464a5038 Mon Sep 17 00:00:00 2001 From: Matheus Moura <80767577+matheushmoura@users.noreply.github.com> Date: Fri, 27 Dec 2024 20:17:50 -0300 Subject: [PATCH] Update README.md Changes for Docowling Fork Signed-off-by: Matheus Moura <80767577+matheushmoura@users.noreply.github.com> --- README.md | 124 +----------------------------------------------------- 1 file changed, 2 insertions(+), 122 deletions(-) diff --git a/README.md b/README.md index 98222f83..db06ea18 100644 --- a/README.md +++ b/README.md @@ -1,123 +1,3 @@ -

- - Docling - -

+# Docowling -# Docling - -

- DS4SD%2Fdocling | Trendshift -

- -[![arXiv](https://img.shields.io/badge/arXiv-2408.09869-b31b1b.svg)](https://arxiv.org/abs/2408.09869) -[![Docs](https://img.shields.io/badge/docs-live-brightgreen)](https://ds4sd.github.io/docling/) -[![PyPI version](https://img.shields.io/pypi/v/docling)](https://pypi.org/project/docling/) -[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/docling)](https://pypi.org/project/docling/) -[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) -[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev) -[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) -[![License MIT](https://img.shields.io/github/license/DS4SD/docling)](https://opensource.org/licenses/MIT) -[![PyPI Downloads](https://static.pepy.tech/badge/docling/month)](https://pepy.tech/projects/docling) - -Docling parses documents and exports them to the desired format with ease and speed. - -## Features - -* πŸ—‚οΈ Reads popular document formats (PDF, DOCX, PPTX, XLSX, Images, HTML, AsciiDoc & Markdown) and exports to HTML, Markdown and JSON (with embedded and referenced images) -* πŸ“‘ Advanced PDF document understanding including page layout, reading order & table structures -* 🧩 Unified, expressive [DoclingDocument](https://ds4sd.github.io/docling/concepts/docling_document/) representation format -* πŸ€– Easy integration with πŸ¦™ LlamaIndex & πŸ¦œπŸ”— LangChain for powerful RAG / QA applications -* πŸ” OCR support for scanned PDFs -* πŸ’» Simple and convenient CLI - -Explore the [documentation](https://ds4sd.github.io/docling/) to discover plenty examples and unlock the full power of Docling! - -### Coming soon - -* ♾️ Equation & code extraction -* πŸ“ Metadata extraction, including title, authors, references & language -* πŸ¦œπŸ”— Native LangChain extension - -## Installation - -To use Docling, simply install `docling` from your package manager, e.g. pip: -```bash -pip install docling -``` - -Works on macOS, Linux and Windows environments. Both x86_64 and arm64 architectures. - -More [detailed installation instructions](https://ds4sd.github.io/docling/installation/) are available in the docs. - -## Getting started - -To convert individual documents, use `convert()`, for example: - -```python -from docling.document_converter import DocumentConverter - -source = "https://arxiv.org/pdf/2408.09869" # document per local path or URL -converter = DocumentConverter() -result = converter.convert(source) -print(result.document.export_to_markdown()) # output: "## Docling Technical Report[...]" -``` - -More [advanced usage options](https://ds4sd.github.io/docling/usage/) are available in -the docs. - -## Documentation - -Check out Docling's [documentation](https://ds4sd.github.io/docling/), for details on -installation, usage, concepts, recipes, extensions, and more. - -## Examples - -Go hands-on with our [examples](https://ds4sd.github.io/docling/examples/), -demonstrating how to address different application use cases with Docling. - -## Integrations - -To further accelerate your AI application development, check out Docling's native -[integrations](https://ds4sd.github.io/docling/integrations/) with popular frameworks -and tools. - -## Get help and support - -Please feel free to connect with us using the [discussion section](https://github.com/DS4SD/docling/discussions). - -## Technical report - -For more details on Docling's inner workings, check out the [Docling Technical Report](https://arxiv.org/abs/2408.09869). - -## Contributing - -Please read [Contributing to Docling](https://github.com/DS4SD/docling/blob/main/CONTRIBUTING.md) for details. - -## References - -If you use Docling 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 codebase is under MIT license. -For individual model usage, please refer to the model licenses found in the original packages. - -## IBM ❀️ Open Source AI - -Docling has been brought to you by IBM. +**Docowling** Γ© um fork do projeto [Docling](https://github.com/DS4SD/docling), desenvolvido para aprimorar funcionalidades e adicionar novas capacidades de processamento de documentos.