question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Provide simple mechanism for adding icons to datasets

See original GitHub issue

Description

Is your feature request related to a problem? A clear and concise description of what the problem is: “I’m always frustrated when …”

Users can label their dataset in the catalog and provide layers - but there is very little they can do to differentiate datasets beyond this from a visual perspective. Adding the facility to apply an icon from an existing library of icons would be an effective mechanism for making the pipeline visualisation a clearer and more efficient story-telling tool.

Context

Why is this change important to you? How would you use it? How can it benefit other users?

A simple example for where this would be useful would be to allow users to mark Excel datasources vs SQL datasources at a glance, even more so in the collapsed label-less view.

Possible Implementation

(Optional) Suggest an idea for implementing the addition or change.

On the YAML catalog side there could be an extra key for icon like so:


flight_times:
    type: pandas.CSVDataSet
    layer: raw
    load_args:
          sep: '|'
    icon: carbon-csv

This could pull in the following icon from the Carbon design system (by IBM): provided by the iconfiy framework which collects several open source icon libraries. https://iconify.design/icon-sets/carbon/csv.html

By using the [iconfiy-react](https://github.com/iconify/iconify-react) library this would hopefully be a low effort addition

Checklist

  • Include labels so that we can categorise your feature request

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:1
  • Comments:7 (4 by maintainers)

github_iconTop GitHub Comments

5reactions
nicolasboisseaucommented, Aug 16, 2022

Such a feature would be nice, not only at the dataset level, but also at the node level.

Personally when I make pipelines with kedro i try to make nodes responsible for only one main activity (that can be clearly explained to others). It would be nice to represent each node in kedro viz with an icon summarizing the main task the node is doing. e.g. clean, stack, join, filter, train, predict…

And naturally as you said in the issue title, it can be also interesting to identify the dataset types based on their icon, giving a hint to a data source origin : csv, sql, excel file, as a pipeline is often a mix of various dataset types…

Possibilities are quite numerous if a good icon collection can be provided!

2reactions
b4rlwcommented, Aug 16, 2022

I would second this. Could help keep the pipeline maintainer right as well as improve comprehension among a non-technical audience. It should go without saying that it should not be compulsory, however. Perhaps could be toggled in Viz.

To play devil’s advocate, I would also say that the wrong implementation could add unnecessary complexity. Should Kedro be Laissez-faire about what icon packs can be used? If so, would it still be easy in most cases to distinguish the difference between a node and a dataset? Should the user be able to specify custom icons for their custom datasets? If yes, would certain visualisations begin to look messy? If no, could things look incomplete? Would the OCD among us end up spending more time customising icons than writing code? lol.

I think it’s a great idea, but only with the right design choices. Users frequently say they like Kedro because it’s opinionated, so whatever the implementation is, it should be congruent with that broader ethos.

That’s my two pence anyways!

Read more comments on GitHub >

github_iconTop Results From Across the Web

What is Data Labeling and How to Do It Efficiently [Tutorial]
Data labeling is the process of assigning labels to data. Explore different types of data labeling, and learn how to do it efficiently....
Read more >
Add Icons to CRM Analytics Charts - Salesforce Help
To add icons to a chart, use a dataset with an ungrouped URL dimension whose values are URLs to the icon images. For...
Read more >
Icon Library | Google Cloud
Official icons and sample diagrams​​ Quick reference for all Google cloud products. Design your solution using Google Slides. Download the cards (ZIP). Download ......
Read more >
Using data attributes - Learn web development | MDN
To get a data attribute through the dataset object, get the property ... In addition, search crawlers may not index data attributes' values....
Read more >
Computing Simple Mechanisms: Lift-and-Round over ... - arXiv
Moreover, the computed mechanism has a simple structure: It is ... that allow us to search over the space of mechanisms efficiently: (i)...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found