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

Workflow: Support user-defined diagnostic metrics and plots #279

Open
paul-buerkner opened this issue Dec 11, 2024 · 0 comments
Open

Workflow: Support user-defined diagnostic metrics and plots #279

paul-buerkner opened this issue Dec 11, 2024 · 0 comments
Assignees
Labels
feature New feature or request

Comments

@paul-buerkner
Copy link
Contributor

The new BasicWorkflow objects are really cool! I also like the built-in (default) diagnostic metrics and plots that we can call via workflow.compute_diagnostics and workflow.plot_diagnostics, respectively.

It would be cool if you could allow users to specify and pass their own metrics or plot functions as long as they follow some fixed in and output structure that aligns with the built-in metrics and plots.

Example:

# computes all built-in default metrics
workflow.compute_diagnostics(test_data=300)

# also compute a custom metric:
def MAE ...
workflow.compute_diagnostics(test_data=300, custom_metrics = dict(MAE = MAE))

So custom_metrics could be a dictionary of functions. The keys of the dictionary would be used as names in the output data frame. If the functions don't follow the expected in- and output structure, an informative error is raised.

It would also be cool if one could choose which built-in metrics to compute. For example via a simple metrics argument taking a list.

# computes all built-in default metrics
workflow.compute_diagnostics(test_data=300, metrics = ["NRMSE"])
@paul-buerkner paul-buerkner added the feature New feature or request label Dec 11, 2024
@jerrymhuang jerrymhuang self-assigned this Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants