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

Improve Console Output to Indicate Hook Usage in Kedro-Viz #2145

Open
1 task done
SajidAlamQB opened this issue Oct 21, 2024 · 2 comments
Open
1 task done

Improve Console Output to Indicate Hook Usage in Kedro-Viz #2145

SajidAlamQB opened this issue Oct 21, 2024 · 2 comments
Labels
Enhancement Issue: Feature Request Quick Win Low/Medium priorities but quick to do

Comments

@SajidAlamQB
Copy link
Contributor

Description

This is a follow-up issue to: #2142

When debugging hook-related issues in Kedro-Viz because the console output does not make it clear whether hooks are being used or not. Users may not know to try the --include-hooks option, leading to confusion when functionality is missing.

Context

This change is important because it will improve clarity when running Kedro-Viz. Some users use custom hooks and are unaware that hooks are not being loaded, making it difficult to diagnose problems. Adding a simple message in the console output would save users time when this problem arises.

Example implementation:

INFO: Running kedro-viz without hooks, if you spot missing functionality try 'kedro viz run --include-hooks'

or

INFO: Running kedro-viz with hooks: mlflow, custom

Possible Alternatives

Could we make --include-hooks by default?

Checklist

  • Include labels so that we can categorise your feature request
@rashidakanchwala
Copy link
Contributor

We purposely made --include--hooks not there by default because ideally kedro-viz doesn't need to run hooks unless you are using dynamic pipeline. Something that I heard is not encouraged. can you confirm @astrojuanlu ?
Also include--hook made Kedro-viz slower if you had pyspark setup, or mlflow.

This is great idea! I also wanted to ask if there's anyway to detect a user is using dynamic pipelines or requires to run hooks to access variables, and if kedro-viz fails; we could say that's because hooks didn't run ? I guess that sort of error handling would be in framework ?

@astrojuanlu
Copy link
Member

Let's tackle the question of enabling --include-hooks separately, it was indeed introduced to improve the default experience #1808

I also wanted to ask if there's anyway to detect a user is using dynamic pipelines or requires to run hooks to access variables

I have no idea 🤔

@rashidakanchwala rashidakanchwala added the Quick Win Low/Medium priorities but quick to do label Oct 23, 2024
@rashidakanchwala rashidakanchwala moved this from Inbox to Backlog in Kedro-Viz Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Issue: Feature Request Quick Win Low/Medium priorities but quick to do
Projects
Status: Backlog
Development

No branches or pull requests

3 participants