Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add highlight to kedro-viz section of dataset.metadata to highlight it in the UI #1807

Closed
1 task
yury-fedotov opened this issue Mar 15, 2024 · 1 comment
Closed
1 task

Comments

@yury-fedotov
Copy link
Contributor

yury-fedotov commented Mar 15, 2024

Description

Add highlight to kedro-viz section of dataset.metadata to highlight it in the UI as a "key dataset" - e.g. with yellow background fill and black text.

Context

I'm regularly walking the team / audience through the kedro viz UI and almost always, on this huge DAG representation there are 2-3 datasets which are really the key artifacts I explain the flow in respect to.

Usually those are:

  • Master table
  • Trained model

Using modular pipelines, and hence leveraging the collapsing supernodes, is incredibly helpful is simplifying the DAG view and visually tracking where those key artifacts are. However, I though that since the metadata injection logic already exists in the kedro viz (e.g. adding layer to datasets), I thought that if the group decides that this feature is useful, it might be relatively easy to implement.

Possible Implementation

So the most elegant way I see is to do this exactly like e.g. layer can be added to a dataset in its catalog definition.

For example, let's say the trained_model is the one I want to highlight. See where I'm adding highlight: true:

# catalog.yml

trained_model:
  type: ...
  filepath ...
  metadata:
    kedro-viz:
      layer: models
      highlight: true

Possible Alternatives

Probably the above is the most natural place for this functionality to live, so not sure.

Checklist

  • Include labels so that we can categorise your feature request
@astrojuanlu
Copy link
Member

Thanks for opening this issue @yuryfedotov-mck !

@rashidakanchwala @NeroOkwa I think this is somewhat related to #1148, adds support for my idea of having a metadata.kedro-viz.style key (or even... support custom CSS????)

@rashidakanchwala rashidakanchwala moved this to Inbox in Kedro-Viz Apr 8, 2024
@kedro-org kedro-org locked and limited conversation to collaborators Apr 8, 2024
@rashidakanchwala rashidakanchwala converted this issue into discussion #1852 Apr 8, 2024
@github-project-automation github-project-automation bot moved this from Inbox to Done in Kedro-Viz Apr 8, 2024

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Projects
Status: Done
Development

No branches or pull requests

3 participants