Option to include visualized pipelines in the generated document
See original GitHub issueDescription
An option to include the image of visualized pipelines in the Sphinx document generated by kedro build-docs
command
Context
kedro-viz offers kedro viz
command that can generate interactive visualized pipelines.
This visualization is very useful to explain to the stakeholders and it is even nicer to automate the manual operation to run kedro viz
command, access the URL, take a screenshot, and paste it in the document.
![image](https://user-images.githubusercontent.com/33908456/61184262-542f8000-a67e-11e9-872e-3fa40e31b81c.png)
Possible Implementation
Programmatically communicate with the kedro_viz.server.
Possible Alternatives
Use a graph visualization tool such as graphviz
.
Issue Analytics
- State:
- Created 4 years ago
- Comments:8 (6 by maintainers)
Top Results From Across the Web
CI/CD pipelines - GitLab Docs
GitLab generates the special ref refs/pipelines/<id> during a running pipeline job. ... if you are using Git 2.10 or later, use the ci.skip...
Read more >Visualize and analyze pipeline results | Vertex AI - Google Cloud
This document describes how to use Vertex AI Pipelines to visualize, analyze, and compare pipeline runs. To learn more about running and scheduling ......
Read more >Get started using deployment pipelines, the Power BI ...
Learn how to use deployment pipelines, the Power BI Application lifecycle management (ALM) tool.
Read more >Getting started with Pipeline - Jenkins
This section describes how to get started with creating your Pipeline project in Jenkins and introduces you to the various ways that a...
Read more >Pipeline Steps - Amazon SageMaker - AWS Documentation
You can use the QualityCheck step to conduct baseline suggestions and drift checks against a previous baseline for data quality or model quality...
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
Hi @Minyus, this sounds like a very interesting feature and I agree that it can be useful to add the pipeline graph to the docs. Since this feature request is more of a request to the
kernel-viz
plugin, rather thanKedro
, maybe we can have the feature request posted https://github.com/quantumblacklabs/kedro-viz instead.The implementation of this feature may prove to be quite involved, since it will require running the
kedro-viz
frontend in a headless browser and then take a screenshot there, which could be used for the docs. Given that this feature is nice to have and not very important for the user’s workflow, but quite high on the effort, I will put it as low priority.Hi @Minyus, what sort of document would you like the image to be pasted in? Currently Kedro doesn’t really produce any soft deliverables apart from perhaps the automated documentation. But providing the visualization there feels like a special case.