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

added mlforecast contrib #498

Merged
merged 3 commits into from
Oct 27, 2023
Merged

added mlforecast contrib #498

merged 3 commits into from
Oct 27, 2023

Conversation

zilto
Copy link
Collaborator

@zilto zilto commented Oct 25, 2023

[Summary of contribution]
Added a contrib to train ML models for forecasting using Nixtla's mlforecast

For new dataflows:

Do you have the following?

  • Added a new folder for my dataflow under my username directory.
    • Added a README.md file under my dataflow directory that follows the standard headings and is filled out.
    • Added a init.py file under my dataflow directory that contains the Hamilton code.
    • Added a requirements.txt under my dataflow directory that contains the required packages outside of Hamilton.
    • Added tags.json under my dataflow directory to curate my dataflow.
    • Added valid_configs.jsonl under my dataflow directory to specify the valid configurations.
    • Added a dag.png that shows one possible configuration of my dataflow.

For existing dataflows -- what has changed?

How I tested this

There is a notebook run.ipynb that calls all available variables and should run from start to finish.

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Dataflow documentation has been updated if adding/changing functionality.

@zilto zilto requested a review from elijahbenizzy October 25, 2023 20:48
@zilto zilto temporarily deployed to github-pages October 25, 2023 20:48 — with GitHub Actions Inactive
@sweep-ai
Copy link
Contributor

sweep-ai bot commented Oct 25, 2023

Apply Sweep Rules to your PR?

  • Apply: Leftover TODOs in the code should be handled.
  • Apply: All new business logic should have corresponding unit tests in the tests/ directory.
  • Apply: Any clearly inefficient or repeated code should be optimized or refactored.

Copy link
Collaborator

@elijahbenizzy elijahbenizzy left a comment

Choose a reason for hiding this comment

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

LGTM! A few small comments on wording/docs.

@zilto zilto temporarily deployed to github-pages October 27, 2023 22:35 — with GitHub Actions Inactive
@zilto zilto marked this pull request as ready for review October 27, 2023 22:43
@zilto zilto merged commit c14dd8a into main Oct 27, 2023
@zilto zilto deleted the contrib/nixtla-mlforecast branch October 27, 2023 22:43
elijahbenizzy pushed a commit that referenced this pull request Oct 27, 2023
* added mlforecast contrib

* updated dag.png

* edited README limitations; clarified comments

---------

Co-authored-by: zilto <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants