Skip to main content

mmore: Scalable multimodal document extraction pipeline for custom RAG integration.

Project description

image

License Release Paper

Massive Multimodal Open RAG & Extraction

MMORE is an open-source, end-to-end pipeline to ingest, process, index, and retrieve knowledge from heterogeneous files: PDFs, Office docs, spreadsheets, emails, images, audio, video, and web pages. It standardizes content into a unified multimodal format, supports distributed CPU/GPU processing, and provides hybrid dense+sparse retrieval with an integrated RAG service (CLI, APIs).

👉 Read the paper for more details (OpenReview): MMORE: Massive Multimodal Open RAG & Extraction

Documentation

👉 Read the full documentation here: MMORE Documentation.

:bulb: Quickstart

Installation

:whale: Prefer Docker? Skip the steps below and pull a pre-built multi-platform image directly from GHCR, with CPU and GPU variants:

docker pull ghcr.io/swiss-ai/mmore:edge-gpu   # GPU (CUDA 12.6)
docker pull ghcr.io/swiss-ai/mmore:edge-cpu   # CPU-only

See docker/ubuntu/README.md for build instructions and additional base OS variants (Arch Linux, openSUSE Leap).

(Step 0 – Install system dependencies)

Our package requires system dependencies. This snippet will take care of installing them for Linux!

sudo apt update
sudo apt install -y ffmpeg libsm6 libxext6 libnss3 \
  libxi6 libxrandr2 libxcomposite1 libxcursor1 libxdamage1 \
  libxext6 libxfixes3 libxrender1 libasound2 libatk1.0-0 libgtk-3-0 libreoffice \
  libpango-1.0-0 libpangoft2-1.0-0 weasyprint

:warning: On Ubuntu 24.04, replace libasound2 with libasound2t64. You may also need to add the repository for Ubuntu 20.04 focal to have access to a few of the sources (e.g. create /etc/apt/sources.list.d/mmore.list with the contents deb http://cz.archive.ubuntu.com/ubuntu focal main universe).

For MacOS, use instead:

brew update
brew install ffmpeg gtk+3 pango cairo \
  gobject-introspection libffi pkg-config libx11 libxi \
  libxrandr libxcomposite libxcursor libxdamage libxext \
  libxrender atk libreoffice weasyprint

If weasyprint fails to find GTK or Cairo, also run:

brew install cairo pango gdk-pixbuf libffi
uv pip install weasyprint

Step 1 – Install MMORE

Dependencies are split by pipeline stage. Install only what you need:

Extra What it includes
process mmore's processing pipeline
index mmore's indexing pipeline
rag mmore's RAG pipeline (includes index)
api FastAPI servers
all Everything above
websearch Web search pipeline (DuckDuckGo + optional Tavily)
cpu PyTorch (CPU) + torchvision, for a CPU-only setup
cu126 PyTorch (CUDA 12.6) + torchvision, for a GPU setup

Full install (CPU):

uv pip install "mmore[all,cpu]"

Full install (GPU — CUDA 12.6):

uv pip install "mmore[all,cu126]"

Partial install example (processing only):

uv pip install "mmore[process,cpu]"

:warning: This package requires many big dependencies, so it is recommended to install with uv to handle pip installations. Check our tutorial on uv.

:warning: Check the instructions for contributors directly at docs/for_devs.md

Minimal Example

You can use our predefined CLI commands to execute parts of the pipeline. Note that you might need to prepend python -m to the command if the package does not properly create bash aliases.

# Run processing
python -m mmore process --config-file examples/process/config.yaml
python -m mmore postprocess --config-file examples/postprocessor/config.yaml --input-data examples/process/outputs/merged/merged_results.jsonl

# Run indexer
python -m mmore index --config-file examples/index/config.yaml --documents-path examples/postprocessor/outputs/merged/results.jsonl

# Run RAG
python -m mmore rag --config-file examples/rag/config.yaml

You can also use our package in python code as shown here:

from mmore.process.processors.pdf_processor import PDFProcessor
from mmore.process.processors.base import ProcessorConfig
from mmore.type import MultimodalSample

pdf_file_paths = ["/path/to/examples/sample_data/pdf/calendar.pdf"] #write here the full path, not a relative path
out_file = "/path/to/examples/process/outputs/example.jsonl"

pdf_processor_config = ProcessorConfig(custom_config={"output_path": "examples/process/outputs"})
pdf_processor = PDFProcessor(config=pdf_processor_config)
result_pdf = pdf_processor.process_batch(pdf_file_paths, False, 1) # args: file_paths, fast mode (True/False), num_workers

MultimodalSample.to_jsonl(out_file, result_pdf)

Usage

To launch the MMORE pipeline, follow the specialised instructions in the docs.

The MMORE pipelines architecture

  1. :page_facing_up: Input Documents Upload your multimodal documents (PDFs, videos, spreadsheets, and m(m)ore) into the pipeline.

  2. :mag: Process Extracts and standardizes text, metadata, and multimedia content from diverse file formats. Easily extensible! You can add your own processors to handle new file types. Supports fast processing for specific types.

  3. :file_folder: Index Organizes extracted data into a hybrid retrieval-ready Vector Store DB, combining dense and sparse indexing through Milvus. Your vector DB can also be remotely hosted and then you only have to provide a standard API. There is also an HTTP Index API for adding new files on the fly with HTTP requests.

  4. :robot: RAG Use the indexed documents inside a Retrieval-Augmented Generation (RAG) system that provides a LangChain interface. Plug in any LLM with a compatible interface or add new ones through an easy-to-use interface. Supports API hosting or local inference.

  5. :globe_with_meridians: Web Search Augments RAG answers with live web search results using an iterative sub-query loop. DuckDuckGo is the default provider (free, no API key needed). Tavily is available as an optional higher-quality provider.

      # Install web search dependencies
      pip install "mmore[rag,websearch]"
    
      # Optional: use Tavily instead of DuckDuckGo
      export TAVILY_API_KEY=your_key_here
    
  6. :tada: Evaluation Coming soon An easy way to evaluate the performance of your RAG system using Ragas.

See the /docs directory for additional details on each modules and hands-on tutorials on parts of the pipeline.

:construction: Supported File Types

Category File Types Supported Device Fast Mode
Text Documents DOCX, MD, PPTX, XLSX, TXT, EML CPU :x:
PDFs PDF GPU/CPU :white_check_mark:
Media Files MP4, MOV, AVI, MKV, MP3, WAV, AAC GPU/CPU :white_check_mark:
Web Content HTML CPU :x:

License

This project is licensed under the Apache 2.0 License, see the LICENSE :mortar_board: file for details.

Cite MMORE

If you use MMORE in your research, please cite the paper:

@inproceedings{sallinenm,
  title={M (M) ORE: Massive Multimodal Open RAG \& Extraction},
  author={Sallinen, Alexandre and Krsteski, Stefan and Teiletche, Paul and Marc-Antoine, Allard and Lecoeur, Baptiste and Zhang, Michael and Nemo, Fabrice and Kalajdzic, David and Meyer, Matthias and Hartley, Mary-Anne},
  booktitle={Championing Open-source DEvelopment in ML Workshop@ ICML25}
}

Star History Chart

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mmore-1.2.3.tar.gz (65.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mmore-1.2.3-py3-none-any.whl (147.1 kB view details)

Uploaded Python 3

File details

Details for the file mmore-1.2.3.tar.gz.

File metadata

  • Download URL: mmore-1.2.3.tar.gz
  • Upload date:
  • Size: 65.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mmore-1.2.3.tar.gz
Algorithm Hash digest
SHA256 71c57ca6980cb422421bed70ae6ca1a51eeba5835f51968f48136ed1b025d1f3
MD5 b7f878be6f38e295dfcb78dc90d3b0ed
BLAKE2b-256 a7b37cdaa274525dc60aa0ae8be280bc114e281d17ed1b78418fcbb6ae521d0a

See more details on using hashes here.

Provenance

The following attestation bundles were made for mmore-1.2.3.tar.gz:

Publisher: publish.yml on swiss-ai/mmore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mmore-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: mmore-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 147.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mmore-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 43ee38ea07475d88b2c607c5238aa3f31dd41a9e2af73585e6194f25cc06655f
MD5 a674277cf7faf7a38d082776939adeb6
BLAKE2b-256 a768bd5b3aefa4c0d40d565dc25c8316077f84f2a770884185c39848626f94e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for mmore-1.2.3-py3-none-any.whl:

Publisher: publish.yml on swiss-ai/mmore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page