ben-denham / labtech

Easily run experiment permutations with multi-processing and caching
https://ben-denham.github.io/labtech/
GNU General Public License v3.0
7 stars 1 forks source link

Visualise experiment dependencies with Mermaid #5

Closed ben-denham closed 5 months ago

ben-denham commented 5 months ago

Add a function that accepts a list of tasks and generates a Mermaid class diagram to visualise the task types and dependencies between them.

  1. Each task type should be represented as a class with an attribute for each parameter.
  2. Each task type that is in a parameter (i.e. a dependency task) should be linked to with an aggregation relationship
    1. The cardinality of the relationship should depend on whether the parameter containing the dependency is a single task or a list/dict containing tasks.
    2. The relationship should be labelled with the parameter field.
  3. Add usage of the diagram generation to the readme, tutorial, and cookbook.
ben-denham commented 5 months ago

Added in 83e492a46