Merge branch 'master' into fix/fix_type_errors_fab

Author: fabnemEPFL

.github/workflows/pyright.yml

@@ -0,0 +1,34 @@
+name: 📐 Pyright type checks
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  pyright:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install uv and create venv
+        run: |
+          pipx install uv
+          uv venv .venv
+
+      - name: Install dependencies
+        run: |
+          source .venv/bin/activate
+          uv pip install -e ".[process,index,rag,api,cpu,dev,websearch]"
+
+      - name: Run Pyright
+        continue-on-error: true
+        run: |
+          source .venv/bin/activate
+          pyright

.github/workflows/sphinx-docs.yml

@@ -0,0 +1,57 @@
+name: Deploy Sphinx documentation
+
+on:
+  push:
+    branches: ["master"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docs/requirements.txt
+
+      - name: Build Sphinx HTML
+        run: |
+          sphinx-build -b html docs/source docs/_build/html
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -114,6 +114,7 @@ venv.bak/
 # Milvus DB
 db/
 *.db
+*.db.lock
 
 # Project files
 tmp/

README.md

@@ -16,7 +16,13 @@
 
 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](https://openreview.net/forum?id=6j1HjfIdKn)
+👉 Read the paper for more details (arXiv): [MMORE: Massive Multimodal Open RAG & Extraction](https://arxiv.org/abs/2509.11937)
+
+
+### Documentation
+
+👉 Read the full documentation here: [MMORE Documentation](https://swiss-ai.github.io/mmore/).
+
 
 ## :bulb: Quickstart
 
@@ -60,6 +66,8 @@ brew install cairo pango gdk-pixbuf libffi
 uv pip install weasyprint
 ```
 
+You can also run MMORE on Windows by following our [Windows setup notes](docs/source/getting_started/windows.md).
+
 #### Step 1 – Install MMORE
 
 Dependencies are split by pipeline stage. Install only what you need:
@@ -97,6 +105,22 @@ uv pip install "mmore[process,cpu]"
 
 > :warning: **Check the instructions for contributors directly at [`docs/for_devs.md`](./docs/for_devs.md)**
 
+### Interactive TUI
+
+Prefer a guided experience over editing YAML by hand? Install the `tui` extra and launch the interactive Terminal UI:
+
+```bash
+uv sync --extra tui
+mmore tui
+```
+
+From the launcher you can:
+
+- run any stage (process / postprocess / index / rag / chat) interactively,
+- chain the full pipeline (process → postprocess → index → chat),
+- generate stage YAML configs through a guided wizard,
+- pick from existing example configs without leaving the terminal.
+
 ### 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.

docker/arch/Dockerfile

@@ -55,5 +55,8 @@ RUN uv pip install --no-cache --no-deps -e .
 # --- Runtime ---
 ENV PATH="/app/.venv/bin:$PATH"
 ENV DASK_DISTRIBUTED__WORKER__DAEMON=False
+ENV HF_HOME="/home/mmoreuser/.cache/huggingface"
+ENV TORCH_HOME="/home/mmoreuser/.cache/torch"
+ENV XDG_CACHE_HOME="/home/mmoreuser/.cache"
 
 ENTRYPOINT ["/bin/bash"]

docker/arch/README.md

@@ -33,8 +33,8 @@ sudo docker build -f docker/arch/Dockerfile --build-arg USER_UID=$(id -u) --buil
 
 ```bash
 # GPU
-sudo docker run --gpus all -it -v ./examples:/app/examples -v ./.cache:/mmoreuser/.cache mmore:arch
+sudo docker run --gpus all -it -v ./examples:/app/examples -v ./.cache:/home/mmoreuser/.cache mmore:arch
 
 # CPU-only
-sudo docker run -it -v ./examples:/app/examples -v ./.cache:/mmoreuser/.cache mmore:arch-cpu
+sudo docker run -it -v ./examples:/app/examples -v ./.cache:/home/mmoreuser/.cache mmore:arch-cpu
 ```

docker/leap/Dockerfile

@@ -44,5 +44,8 @@ RUN .venv/bin/uv pip install --no-cache --no-deps -e .
 # --- Runtime ---
 ENV PATH="/app/.venv/bin:$PATH"
 ENV DASK_DISTRIBUTED__WORKER__DAEMON=False
+ENV HF_HOME="/root/.cache/huggingface"
+ENV TORCH_HOME="/root/.cache/torch"
+ENV XDG_CACHE_HOME="/root/.cache"
 
 ENTRYPOINT ["/bin/bash"]

docker/ubuntu/Dockerfile

@@ -53,5 +53,8 @@ RUN .venv/bin/uv pip install --no-cache --no-deps -e .
 # --- Runtime ---
 ENV PATH="/app/.venv/bin:$PATH"
 ENV DASK_DISTRIBUTED__WORKER__DAEMON=False
+ENV HF_HOME="/home/mmoreuser/.cache/huggingface"
+ENV TORCH_HOME="/home/mmoreuser/.cache/torch"
+ENV XDG_CACHE_HOME="/home/mmoreuser/.cache"
 
 ENTRYPOINT ["/bin/bash"]

docker/ubuntu/README.md

@@ -40,8 +40,8 @@ sudo docker build -f docker/ubuntu/Dockerfile --build-arg USER_UID=$(id -u) --bu
 
 ```bash
 # GPU
-sudo docker run --gpus all -it -v ./examples:/app/examples -v ./.cache:/mmoreuser/.cache mmore
+sudo docker run --gpus all -it -v ./examples:/app/examples -v ./.cache:/home/mmoreuser/.cache mmore
 
 # CPU-only
-sudo docker run -it -v ./examples:/app/examples -v ./.cache:/mmoreuser/.cache mmore:cpu
+sudo docker run -it -v ./examples:/app/examples -v ./.cache:/home/mmoreuser/.cache mmore:cpu
 ```

docs/Makefile

@@ -0,0 +1,11 @@
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+.PHONY: html clean
+
+html:
+	$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"
+
+clean:
+	rm -rf "$(BUILDDIR)"