Skip to content

Commit c0598aa

Browse files
authored
[DOC] migrate baseline.py docstrings to numpydocstyle (#2115)
#### Reference Issues/PRs Addresses #2066 #### What does this implement/fix? Explain your changes. Migrates the docstrings in [pytorch_forecasting/models/baseline.py](cci:7://file:///home/amruth/amruth/projects/pytorch-forecasting/pytorch_forecasting/models/baseline.py:0:0-0:0) 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 - [x] The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. - [ ] Added/modified tests - [x] Used pre-commit hooks when committing to ensure that code is compliant with hooks.
1 parent 46b906a commit c0598aa

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

pytorch_forecasting/models/baseline.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,15 @@ def forward(self, x: dict[str, torch.Tensor]) -> dict[str, torch.Tensor]:
3535
"""
3636
Network forward pass.
3737
38-
Args:
39-
x (Dict[str, torch.Tensor]): network input
40-
41-
Returns:
42-
Dict[str, torch.Tensor]: network outputs
38+
Parameters
39+
----------
40+
x : Dict[str, torch.Tensor]
41+
network input
42+
43+
Returns
44+
-------
45+
Dict[str, torch.Tensor]
46+
network outputs
4347
"""
4448
if isinstance(x["encoder_target"], tuple | list): # multiple targets
4549
prediction = [

0 commit comments

Comments
 (0)