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

Kolmogorov Arnold Block for NBeats #1751

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

Sohaib-Ahmed21
Copy link
Contributor

Description

Fixes: #1741

This PR adds Kolmogorov Arnold(KAN) Blocks in NBeats and also does refactoring of NBeats. Implementation of KAN blocks' layers is taken from original paper code.

Checklist

  • Linked issues (if existing)
  • Used pre-commit hooks when committing to ensure that code is compliant with hooks. Install hooks with pre-commit install.
    To run hooks independent of commit, execute pre-commit run --all-files

Make sure to have fun coding!

@Sohaib-Ahmed21
Copy link
Contributor Author

@fkiraly @benHeid this PR is ready for review. Kindly review it. Thanks!

@Sohaib-Ahmed21
Copy link
Contributor Author

@fkiraly @benHeid can you kindly review/merge it so I integrate NBEATSX modification in NBEATS without conflicts as I have asked @julian-fong and he is not working on NBEATSX.

Copy link
Collaborator

@benHeid benHeid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not fully reviewed yet. Will continue in the next days. But I share my current comments so that you already receive some feedbacks.

When training KANs, the grid can be iteratively be refined. I wonder, if there is a way to implement this also here. However, this might probably more difficult and require changes to the trainer. So probably out of scope for this PR. Do you have opinions on that?

pytorch_forecasting/models/nbeats/_nbeats.py Outdated Show resolved Hide resolved
pytorch_forecasting/models/nbeats/_nbeats.py Outdated Show resolved Hide resolved
pytorch_forecasting/models/nbeats/_nbeats.py Show resolved Hide resolved
pytorch_forecasting/models/nbeats/_nbeats.py Outdated Show resolved Hide resolved
pytorch_forecasting/models/nbeats/_nbeats.py Outdated Show resolved Hide resolved
@@ -0,0 +1,528 @@
import numpy as np
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The license of the original implementation is MIT. So in theory it is okay to copy the file. However, please add some credits at the top of the file.

Alternatively, we could think about adding KAN as a dependency.

@fkiraly do you have any additions on that matter?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I will add the appropriate credits at the top of the file. Additionally, I agree that adding KAN as a dependency—perhaps as a soft dependency—seems like a good idea, especially considering its increasing relevance in time series forecasting.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fkiraly pinging you again to check if this is okay for you :)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which package are we exactly planning to add as a soft dep?

If it is a single layer, I think copying it over and including the license is perhaps better for now, because we do not have machinery to manage soft dependencies (like scikit-base or similar).

The proposed design in here sktime/enhancement-proposals#39 would allow that, but right now I think this would require a significant amounts of custom code to handle.

Or, is there an easy way that I am not seeing how the soft dependency import would work for part of the NN?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which package are we exactly planning to add as a soft dep?

It is pykan library , reference https://pypi.org/project/pykan/

If it is a single layer, I think copying it over and including the license is perhaps better for now, because we do not have machinery to manage soft dependencies (like scikit-base or similar).

The proposed design in here sktime/enhancement-proposals#39 would allow that, but right now I think this would require a significant amounts of custom code to handle.

Or, is there an easy way that I am not seeing how the soft dependency import would work for part of the NN?

yes it is a single layer, only used in NBEATS. Also the library pykan has much more, but we only need this. I have implemented what you already suggested above. I have copied it over and included the license.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, makes sense, as long as the license points to the original source and is provided in full form (assuming it hsa the usual reqiurement to reproduce)

@Sohaib-Ahmed21
Copy link
Contributor Author

Not fully reviewed yet. Will continue in the next days. But I share my current comments so that you already receive some feedbacks.

Thanks! Will address these reviews soon.

@Sohaib-Ahmed21
Copy link
Contributor Author

When training KANs, the grid can be iteratively be refined. I wonder, if there is a way to implement this also here. However, this might probably more difficult and require changes to the trainer. So probably out of scope for this PR. Do you have opinions on that?

I'll explore this and share my thoughts.

@Sohaib-Ahmed21
Copy link
Contributor Author

Sohaib-Ahmed21 commented Jan 23, 2025

@benHeid I have addressed the reviews. Kindly review the updated PR.

When training KANs, the grid can be iteratively be refined. I wonder, if there is a way to implement this also here. However, this > might probably more difficult and require changes to the trainer. So probably out of scope for this PR. Do you have opinions on > that?

To address this, I have taken logic from original implementation of pykan library and made custom Callback i.e. GridUpdateCallback which updates grid after specified steps. This has been tested and working fine with improved results. Your thoughts will be helpful in this regard.

@Sohaib-Ahmed21
Copy link
Contributor Author

Sohaib-Ahmed21 commented Jan 26, 2025

@benHeid @fkiraly I have addressed the reviews. Kindly review it so I proceed integrating NBEATSX without conflicts.

Copy link
Collaborator

@benHeid benHeid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only have one last comment. But I also would like to hear @fkiraly opinion on the license of the kan_layer

Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do have one major request though: This PR seems to be changing the parametrization of NBEATS in major ways, and it essentially alters the structure.

May I hence request to, instead of modifying the existing class, to add a new class?
There may be common code that could be refactored, I just think that it is better to keep the class NBEATS - a common method - as a conceptual reference to the original NBEATS algorithm.

Variants and modifications I would provide as new classes - there are many modifications of NBEATS; so it seems like a suboptimal design decision to merge one of those (albeit a popular one) in the reference implementation.

@Sohaib-Ahmed21
Copy link
Contributor Author

Sohaib-Ahmed21 commented Feb 6, 2025

I do have one major request though: This PR seems to be changing the parametrization of NBEATS in major ways, and it essentially alters the structure.

May I hence request to, instead of modifying the existing class, to add a new class? There may be common code that could be refactored, I just think that it is better to keep the class NBEATS - a common method - as a conceptual reference to the original NBEATS algorithm.

Variants and modifications I would provide as new classes - there are many modifications of NBEATS; so it seems like a suboptimal design decision to merge one of those (albeit a popular one) in the reference implementation.

Sounds good, thanks for the review! I will make separate class for NBEATS using KAN keeping the original algorithm separate and will update the PR.

@fkiraly
Copy link
Collaborator

fkiraly commented Feb 6, 2025

FYI @benHeid, thoughts/opinions?

@benHeid
Copy link
Collaborator

benHeid commented Feb 9, 2025

I see your point. However, I fear that we will introduce a lot of duplicated code. Thus, we might think about refactoring strategies.

But I am also happy with a new class, since this reduces also the complexity.

@Sohaib-Ahmed21
Copy link
Contributor Author

Sohaib-Ahmed21 commented Feb 9, 2025

I see your point. However, I fear that we will introduce a lot of duplicated code. Thus, we might think about refactoring strategies.

But I am also happy with a new class, since this reduces also the complexity.

I'll try to reuse as much code as possible like submodules, etc. So should I move towards new class implementation?

Update: Adding new class and will update PR soon.

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

Successfully merging this pull request may close these issues.

[ENH] Kolmogorov Arnold Block for NBeats network
3 participants