[DOC] migrate baseline.py docstrings to numpydocstyle #2115
[DOC] migrate baseline.py docstrings to numpydocstyle #2115phoeenniixx merged 2 commits intosktime:mainfrom
Conversation
amruth6002
requested review from
PranavBhatP,
benHeid,
fkiraly,
fnhirwa,
jdb78,
phoeenniixx and
yarnabrina
as code owners
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2115 +/- ##
=======================================
Coverage ? 86.63%
=======================================
Files ? 165
Lines ? 9732
Branches ? 0
=======================================
Hits ? 8431
Misses ? 1301
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:
|
|
few test case failed with HTTP Error 504: Gateway Timeout , could you please re-run them. @phoeenniixx @PranavBhatP @fkiraly |
| Dict[str, torch.Tensor]: network outputs | ||
| Parameters | ||
| ---------- | ||
| x : dict of {str : torch.Tensor} |
There was a problem hiding this comment.
should it be Dict[str, torch.Tensor]?
There was a problem hiding this comment.
the numpydocstyle standard for dictionaries is technically dict of {key_type: value_type}
There was a problem hiding this comment.
but if we need to change it to square bracket i will do it, should i?
There was a problem hiding this comment.
I mean its a common convention we've been following since the start, that's why I suggested it. I understand what you mean, but I would prefer following already set convention in docs to prevent any misunderstandings :)
phoeenniixx
changed the title
2 participants
Reference Issues/PRs
Addresses #2066
What does this implement/fix? Explain your changes.
Migrates the docstrings in pytorch_forecasting/models/baseline.py from Google style to NumPy docstring style , as part of the repo-wide numpydocstyle migration tracked in #2066.
Did you add any tests for the change?
No — this is a documentation-only change with no functional code modifications.
Any other comments?
None.
PR checklist