Repository navigation
Restructure Tutorials on Documentation Website #331
Description
Activity
TODO: Go through all existing tutorial notebooks and:
- make sure they're still valid (not just
pytest --nbmakebut that they make sense) - introduce new sections on
EventGraph,HigherOrderGraph, - probably move
Higher Order Models->Multi Order Models?
- make sure they're still valid (not just
As I just discussed with @vineetbansal. Based on the titles of the notebooks that we currently have on our documentation webpage and the new polnets-tutorials, I suggest the following structure for our website:
- Getting Started:
- Installation:
- Dependencies
- Install Stable Release
- Install Latest Development Version
- Optional Visualisation Backends
- Docker Installation
- Tutorials
- Basic Concepts
- Temporal Graphs
- Interactive Graph Visualisation
- Temporal Graph Visualisation using Manim
- Generative Models for Random Graphs
- Graph Learning in Netzschleuder Data
-
- polnets tutorials 01-01 to 01-03 and 02-01 (might be overlapping with existing tutorials and probably need to be reordered)
- Installation:
- Advanced Concepts (The old "Tutorial" section renamed):
- Causality-Aware Temporal Network Analysis
- Path Data and Higher-Order Models
- Higher-Order Models for Time-Respecting Paths
-
- polnets tutorials 02-02 to 02-04
- Causality-Aware Temporal Graph Learning
- Causality-Aware GNNs
-
- polnets tutorials 02-05 and 02-06
- Extending PathpyG
- Implementation Concepts
- Develop your own plot Functions
- Causality-Aware Temporal Network Analysis
It could be useful if we had one or two additional tutorials covering
higher-order representations of paths and temporal networksthat explain the newEventGraphandHigherOrderGraphclasses. I don't think they're covered in the current notebooks yet.I haven't had a detailed look at the polnets tutorials yet, but based on the titles, this structure looks reasonable. In my opinion, the remaining polnets tutorials I haven't mentioned aren't related to PathpyG and don't need to be on the documentation webpage.
- Getting Started:
Restructure the tutorials so that most of the basics are available on the documentation webpage under "Getting Started" instead of "Tutorial". "Tutorial" should instead contain the advanced concepts from https://github.com/pathpy/2026-polnets-tutorials.