Documentation for Preview Dataset

docs/source/experiment_tracking.md

@@ -23,7 +23,7 @@ Kedro has always supported parameter versioning (as part of your codebase with a
 
 Kedro-Viz version 4.1.1 introduced metadata capture, visualisation, discovery and comparison, enabling you to access, edit and [compare your experiments](#access-run-data-and-compare-runs) and additionally [track how your metrics change over time](#view-and-compare-metrics-data).
 
-Kedro-Viz version 5.0 also supports the [display and comparison of plots, such as Plotly and Matplotlib](./visualise_charts_with_plotly.md). Support for metric plots (timeseries and parellel coords) was added to Kedro-Viz version 5.2.1.
+Kedro-Viz version 5.0 also supports the [display and comparison of plots, such as Plotly and Matplotlib](./preview_plotly_datasets.md). Support for metric plots (timeseries and parellel coords) was added to Kedro-Viz version 5.2.1.
 
 Kedro-Viz version 6.2 includes support for collaborative experiment tracking using a cloud storage solution. This means that multiple users can store their experiment data in a centralized remote storage, such as AWS S3, and access it through Kedro-Viz.
 

docs/source/index.md

@@ -29,7 +29,5 @@ Take a look at the <a href="https://demo.kedro.org/" target="_blank" rel="noopen
 kedro-viz_visualisation
 share_kedro_viz
 preview_datasets
-visualise_charts_with_plotly
-visualise_charts_with_matplotlib
 experiment_tracking
 ```

docs/source/preview_custom_datasets.md

@@ -0,0 +1,24 @@
+# Extend Preview to Custom Datasets
+
+When creating a custom dataset, if you wish to enable data preview for that dataset, you must implement a `preview()` function within the custom dataset class. Kedro-viz currently supports previewing Tables, Plotly charts, Images, and JSON objects.
+
+The return type of the `preview()` function should match one of the following types, as defined in the `kedro-datasets` source code (_typing.py file):
+
+```python
+TablePreview = NewType("TablePreview", dict)
+ImagePreview = NewType("ImagePreview", bytes)
+PlotlyPreview = NewType("PlotlyPreview", dict)
+JSONPreview = NewType("JSONPreview", dict)
+```
+
+Below is an example demonstrating how to implement the preview() function for a CustomDataset class that utilizes TablePreview to enable previewing tabular data on Kedro-viz:
+
+```python 
+
+from kedro_datasets._typing import TablePreview
+
+class CustomDataset:
+    def preview(self, nrows: int = 5) -> TablePreview:
+        # Add logic for generating preview
+        pass
+```

docs/source/preview_datasets.md

@@ -1,84 +1,62 @@
-# Preview data in Kedro-Viz
+# Preview datasets in Kedro-Viz
 
-This page describes how to preview data from different datasets in a Kedro project with Kedro-Viz. Dataset preview was introduced in Kedro-Viz version 6.3.0, which offers preview for `CSVDatasets` and `ExcelDatasets`.
+To provide users with a glimpse of their datasets within a Kedro project, Kedro-Viz offers a preview feature. This feature was introduced in Kedro-Viz version 6.3.0 and expanded upon in version 8.0.0. Initially, it supported `CSVDatasets` and `ExcelDatasets`, and was later extended to encompass additional dataset types such as `PlotlyDatasets` and image datasets like `MatplotlibWriter`.
 
-We use the {doc}`spaceflights tutorial<kedro:tutorial/spaceflights_tutorial>` to demonstrate how to add data preview for the `customer`, `shuttle` and `reviews` datasets. Even if you have not yet worked through the tutorial, you can still follow this example; you'll need to use the Kedro starter for the spaceflights tutorial to generate a copy of the project with working code in place.
 
-If you haven't installed Kedro {doc}`follow the documentation to get set up<kedro:get_started/install>`. 
+Currently, Kedro-Viz supports four types of previews:
 
-```{important}
-We recommend that you use the same version of Kedro that was most recently used to test this tutorial (0.19.0). To check the version installed, type `kedro -V` in your terminal window.
-```
+1. **TablePreview:** For datasets returning tables/dataframes.
+2. **JSONPreview:** For datasets returning JSON objects.
+3. **PlotlyPreview:** For datasets returning Plotly JSON objects.
+4. **ImagePreview:** For datasets returning base64-encoded image strings.
 
-In your terminal window, navigate to the folder you want to store the project. Generate the spaceflights tutorial project with all the code in place by using the [Kedro starter for the spaceflights tutorial](https://github.com/kedro-org/kedro-starters/tree/main/spaceflights-pandas):
+While we currently support the aforementioned datasets, we are soon going to extend this functionality to include other datasets. Users with custom datasets can also expand the preview functionality, and we will cover that in the following sections.
 
+```{note}
+Starting from Kedro-Viz version 8.0.0, the preview functionality on Kedro-Viz is now opt-out. For versions preceding this, you were required to specify `preview-args` for the preview to be enabled.
 
-```bash
-kedro new --starter=spaceflights-pandas
+By default, preview is now enabled for datasets. If you wish to disable preview for datasets, please refer to the [Disable Preview section](./preview_datasets.md#disabling-previews) for instructions.
 ```
 
-When prompted for a project name, you can enter anything, but we will assume `Spaceflights` throughout.
-
-When your project is ready, navigate to the root directory of the project.
+**Preview Tabular Data**
 
-## Configure the Data Catalog
+The page titled [Preview Tabular Data in Kedro-viz](./preview_pandas_datasets.md) contains a spaceflight tutorial that explains how you can enable preview on Tabular datasets such as `pandas.CSVDataset` and `pandas.ExcelDataset`.
 
-Kedro-Viz version 6.3.0 currently supports preview of two types of datasets:
+**Preview Plotly Charts**
 
-* `pandas.CSVDataset`
-* `pandas.ExcelDataset`
+The page titled [Preview Plotly charts in Kedro-viz](./preview_plotly_datasets.md) contains a spaceflight tutorial that explains how you can create interactive visualizations using `PlotlyDatasets` on Kedro-viz.
 
+**Preview Matplotlib Charts**
 
-To enable dataset preview, add the `preview_args` attribute to the kedro-viz configuration under the `metadata` section in the Data Catalog. Within preview_args, specify `nrows` as the number of rows to preview for the dataset.
+The page titled [Preview Matplotlib charts in Kedro-viz](./preview_matplotlib_datasets.md) contains a spaceflight tutorial that explains how you can create static visualizations using `MatplotlibWriterDataset` on Kedro-viz.
 
-```yaml
-companies:
-  type: pandas.CSVDataSet
-  filepath: data/01_raw/companies.csv
-  metadata:
-    kedro-viz:
-      layer: raw
-      preview_args:
-          nrows: 5
+**Extend Preview to Custom Datasets**
 
-reviews:
-  type: pandas.CSVDataSet
-  filepath: data/01_raw/reviews.csv
-  metadata:
-    kedro-viz:
-      layer: raw
-      preview_args:
-          nrows: 10
+The page titled [Extend Preview to Custom Datasets](./preview_custom_datasets.md) contains information on how to set up previews for custom datasets and which types are supported by Kedro-Viz.
 
-shuttles:
-  type: pandas.ExcelDataSet
-  filepath: data/01_raw/shuttles.xlsx
-  metadata:
-    kedro-viz:
-      layer: raw
-      preview_args:
-          nrows: 15
+```{toctree}
+:maxdepth: 1
+:hidden:
+preview_matplotlib_datasets
+preview_plotly_datasets
+preview_pandas_datasets
+preview_custom_datasets
 ```
 
 
 
-## Previewing Data on Kedro-viz
+## Disabling Previews
 
-After you've configured the Data Catalog, you can preview the datasets on Kedro-Viz. Start Kedro-Viz by running the following command in your terminal:
-
-```bash
-kedro viz run
-```
-
-The previews are shown as follows:
-
-Click on each dataset node to see a small preview in the metadata panel:
 
+To disable dataset previews for specific datasets, you need to set `preview: false` under the kedro-viz key within the metadata section of your conf.yml file. Here's an example configuration:
 
-![](./images/preview_datasets_metadata.png)
-
-
-View the larger preview of the dataset by clicking the `Expand Preview Table` button on the bottom of the metadata panel.
-
+```yaml
+companies:
+  type: pandas.CSVDataSet
+  filepath: data/01_raw/companies.csv
+  metadata:
+    kedro-viz:
+      layer: raw
+      preview: false
+```
 
-![](./images/preview_datasets_expanded.png)

docs/source/visualise_charts_with_matplotlib.md → docs/source/preview_matplotlib_datasets.md

@@ -1,10 +1,10 @@
-# Visualise charts in Kedro-Viz with Matplotlib
+# Preview Matplotlib charts in Kedro-viz 
 
-This page describes how to output interactive visualisations of a Kedro project with Kedro-Viz, which supports integration with [Matplotlib](https://matplotlib.org/). You can view Matplotlib charts in Kedro-Viz when you use the MatplotLibWriter dataset.
+This page describes how to output static visualisations of a Kedro project with Kedro-Viz, which supports integration with [Matplotlib](https://matplotlib.org/). You can view Matplotlib charts in Kedro-Viz when you use the MatplotLibWriter dataset.
 
 
 ```{note}
-The MatplotlibWriter dataset converts Matplotlib objects to image files. This means that Matplotlib charts within Kedro-Viz are static and not interactive, unlike the [Plotly charts seen separately](./visualise_charts_with_plotly.md).
+The MatplotlibWriter dataset converts Matplotlib objects to image files. This means that Matplotlib charts within Kedro-Viz are static and not interactive, unlike the [Plotly charts seen separately](./preview_plotly_datasets.md).
 ```
 
 We use the {doc}`spaceflights tutorial<kedro:tutorial/spaceflights_tutorial>` and add a reporting pipeline. Even if you have not yet worked through the tutorial, you can still follow this example; you'll need to use the Kedro starter for the spaceflights tutorial to generate a copy of the project with working code in place.

docs/source/preview_pandas_datasets.md

@@ -0,0 +1,74 @@
+# Preview Tabular Data in Kedro-viz
+
+We use the {doc}`spaceflights tutorial<kedro:tutorial/spaceflights_tutorial>` to demonstrate how to add data preview for the `customer`, `shuttle` and `reviews` datasets. Even if you have not yet worked through the tutorial, you can still follow this example; you'll need to use the Kedro starter for the spaceflights tutorial to generate a copy of the project with working code in place.
+
+If you haven't installed Kedro {doc}`follow the documentation to get set up<kedro:get_started/install>`. 
+
+```{important}
+We recommend that you use the same version of Kedro that was most recently used to test this tutorial (0.19.0). To check the version installed, type `kedro -V` in your terminal window.
+```
+
+In your terminal window, navigate to the folder you want to store the project. Generate the spaceflights tutorial project with all the code in place by using the [Kedro starter for the spaceflights tutorial](https://github.com/kedro-org/kedro-starters/tree/main/spaceflights-pandas):
+
+
+```bash
+kedro new --starter=spaceflights-pandas
+```
+
+When prompted for a project name, you can enter anything, but we will assume `Spaceflights` throughout.
+
+When your project is ready, navigate to the root directory of the project.
+
+## Configure the Data Catalog
+
+Kedro-Viz version 8.0.0 supports previews for two types of tabular datasets: pandas.CSVDataset and pandas.ExcelDataset. Previews are enabled by default, showing the first 5 rows unless otherwise specified using preview_args.
+
+Example configuration in catalog.yml:
+
+```yaml
+companies:
+  type: pandas.CSVDataSet
+  filepath: data/01_raw/companies.csv
+
+reviews:
+  type: pandas.CSVDataSet
+  filepath: data/01_raw/reviews.csv
+  metadata:
+    kedro-viz:
+      layer: raw
+      preview_args:
+          nrows: 10
+
+shuttles:
+  type: pandas.ExcelDataSet
+  filepath: data/01_raw/shuttles.xlsx
+  metadata:
+    kedro-viz:
+      layer: raw
+      preview_args:
+          nrows: 15
+```
+
+If no preview_args are specified, the default preview will show the first 5 rows.
+
+
+## Previewing Data on Kedro-viz
+
+After you've configured the Data Catalog, you can preview the datasets on Kedro-Viz. Start Kedro-Viz by running the following command in your terminal:
+
+```bash
+kedro viz run
+```
+
+The previews are shown as follows:
+
+Click on each dataset node to see a small preview in the metadata panel:
+
+
+![](./images/preview_datasets_metadata.png)
+
+
+View the larger preview of the dataset by clicking the `Expand Preview Table` button on the bottom of the metadata panel.
+
+
+![](./images/preview_datasets_expanded.png)

docs/source/visualise_charts_with_plotly.md → docs/source/preview_plotly_datasets.md

@@ -1,4 +1,4 @@
-# Visualise charts in Kedro-Viz with Plotly
+# Preview Plotly charts in Kedro-viz
 
 This page describes how to make interactive visualisations of a Kedro project with Kedro-Viz, which supports integration with [Plotly](https://plotly.com/python/).