22. Skip to content

22. Notebook tour

Use this index when you want an interactive workflow for inspecting intermediate objects, trying short code changes, and explaining one brick at a time.

22.1 How to use them

  • Clone the repository and install ModSSC locally.
  • Open the notebooks with your preferred notebook environment.
  • Run them from the repository root so relative paths like bench/configs/... and runs/ resolve naturally.

22.2 Notebook index

Notebook Focus Best after
notebooks/00_cli_tour.ipynb CLI entrypoints and command discovery Installation
notebooks/01_data_loader_end_to_end.ipynb dataset catalogs, providers, and loading Manage datasets
notebooks/02_sampling_quickstart.ipynb sampling plans and split artifacts Create and reuse sampling splits
notebooks/03_preprocess_quickstart.ipynb preprocess plans and outputs Run preprocessing plans
notebooks/04_data_augmentation_quickstart.ipynb augmentation plans and contexts How to use data augmentation
notebooks/05_views_quickstart.ipynb view plans and generated feature views How to generate multi-view features
notebooks/06_graph_quickstart.ipynb graph construction and graph-derived views How to build graphs and views
notebooks/07_supervised_quickstart.ipynb supervised baselines API reference: supervised
notebooks/08_inductive_quickstart.ipynb inductive SSL methods Inductive tutorial
notebooks/09_transductive_quickstart.ipynb transductive SSL methods Transductive tutorial
notebooks/10_hpo_bench_smoke.ipynb HPO bench workflow How to run hyperparameter search
notebooks/11_bench_run_anatomy.ipynb inspect run.json, artifacts, and bench outputs Benchmarks
notebooks/12_optional_extras_and_modalities.ipynb choose extras by workflow and inspect dataset requirements Optional extras and platform support
notebooks/13_official_vs_custom_splits.ipynb compare official test splits vs user-defined overrides Reproducibility

22.3 Which notebooks to open first

  • Start with 00_cli_tour.ipynb if you are still discovering the surface area.
  • Open 08_inductive_quickstart.ipynb or 09_transductive_quickstart.ipynb once you know which modeling family you need.
  • Open 11_bench_run_anatomy.ipynb when you want to understand exactly what the benchmark runner writes to disk.
Sources
  1. README.md
  2. notebooks/
  3. notebooks/00_cli_tour.ipynb
  4. notebooks/10_hpo_bench_smoke.ipynb
  5. notebooks/11_bench_run_anatomy.ipynb
  6. notebooks/12_optional_extras_and_modalities.ipynb
  7. notebooks/13_official_vs_custom_splits.ipynb