About the tutorial project#

PyKale Tutorials is the runnable-tutorial companion to PyKale, a library for multimodal learning and transfer learning on interdisciplinary data.

What this is#

Each tutorial is a self-contained folder: a narrated plot_<slug>.py that reads top to bottom and builds into a notebook, plus the full main.py experiment it is drawn from. Tutorials are organised by the domain that owns them — Others, Protein, Cancer, Cardiac and Materials — and every tutorial carries structured metadata (task, modality, difficulty, runtime, status) that drives the filters, learning paths and status page.

How it is built#

The site is a Sphinx project using Sphinx-Gallery to turn tutorial scripts into pages, notebooks and downloads, themed with the PyData Sphinx Theme. The catalogue in tutorial_catalog.yml is the single source of truth; domain pages, the homepage sections, thumbnails and the filterable catalogue are all generated from it.

See Contributing to add or improve a tutorial, and the roadmap for what is planned.