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

[DOC] Improve the explanation on the window parameter (offset) of WindowTransformer #1666

Merged
merged 8 commits into from
Apr 7, 2023

Conversation

JQGoh
Copy link
Contributor

@JQGoh JQGoh commented Mar 23, 2023

#1662.

Summary

  • This improves the documentation such that we explain that the acceptable window parameter for an offset is pandas.Timedelta data type instead of pandas.DateOffset.

Other Information

  • Also add additional test cases for the class WindowTransformer to demonstrate the mentioned behaviors.

JQGoh added 2 commits March 24, 2023 00:26
expected by the window parameter of WindowTransformer

Add remark to window_transformer file
considering different formats for the parameter window
@JQGoh JQGoh requested a review from dennisbader as a code owner March 23, 2023 16:31
@JQGoh
Copy link
Contributor Author

JQGoh commented Mar 23, 2023

@madtoinou FYI

@codecov-commenter
Copy link

codecov-commenter commented Mar 24, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.09 ⚠️

Comparison is base (e4a6933) 94.14% compared to head (ba9c041) 94.05%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1666      +/-   ##
==========================================
- Coverage   94.14%   94.05%   -0.09%     
==========================================
  Files         125      125              
  Lines       11385    11371      -14     
==========================================
- Hits        10718    10695      -23     
- Misses        667      676       +9     
Impacted Files Coverage Δ
.../dataprocessing/transformers/window_transformer.py 100.00% <ø> (ø)
darts/timeseries.py 92.30% <ø> (-0.22%) ⬇️
darts/models/forecasting/regression_model.py 97.12% <100.00%> (+<0.01%) ⬆️
darts/utils/multioutput.py 81.48% <100.00%> (-0.67%) ⬇️

... and 8 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Collaborator

@madtoinou madtoinou left a comment

Choose a reason for hiding this comment

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

LGTM 🚀 , the documentation is much clearer with this phrasing!

Minor comments about the snippet checking the ValueError raising so that it looks similar to the approach used in the other tests

Copy link
Collaborator

@madtoinou madtoinou left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for addressing the comments so quickly!

Copy link
Collaborator

@dennisbader dennisbader left a comment

Choose a reason for hiding this comment

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

Thank you @JQGoh, looks good! 🚀 I'll merge once tests have passed.

@dennisbader dennisbader merged commit 0307356 into unit8co:master Apr 7, 2023
alexcolpitts96 pushed a commit to alexcolpitts96/darts that referenced this pull request May 31, 2023
…dowTransformer (unit8co#1666)

* Improve doc string to clarify the data type of offset
expected by the window parameter of WindowTransformer

Add remark to window_transformer file

* Add test case to demonstrate the transform behaviors,
considering different formats for the parameter window

* Review: simply use self.assertRaises

* Fix failed test

---------

Co-authored-by: madtoinou <32447896+madtoinou@users.noreply.github.com>
Co-authored-by: Dennis Bader <dennis.bader@gmx.ch>
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.

4 participants