Add documentation on how to visualise Matplotlib plots on Kedro-Viz #1820

AhdraMeraliQB · 2022-08-30T10:09:12Z

Description

Addresses comments raised in #1704. Kedro-Viz now allows for Matplotlib images to be visualised in the pipeline and metadata panel. This PR adds instructions on how to do so to the documentation.

Development notes

Checklist

Read the contributing guidelines
Opened this PR as a 'Draft Pull Request' if it is work-in-progress
Updated the documentation to reflect the code changes
Added a description of this change in the RELEASE.md file
Added tests to cover my changes

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

…o into docs/add-matplotlib-plots

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

antonymilne

This looks great! I left a few initial comments for now, but some general points:

this is one example where I think it's worth doing make build-docs and checking how it renders, if you didn't already do so
some of our markdown syntax (e.g. hyperlinks, note callouts) is not at all obvious because it's specific to the sphinx build process and sometimes has some weird RST mixed in. It's worth taking a quick look through other .md pages to see how we do things
way outside the scope of this, so don't do it here... but the kedro-viz documentation is rapidly outgrowing the Tutorial section of our docs (which originally just covered the spaceflights tutorial really). We need to find a better place for it to live
love the clear commit message! 💯

docs/source/tutorial/visualise_pipeline.md

antonymilne · 2022-09-02T09:15:41Z

docs/source/tutorial/visualise_pipeline.md


-[Plotly](https://plotly.com/python/) is a free and open source Python library that allows you to make interactive, publication-quality graphs. With the Plotly integration on Kedro-Viz, you can output your interactive charts as part of your pipeline visualisation.
+Kedro-Viz aims to help users communicate different aspects of their workflow through an interactive flowchart. With the Plotly and Matplotlib integrations, we take one step further in this direction to allow our users to share their data insights effectively while exploring the pipeline.


Outside the scope of your change I know, but I'm personally not a big fan of this paragraph. It feels too vague and marketing-ese to me. Feel free to change it as you please or leave it as it is depending on what you think.

@rashidakanchwala any thoughts on how to restructure this?

No idea, i personally liked this because it excites the user (by technically advertising the feature) but i agree with Antony too.

i will let @yetudada comment.

I wouldn't remove it completely - but I would suggest a modification. We describe Kedro-Viz here and also at the top of the page so I would remove the first sentence because we don't need to do it twice.

So it could be something like: "Kedro-Viz supports Plotly and Matplotlib integrations so that you can share your data insights while exploring your pipeline."

docs/source/tutorial/visualise_pipeline.md

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Co-authored-by: Tynan DeBold <thdebold@gmail.com>

Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com>

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

rashidakanchwala

LGTM!

rashidakanchwala · 2022-09-05T13:08:02Z

docs/source/tutorial/visualise_pipeline.md


-[Plotly](https://plotly.com/python/) is a free and open source Python library that allows you to make interactive, publication-quality graphs. With the Plotly integration on Kedro-Viz, you can output your interactive charts as part of your pipeline visualisation.
+Kedro-Viz aims to help users communicate different aspects of their workflow through an interactive flowchart. With the Plotly and Matplotlib integrations, we take one step further in this direction to allow our users to share their data insights effectively while exploring the pipeline.


No idea, i personally liked this because it excites the user (by technically advertising the feature) but i agree with Antony too.

i will let @yetudada comment.

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

merelcht

Great work! ⭐ This is a really clear and easy to follow section.

docs/source/tutorial/visualise_pipeline.md

merelcht · 2022-09-08T14:49:43Z

docs/source/tutorial/visualise_pipeline.md

+reporting.dummy_confusion_matrix:
+  type: matplotlib.MatplotlibWriter
+  filepath: ${base_location}/08_reporting/dummy_confusion_matrix.png
+  versioned: true


It might be useful to add a sentence about why versioned: true has been set here.

Good point! Added an explanation in 14d7b98.

Co-authored-by: Merel Theisen <49397448+MerelTheisenQB@users.noreply.github.com>

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

…o into docs/add-matplotlib-plots

…edro-org#1820) * Change demo gif to include plots Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add section about plots in experiment tracking view Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add gif of plot comparison Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Replace run list screenshot to include plots Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Replace large demo to include plots Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Separate existing docs into two sections under common subheading Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add description to Matplotlib section Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add Matplotlib node example Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Change image name Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Add screenshots to example Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Lint changes Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update images to include all charts Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update docs/source/tutorial/set_up_experiment_tracking.md Co-authored-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> * Update docs/source/tutorial/set_up_experiment_tracking.md Co-authored-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> * Add suggestions from review Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update docs/source/tutorial/set_up_experiment_tracking.md Co-authored-by: Tynan DeBold <thdebold@gmail.com> * Change heading tense Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com> * Change api link to relative Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com> * Change inline code to code block to follow convention Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com> * Change to Sphinx syntax Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com> * Remove empty lines Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com> * Edit paragraph Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com> * Replace randomised node Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Fix typo and move note Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Fix linting Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Change Kedro-Viz plot visualisations description Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> * Update docs/source/tutorial/visualise_pipeline.md Co-authored-by: Merel Theisen <49397448+MerelTheisenQB@users.noreply.github.com> * Add explanation for versioned flag Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com> Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com> Co-authored-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Co-authored-by: Tynan DeBold <thdebold@gmail.com> Co-authored-by: Merel Theisen <49397448+MerelTheisenQB@users.noreply.github.com> Signed-off-by: nickolasrm <nickolasrochamachado@gmail.com>

Ahdra Merali and others added 6 commits August 26, 2022 16:02

Vhange demo gif to include plots

81ab6b0

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Add sction about plots in experiment tracking view

14d7849

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Add gif of plot comparison

c3dd034

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Replace run list screenshot to include plots

deb0f67

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Replace large demo to include plots

84d4b04

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Merge branch 'main' into docs/plots-on-exp-tracking

613086c

AhdraMeraliQB changed the title ~~Docs/add matplotlib plots~~ Add documentation on how to visualise Matplotlib plots on Kedro-Viz Aug 30, 2022

Ahdra Merali and others added 3 commits August 30, 2022 13:10

Separate existing docs into two sections under common subheading

46bf8d4

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Add description to Matplotlib section

3ed0cf0

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Merge branch 'main' into docs/add-matplotlib-plots

10118ad

AhdraMeraliQB linked an issue Aug 30, 2022 that may be closed by this pull request

Documentation on how to visualise Matplotlib plots on Kedro-Viz #1704

Closed

Ahdra Merali added 4 commits August 30, 2022 16:00

Add Matplotlib node example

c91b24a

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Merge branch 'docs/add-matplotlib-plots' of github.com:kedro-org/kedr…

ef31650

…o into docs/add-matplotlib-plots

Change image name

76b15c9

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Add screenshots to example

b68225d

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

AhdraMeraliQB requested review from rashidakanchwala, jmholzer and tynandebold August 31, 2022 09:43

AhdraMeraliQB marked this pull request as ready for review August 31, 2022 09:43

AhdraMeraliQB requested a review from yetudada as a code owner August 31, 2022 09:43

Ahdra Merali added 2 commits August 31, 2022 10:50

Lint changes

f434524

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Update images to include all charts

5fe23a8

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

antonymilne reviewed Sep 2, 2022

View reviewed changes

docs/source/tutorial/visualise_pipeline.md Outdated Show resolved Hide resolved

antonymilne changed the base branch from main to docs/plots-on-exp-tracking September 2, 2022 09:36

antonymilne requested a review from idanov as a code owner September 2, 2022 09:36

antonymilne changed the base branch from docs/plots-on-exp-tracking to main September 2, 2022 09:36

antonymilne changed the base branch from main to docs/plots-on-exp-tracking September 2, 2022 10:05

antonymilne added 2 commits September 2, 2022 11:06

Merge branch 'main' into docs/plots-on-exp-tracking

dfd66e0

Merge branch 'docs/plots-on-exp-tracking' into docs/add-matplotlib-plots

be548f5

Ahdra Merali and others added 13 commits September 5, 2022 13:19

Add suggestions from review

d77f4cb

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Update docs/source/tutorial/set_up_experiment_tracking.md

fd77271

Co-authored-by: Tynan DeBold <thdebold@gmail.com>

Merge branch 'main' into docs/plots-on-exp-tracking

b7595af

Change heading tense

259dd81

Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com>

Change api link to relative

943e8f3

Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com>

Change inline code to code block to follow convention

6d9a299

Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com>

Change to Sphinx syntax

d66e621

Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com>

Remove empty lines

2cee8eb

Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com>

Edit paragraph

86e93af

Co-authored-by: Antony Milne <49395058+AntonyMilneQB@users.noreply.github.com>

Replace randomised node

638e793

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Fix typo and move note

2ce2e1f

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Fix linting

7433085

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Merge branch 'docs/plots-on-exp-tracking' into docs/add-matplotlib-plots

7b1afe2

AhdraMeraliQB requested a review from rashidakanchwala September 5, 2022 12:50

rashidakanchwala approved these changes Sep 5, 2022

View reviewed changes

tynandebold mentioned this pull request Sep 5, 2022

Fixing the Experiment tracking set up docs kedro-org/kedro-viz#1042

Closed

Base automatically changed from docs/plots-on-exp-tracking to main September 6, 2022 10:10

AhdraMeraliQB and others added 3 commits September 6, 2022 11:12

Merge branch 'main' into docs/add-matplotlib-plots

dfe47f7

Change Kedro-Viz plot visualisations description

eca1708

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Merge branch 'main' into docs/add-matplotlib-plots

52fc284

merelcht approved these changes Sep 8, 2022

View reviewed changes

AhdraMeraliQB and others added 5 commits September 8, 2022 16:49

Update docs/source/tutorial/visualise_pipeline.md

ca5b7c7

Co-authored-by: Merel Theisen <49397448+MerelTheisenQB@users.noreply.github.com>

Add explanation for versioned flag

8da3c25

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

Merge branch 'docs/add-matplotlib-plots' of github.com:kedro-org/kedr…

14d7b98

…o into docs/add-matplotlib-plots

Merge branch 'main' into docs/add-matplotlib-plots

2911111

Merge branch 'main' into docs/add-matplotlib-plots

b2b04e3

AhdraMeraliQB merged commit f68e9e2 into main Sep 9, 2022

AhdraMeraliQB deleted the docs/add-matplotlib-plots branch September 9, 2022 13:42

noklam mentioned this pull request Feb 8, 2023

Provide better error message when running project command like kedro run not from the root directory #1720

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation on how to visualise Matplotlib plots on Kedro-Viz #1820

Add documentation on how to visualise Matplotlib plots on Kedro-Viz #1820

AhdraMeraliQB commented Aug 30, 2022 •

edited

Loading

antonymilne left a comment •

edited

Loading

antonymilne Sep 2, 2022

AhdraMeraliQB Sep 5, 2022

rashidakanchwala Sep 5, 2022

yetudada Sep 7, 2022

rashidakanchwala left a comment

rashidakanchwala Sep 5, 2022

merelcht left a comment

merelcht Sep 8, 2022

AhdraMeraliQB Sep 8, 2022


		[Plotly](https://plotly.com/python/) is a free and open source Python library that allows you to make interactive, publication-quality graphs. With the Plotly integration on Kedro-Viz, you can output your interactive charts as part of your pipeline visualisation.
		Kedro-Viz aims to help users communicate different aspects of their workflow through an interactive flowchart. With the Plotly and Matplotlib integrations, we take one step further in this direction to allow our users to share their data insights effectively while exploring the pipeline.

Add documentation on how to visualise Matplotlib plots on Kedro-Viz #1820

Add documentation on how to visualise Matplotlib plots on Kedro-Viz #1820

Conversation

AhdraMeraliQB commented Aug 30, 2022 • edited Loading

Description

Development notes

Checklist

antonymilne left a comment • edited Loading

Choose a reason for hiding this comment

antonymilne Sep 2, 2022

Choose a reason for hiding this comment

AhdraMeraliQB Sep 5, 2022

Choose a reason for hiding this comment

rashidakanchwala Sep 5, 2022

Choose a reason for hiding this comment

yetudada Sep 7, 2022

Choose a reason for hiding this comment

rashidakanchwala left a comment

Choose a reason for hiding this comment

rashidakanchwala Sep 5, 2022

Choose a reason for hiding this comment

merelcht left a comment

Choose a reason for hiding this comment

merelcht Sep 8, 2022

Choose a reason for hiding this comment

AhdraMeraliQB Sep 8, 2022

Choose a reason for hiding this comment

AhdraMeraliQB commented Aug 30, 2022 •

edited

Loading

antonymilne left a comment •

edited

Loading