Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introducing --include-hooks parameter and deprecating --ignore-plugins in Kedro-Viz #1808

Closed
1 task
rashidakanchwala opened this issue Mar 15, 2024 · 1 comment · Fixed by #1818
Closed
1 task

Comments

@rashidakanchwala
Copy link
Contributor

rashidakanchwala commented Mar 15, 2024

Description

In Kedro-Viz, hooks automatically run, but you can choose to skip them by using kedro viz run --ignore-plugins. However, since most of Kedro-Viz's features don't need hook information to work, and many users don't know about the --ignore-plugins option, we should consider a new approach. This issue about making hook execution opt-in by default, which means hooks would be disabled unless you choose to enable them.

Possible Implementation

This ticket propose the following changes:

  • Disable Hooks by default: Hooks will no longer be executed automatically. This change aims to streamline the operation of Kedro-Viz, reducing unnecessary processing and speeding up the visualization rendering for users.

  • Introduce --include-hooks parameter: For users who require hook execution to generate runtime data for dynamic pipelines or other specific use cases, we will introduce a new --include-hooks parameter. This parameter allows users to explicitly opt-in to execute their hooks as needed, offering flexibility without sacrificing the tool's efficiency for the majority.

  • Deprecate --ignore-plugins parameter: In light of introducing the --include-hooks option, the existing --ignore-plugins parameter will be phased out.

We want to enable this for all cli commands of kedro-viz including run , build and deploy

Before implementing these changes, it would be nice to understand the usage of --ignore-plugins parameter. @NeroOkwa

Checklist

  • Include labels so that we can categorise your feature request
@rashidakanchwala rashidakanchwala changed the title Introducing --include-hooks Parameter and Deprecating --ignore-plugins in Kedro-Viz Introducing --include-hooks parameter and deprecating --ignore-plugins in Kedro-Viz Mar 15, 2024
@rashidakanchwala rashidakanchwala moved this to Backlog in Kedro-Viz Mar 18, 2024
@rashidakanchwala rashidakanchwala moved this from Backlog to Todo in Kedro-Viz Mar 18, 2024
@NeroOkwa
Copy link
Contributor

@rashidakanchwala according to our metrics, there are no users using ignore-plugins

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants