Skip to content

Getting started

The documentation site is built with MkDocs Material and reads the local Python modules directly from the repository root.

Install docs dependencies

python -m pip install -r requirements-docs.txt

Preview the site

mkdocs serve

Build a static version

mkdocs build

What you will find

  • A conceptual guide for the main noise models handled by the library.
  • A dedicated page for TabPFN-based filtering and local explainability.
  • An API reference generated directly from the public docstrings.

Tip

Run MkDocs from the repository root so the local filters and cleaners packages can be imported without any extra packaging step.