kedro icon indicating copy to clipboard operation
kedro copied to clipboard

Visualize hooks in Kedro-Viz

Open galenseilis opened this issue 1 year ago • 2 comments

Description

As per this request I am opening up this feature request. The general idea is for the hooks to be visualized in some way on Kedro-viz.

The only design aspect I would suggest is that the symbology on Kedro-Viz should reflect what type of triggers the hook has.

Context

When I open up a visualization by Kedro-Viz I would like to quickly learn about what things exist, including hooks. In the current state I would have to look into the source code to get an overview of the hooks currently registered for use in the product. The idea I like behind Kedro-Viz is to have a quick overview of any of the information processing specific to that project (i.e. stuff that isn't just native Kedro behaviour). To me getting at least a partial understanding of what hooks exist (and the type of triggers they have) would be helpful for this quick summary of a project.

Possible Implementation

I don't have any specific recommendations on implementation at this moment.

Possible Alternatives

  • Not everything needs to be visualized with Kedro-Viz

galenseilis avatar Jan 19 '24 02:01 galenseilis

An MVP showing the names of hooks register would be a great first start

Hooks fall into the following categories:

https://docs.kedro.org/en/stable/kedro.framework.hooks.specs.html

At a high level hooks basically fall into 3 categories:

  • Stuff that happens during the pipeline creation (not visalisable on the flow chart)
  • Stuff that happens during a pipeline run to every part of the pipeline (maybe visalisable on the flow chart)
  • Stuff that happens after a pipeline run (not visalisable on the flow chart)

datajoely avatar Jan 19 '24 11:01 datajoely

Backlog grooming notes:

To me getting at least a partial understanding of what hooks exist (and the type of triggers they have) would be helpful for this quick summary of a project.

@galenseilis thanks for this. Can you provide more context on what problem this solves for you.

NeroOkwa avatar Mar 25 '24 16:03 NeroOkwa