[DOC] Migrate the documentation to numpydocstyle

[phoeenniixx]

Describe the issue linked to the documentation

Currently in some older parts of the pytorch-forecasting, we still have Google style of docstrings, but I think we should move it numpydoc style now.
Some areas I could find the issues:

• _timeseries.py- @karthikch947 is working on this starting from this line:

  pytorch-forecasting/pytorch_forecasting/data/timeseries/_timeseries.py

  Line 1040 in 602ee15

  def save(self, fname: str) -> None:

• examples.py @AyushDineshRathi

• pytorch_forecasting/layers/_attention - most files - @omkar-334 is working on this

• pytorch_forecasting/layers/_decomposition/_series_decomp.py @Meet-Ramjiyani-10

• pytorch_forecasting/layers/_embeddings/ - most files - @Soham-47 is working on this [DOC] migration of docstrings to numpydoc style in embeddings layer #2079

• pytorch_forecasting/layers/_encoders/ - most files - @Skvmqq [DOC] Migrate encoder docstrings from Google to NumPy style #2121

• pytorch_forecasting/layers/_filter/ - most files - @AyushDineshRathi [DOC] Migration of docstrings in layers/_filter to NumPydoc style #2116

• pytorch_forecasting/layers/_output/ - most files @Meet-Ramjiyani-10

• _base_metrics @AyushDineshRathi

• pytorch_forecasting/metrics/distributions.py @Meet-Ramjiyani-10 [DOC] migrate distributions.py docstrings to numpydoc style #2118

• point.py - @karthikch947 is working on this

• quantile.py @amruth6002 [DOC] migrate nhits and quantile docstrings to numpydocstyle #2111

• pytorch_forecasting/models/base/_base_model.py @AyushDineshRathi

• pytorch_forecasting/models/deepar/_deepar.py @echo-xiao

• mlp - most files @i-am-gk

• _nhits.py @amruth6002 [DOC] migrate nhits and quantile docstrings to numpydocstyle #2111

• nn - most files @AyushDineshRathi

• _rnn.py - @Abhishek242004

• tuning.py @Siddhazntx [DOC] Convert TFT tuning and utils docstrings to numpydoc style #2097

• _utils.py @Siddhazntx [DOC] Convert TFT tuning and utils docstrings to numpydoc style #2097

Suggest a potential alternative/fix

Move to numpydocstyle of docstrings.

Please comment below the files you want to work upon and I will mark those files with your PRs and your GH id.

Donot take on the whole issue at once as this would lead to a very large PR and would be very Hard to review, ideally, please take on 2-3 files (or a folder) at once

[karthikch947]

Hi, I would like to contribute to this issue by converting docstrings to numpydoc style.

I plan to start with the following files:

• pytorch_forecasting/data/_timeseries.py
• pytorch_forecasting/metrics/point.py

Please let me know if that works or if you have any preferences. Thanks!

[MrIridescent]

Hi! I'd like to take a look at this. I'm new to the project but I've fixed similar issues before. I'll submit a PR shortly.

[omkar-334]

hey @phoeenniixx i'd like to work on pytorch_forecasting/layers/_attention

[Soham-47]

Hii @phoeenniixx , i would like to work on pytorch_forecasting/layers/_embeddings

[phoeenniixx]

Hi! I'd like to take a look at this. I'm new to the project but I've fixed similar issues before. I'll submit a PR shortly.

Hi @MrIridescent, welcome to pytorch-forecasting, please specify the files you'd be working on!

[Skvmqq]

Hi @phoeenniixx, I would like to work on pytorch_forecasting/layers/_encoders :)

[Abhishek242004]

Hi @phoeenniixx, I would like to work on pytorch_forecasting/models/rnn/_rnn.py

[AyushDineshRathi]

Hii @phoeenniixx , i would like to work on

• pytorch_forecasting/layers/_encoders
• pytorch_forecasting/layers/_filter

[Siddhazntx]

Hi @phoeenniixx ,

I would like to work on converting the docstrings in the following files to the NumPy (numpydoc) style:

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

[phoeenniixx]

• pytorch_forecasting/layers/_encoders

Hi @AyushDineshRathi I think @Skvmqq is working on this, I have assigned _filter to you. Please lmk if you want to make any changes

[divyanshmaybe]

hello @phoeenniixx, I am interested in working on nn if anyone is not already working on it.