Design for Kedro Viz @preview datasets
See original GitHub issueDescription
This ticket is a design ticket based off the technical discussion we had for #907.
The below implementation for dataset preview was agreed upon : If a user wants to preview a dataset on Kedro-viz, he/she will have to add ‘@preview’ to the dataset name in the catalog.yml.
companies@preview:
type: pandas.CSVDataSet
filepath: data/01_raw/companies.csv
layer: raw
Kedro-viz will then read this and based on the dataset type (parquet, CSV etc) it will handle the preview accordingly.
For the MVP - we are going to stick to showing the first 5(TBD by design) rows (in the metadata preview mode) and first 10(TBD by design) rows (in the expanded modal mode)
The output of this ticket will be FIGMA designs showing preview tables in the metadata panel, as well as in modals.
Context
Kedro-viz has been used by users to
- Debug their pipeline - now they will also be able to preview the datasets that will help them understand more
- Tell their story - now they will also be able to share what different datasets look like when they discuss Kedro-viz with non-technical audience.
Checklist
- Include labels so that we can categorise your feature request
Issue Analytics
- State:
- Created a year ago
- Reactions:1
- Comments:12 (4 by maintainers)
Top Results From Across the Web
Get started with Kedro-Viz - Read the Docs
Kedro -Viz is a key part of Kedro. It displays data and nodes, and the connections between them, to visualise the structure of...
Read more >Kedro-Viz Pipeline Visualisation - GitHub
Kedro -Viz is an interactive development tool for building data science pipelines with Kedro. Kedro-Viz also allows users to view and compare different...
Read more >Visualise your Kedro data pipelines.
Usage: kedro viz [OPTIONS] Visualise a Kedro pipeline using Kedro-Viz. Options: --host TEXT Host that viz will listen to. Defaults to localhost.
Read more >Building a Production-Level Data Pipeline Using Kedro
Kedro's pipeline visualisation tool, named kedro-viz ... on how to build and visualise your data and ML pipelines with an example dataset.
Read more >ML Metadata Store: What It Is, Why It Matters, and How to ...
Artifacts could be datasets, models, predictions, and other file-like objects. For artifacts you may want ... Pipeline visualization in Kedro-Viz | Source.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
looks great 😃
i think we can restrict the number of rows in preview to 5 and expanded modal to 10 because we don’t want to load a lot of data – it will be too heavy on the viz.
but i didn’t account for the table wideness i.e. number of columns – and this looks cool. We will have to give users to the option to horizontal scroll but maybe we can have that option only when it is expanded and not in preview
Ok cool, that makes sense
So this is only accessible from the Flowchart side