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

Add Time-LLM #908

Merged
merged 22 commits into from
Mar 8, 2024
Merged

Add Time-LLM #908

merged 22 commits into from
Mar 8, 2024

Conversation

marcopeix
Copy link
Contributor

Add TimeLLM to neuralforecast.

User can load an LLM from HugginFace and use it for time series forecasting.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@CLAassistant
Copy link

CLAassistant commented Mar 1, 2024

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ marcopeix
❌ Marco Peixeiro


Marco Peixeiro seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@AzulGarza AzulGarza self-requested a review March 1, 2024 18:38
Copy link
Member

@AzulGarza AzulGarza left a comment

Choose a reason for hiding this comment

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

awesome @marcopeix! as a first piece of feedback, could you include a tutorial regarding how to use TimeLLM? it can be based on experiments/test_timellm/test_timellm.py, also the tests should be included in models.timellm.ipynb, (throwing an error if transformers is not installed).

also we should include transformers in the dev requirements to prevent tests from breaking.

@cchallu cchallu self-requested a review March 1, 2024 20:06
@marcopeix
Copy link
Contributor Author

marcopeix commented Mar 4, 2024

I added tests to the notebook
GPT-2 is the default LLM if the user does not specify another model
The usage example acts as a tutorial for using Time-LLM
Added transformers as a dependency

@AzulGarza AzulGarza self-requested a review March 4, 2024 22:55
Copy link
Member

@AzulGarza AzulGarza left a comment

Choose a reason for hiding this comment

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

thanks @marcopeix!

could you also include transformers in the dev_requirements part of the setttings.ini file?

also running nbdev_install_git_hooks and nbdev_clean should solve the nb_sync action.

experiments/test_timellm/test_timellm.py Outdated Show resolved Hide resolved
neuralforecast/models/timellm.py Outdated Show resolved Hide resolved
neuralforecast/models/timellm.py Outdated Show resolved Hide resolved
neuralforecast/models/timellm.py Outdated Show resolved Hide resolved
neuralforecast/models/timellm.py Outdated Show resolved Hide resolved
@jmoralez jmoralez changed the title Add Time-LLM to neuralforecast Add Time-LLM Mar 5, 2024
@marcopeix
Copy link
Contributor Author

Updated PR according to Azul's comments:

  • Better documentation of default behaviour
  • Remove transformers from core dependencies and added to dev dependencies
  • Flag to check if transformers is installed and use GPT-2 as default LLM
  • Remove test file from experiments folder since the script exists in the notebook

Copy link
Member

@AzulGarza AzulGarza left a comment

Choose a reason for hiding this comment

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

awesome @marcopeix! thank you 🎉

let's wait for the review of @jmoralez or @cchallu to merge it to main❤️

@AzulGarza AzulGarza requested a review from jmoralez March 5, 2024 20:17
@jmoralez jmoralez merged commit 076f863 into main Mar 8, 2024
18 checks passed
@jmoralez jmoralez deleted the feature/time-llm branch March 8, 2024 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants