Skip to content

[DOC] Convert TFT tuning and utils docstrings to numpydoc style#2097

Open
Siddhazntx wants to merge 4 commits intosktime:mainfrom
Siddhazntx:refactor/numpydoc-tuning-utils
Open

[DOC] Convert TFT tuning and utils docstrings to numpydoc style#2097
Siddhazntx wants to merge 4 commits intosktime:mainfrom
Siddhazntx:refactor/numpydoc-tuning-utils

Conversation

@Siddhazntx
Copy link

@Siddhazntx Siddhazntx commented Feb 26, 2026

Reference Issues/PRs

Fixes #2066

What does this implement/fix? Explain your changes.

This PR converts the docstrings in the following files from Google style to the NumPy (numpydoc) style to align with the project's documentation standards:

  • pytorch_forecasting/models/temporal_fusion_transformer/tuning.py
  • pytorch_forecasting/utils/_utils.py

The changes are strictly limited to documentation and do not alter any functional logic.

What should a reviewer concentrate their feedback on?

  • Consistency of the NumPy style formatting.
  • Accuracy of the parameter types in the new docstrings.

Did you add any tests for the change?

No new functional tests were added as this is a documentation-only change. However, I verified that the code remains functional and passes all linting requirements.

PR checklist

  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.
  • Added/modified tests
  • Used pre-commit hooks when committing to ensure that code is compliant with hooks. Install hooks with pre-commit install.

@codecov
Copy link

codecov bot commented Feb 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@1952984). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2097   +/-   ##
=======================================
  Coverage        ?   86.63%           
=======================================
  Files           ?      165           
  Lines           ?     9732           
  Branches        ?        0           
=======================================
  Hits            ?     8431           
  Misses          ?     1301           
  Partials        ?        0           
Flag Coverage Δ
cpu 86.63% <ø> (?)
pytest 86.63% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

[DOC] Migrate the documentation to numpydocstyle

1 participant