[DOC] Migrate TiDEModel docstrings to NumPy style#2241
Open
satishkc7 wants to merge 1 commit into
Open
Conversation
Convert all Google-style docstrings in models/tide/_tide.py to NumPy docstring format, consistent with the project-wide migration tracked in sktime#2066. Affected methods: __init__, decoder_covariate_size, encoder_covariate_size, static_size, from_dataset, and forward.
satishkc7
requested review from
PranavBhatP,
benHeid,
fkiraly,
fnhirwa,
jdb78,
phoeenniixx and
yarnabrina
as code owners
20 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2241 +/- ##
=======================================
Coverage ? 86.71%
=======================================
Files ? 166
Lines ? 9761
Branches ? 0
=======================================
Hits ? 8464
Misses ? 1297
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes part of #2066.
Summary
Migrates all Google-style docstrings in
pytorch_forecasting/models/tide/_tide.pyto NumPy docstring format, consistent with the project-wide migration tracked in #2066.Methods updated:
__init__- converted mixed Google/NumPy parameter entries to uniform NumPy style; fixedNote:section toNotes\n-----decoder_covariate_sizeproperty -Returns:->Returns\n-------encoder_covariate_sizeproperty -Returns:->Returns\n-------static_sizeproperty -Returns:->Returns\n-------from_dataset-Args:/Returns:->Parameters\n----------/Returns\n-------forward-Args:/Returns:->Parameters\n----------/Returns\n-------Checklist