Skip to content

[DOC] migrate distributions.py docstrings to numpydoc style#2118

Merged
phoeenniixx merged 4 commits intosktime:mainfrom
Meet-Ramjiyani-10:doc/migrate-distributions-numpydoc
Mar 2, 2026
Merged

[DOC] migrate distributions.py docstrings to numpydoc style#2118
phoeenniixx merged 4 commits intosktime:mainfrom
Meet-Ramjiyani-10:doc/migrate-distributions-numpydoc

Conversation

@Meet-Ramjiyani-10
Copy link
Contributor

Addresses #2066

Summary

Migrates all Google-style docstrings in pytorch_forecasting/metrics/distributions.py
to numpydoc style as requested in #2066.

Changes Made

Converted the following to numpydoc style

  • MultivariateNormalDistributionLoss.init
  • NegativeBinomialDistributionLoss.to_prediction
  • BetaDistributionLoss.loss
  • MQF2DistributionLoss.init
  • MQF2DistributionLoss.loss
  • MQF2DistributionLoss.to_quantiles
  • ImplicitQuantileNetworkDistributionLoss.init
  • ImplicitQuantileNetworkDistributionLoss.loss
  • ImplicitQuantileNetworkDistributionLoss.to_quantiles

Type of Change

  • Documentation (docstring update, no logic changes)

Notes

No code logic was changed. Only docstring formatting was updated.

@Meet-Ramjiyani-10
Copy link
Contributor Author

It looks like the failing CI job on no-softdeps (ubuntu-latest, 3.11) is due to an HTTP 502 error in an integration test. Since this PR only updates docstrings, I suspect it may be unrelated, but I’m happy to investigate further if needed.

Copy link
Member

@phoeenniixx phoeenniixx left a comment

Choose a reason for hiding this comment

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

Thanks!

@phoeenniixx phoeenniixx added the documentation Improvements or additions to documentation label Mar 1, 2026
@codecov
Copy link

codecov bot commented Mar 1, 2026

Codecov Report

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2118   +/-   ##
=======================================
  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.

@phoeenniixx phoeenniixx merged commit bada266 into sktime:main Mar 2, 2026
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants