[DOC] migrate nhits and quantile docstrings to numpydocstyle#2111
Open
amruth6002 wants to merge 2 commits intosktime:mainfrom
Open
[DOC] migrate nhits and quantile docstrings to numpydocstyle#2111amruth6002 wants to merge 2 commits intosktime:mainfrom
amruth6002 wants to merge 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 #2111 +/- ##
=======================================
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:
|
phoeenniixx
reviewed
Mar 1, 2026
| :py:class:`~pytorch_forecasting.data.timeseries.TimeSeriesDataSet`. | ||
| Parameters | ||
| ---------- | ||
| x : dict of {str : torch.Tensor} |
Member
There was a problem hiding this comment.
should it be Dict[str, torch.Tensor]?
Contributor
Author
There was a problem hiding this comment.
the numpydocstyle standard for dictionaries is technically dict of {key_type: value_type}
Contributor
Author
There was a problem hiding this comment.
but if we need to change it to square bracket i will do it, should i?
Contributor
Author
There was a problem hiding this comment.
i changed it could you please review.
phoeenniixx
changed the title
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
2 participants
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.
Reference Issues/PRs
Fixes #2066 (partially, for N-HiTS and Quantile metrics).
What does this implement/fix? Explain your changes.
This PR migrates the docstrings in the following files from Google style to
numpydocstyleas part of the broader documentation standardization effort:Changes made include updating
Args:toParameters,Returns:toReturns, and adopting the correct NumPy docstring formatting (e.g., adding----------dividers and proper indentation) as per the issue requirements.Did you add any tests for the change?
pre-commithooks locally (ruff format,ruff check, etc.) and all files passed the styling requirements.Any other comments?
PR checklist
pre-commit install.To run hooks independent of commit, execute
pre-commit run --all-files