Fix docstrings on torch/optim and torch/autograd #113218

alperenunlu · 2023-11-08T00:34:36Z

Description

Fixes the docstrings on following files.

pydocstyle path-to-file --count

File	Count
torch/optim/lr_scheduler.py	96 -> 39
torch/optim/nadam.py	6 -> 4
torch/optim/optimizer.py	31 -> 6
torch/optim/radam.py	6 -> 4
torch/optim/rmsprop.py	7 -> 4
torch/optim/rprop.py	6 -> 4
torch/optim/sgd.py	6 -> 4
torch/optim/swa_utils.py	15 -> 10
torch/optim/_multi_tensor/init.py	2 -> 1
torch/autograd/init.py	8 -> 0
torch/autograd/anomaly_mode.py	8 -> 7

pytorch-bot · 2023-11-08T00:34:40Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/113218

📄 Preview Python docs built from this PR
📄 Preview C++ docs built from this PR
❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

Note: Links to docs will display an error until the docs builds have been completed.

✅ You can merge normally! (1 Unrelated Failure)

As of commit a1f039b with merge base 9f71452 ():

FLAKY - The following job failed but was likely due to flakiness present on trunk:

pull / linux-jammy-py3-clang12-executorch / test (executorch, 1, 1, linux.2xlarge) (gh)
test_ops.py::TestCommonCPU::test_out__refs_linalg_matrix_norm_cpu_float32

This comment was automatically generated by Dr. CI and updates every 15 minutes.

linux-foundation-easycla · 2023-11-08T00:34:41Z

The committers listed above are authorized under a signed CLA.

✅ login: alperenunlu / name: Alperen ÜNLÜ (7c5cdb7, 6b645d7, 4e186bd, 377cb4a, 8f5da01, bcf4120, 6532eef, a523961, a58386f, daa7f99, 30a877b, f667db8, 1542523, a1f039b)
✅ login: svekars / name: Svetlana Karslioglu (f21eb86)

svekars · 2023-11-08T19:37:39Z

torch/optim/lr_scheduler.py

+    """Decays the learning rate of each parameter group by a small constant factor.
+
+    Until the number of epoch reaches a pre-defined milestone: total_iters.


Suggested change

"""Decays the learning rate of each parameter group by a small constant factor.

Until the number of epoch reaches a pre-defined milestone: total_iters.

"""Decays the learning rate of each parameter group by a small constant factor until the number of epoch reaches a pre-defined milestone: total_iters.

svekars · 2023-11-08T19:40:29Z

torch/optim/lr_scheduler.py

+    """Decays the learning rate of each parameter group by linearly changing small multiplicative factor.
+
+    Until the number of epoch reaches a pre-defined milestone: total_iters.


Suggested change

"""Decays the learning rate of each parameter group by linearly changing small multiplicative factor.

Until the number of epoch reaches a pre-defined milestone: total_iters.

"""Decays the learning rate of each parameter group by linearly changing small multiplicative factor until the number of epoch reaches a pre-defined milestone: total_iters.

svekars · 2023-11-08T19:41:11Z

torch/optim/lr_scheduler.py

-    optimization process and milestone points that provides exact intervals to reflect
-    which scheduler is supposed to be called at a given epoch.
+    """
+    Receives the list of schedulers that is expected to be called sequentially during optimization process.


Suggested change

Receives the list of schedulers that is expected to be called sequentially during optimization process.

Receives the list of schedulers that is expected to be called sequentially during the optimization process.

alperenunlu · 2023-11-08T19:49:02Z

@svekars these suggested lines are too long for flake8 should I add them to the pr?

soulitzer · 2023-11-10T15:22:26Z

torch/optim/optimizer.py

-        r"""Register a load_state_dict pre-hook which will be called before
-        :meth:`~torch.optim.Optimizer.load_state_dict` is called. It should have the
-        following signature::
+        r"""Register a load_state_dict pre-hook which will be called.


This seems odd. Can you revert this change?

You want to have the first sentence as:

Register a load_state_dict pre-hook which will be called before :meth:~torch.optim.Optimizer.load_state_dict `is called

(with the proper quoting)

pydocstyle wants a summary line and linter wants the line shorter than 120 char.

Register a load_state_dict pre-hook which will be called before :meth:~torch.optim.Optimizer.load_state_dict is called

still too long for linter to accept because of the indentation.

I see. I think we should err on the of being more informative rather than appeasing the linter though.

@soulitzer I also felt like it became odd. But I couldn't come up with another solution that could pass by both pydocstyle and flake8.

It is probably fine to leave it as it was before. That way flake8 passes, and we don't regress the meaning of the first sentence.

torch/optim/optimizer.py

torch/optim/lr_scheduler.py

soulitzer

Thanks for the fix, I added some suggestions (mainly where I think more context in the first sentence is important to understanding).

alperenunlu · 2023-11-10T16:07:57Z

Thank you @soulitzer!!

alperenunlu · 2023-11-10T16:08:58Z

@svekars Can you also look at soulitzer's review?

soulitzer · 2023-11-16T17:40:04Z

The autograd parts look good to me, but maybe @janeyx99 should take a closer look at the optim changes.

torch/optim/lr_scheduler.py

janeyx99 · 2023-11-21T22:45:28Z

torch/optim/lr_scheduler.py

@@ -187,8 +185,9 @@ def __exit__(self, type, value, traceback):


 class LambdaLR(LRScheduler):
-    """Sets the learning rate of each parameter group to the initial lr
-    times a given function. When last_epoch=-1, sets initial lr as lr.
+    """Sets the learning rate of each parameter group to the initial lr times a given function.


Suggested change

"""Sets the learning rate of each parameter group to the initial lr times a given function.

"""Set the learning rate of each parameter group to the initial lr times a given function.

Should this be singularized following the pattern everywhere else?

Classes don't necessarily have to start with an imperative verb.
Therefore, I didn't modify the class docstrings to make them imperative.

torch/optim/lr_scheduler.py

janeyx99 · 2023-11-21T22:46:06Z

torch/optim/lr_scheduler.py

-    in the specified function. When last_epoch=-1, sets initial lr as lr.
+    """Multiply the learning rate of each parameter group by the factor given in the specified function.
+
+    When last_epoch=-1, sets initial lr as lr.


Suggested change

When last_epoch=-1, sets initial lr as lr.

When last_epoch=-1, set the initial lr as lr.

I didn't touch them since they are in a class and not the summary line.

janeyx99 · 2023-11-21T22:46:20Z

torch/optim/lr_scheduler.py

-    times a given function. When last_epoch=-1, sets initial lr as lr.
+    """Sets the learning rate of each parameter group to the initial lr times a given function.
+
+    When last_epoch=-1, sets initial lr as lr.


Suggested change

When last_epoch=-1, sets initial lr as lr.

When last_epoch=-1, set initial lr as lr.

here too

maybe not, since this is a class..

I also didn't touch them because they are in a class and not the summary line.

janeyx99

Sorry for the delayed review, I've recently returned.

Left my review--most edits are good but a few are wrong. Thank you for going through the docs!

torch/optim/lr_scheduler.py

torch/optim/optimizer.py

Co-authored-by: Jane (Yuan) Xu <31798555+janeyx99@users.noreply.github.com>

alperenunlu · 2023-11-22T00:34:26Z

Thank you for your review @janeyx99!!

github-actions · 2024-01-21T03:33:49Z

Looks like this PR hasn't been updated in a while so we're going to go ahead and mark this as Stale.
Feel free to remove the Stale label if you feel this was a mistake.
If you are unable to remove the Stale label please contact a maintainer in order to do so.
If you want the bot to never mark this PR stale again, add the no-stale label.
Stale pull requests will automatically be closed after 30 days of inactivity.

janeyx99

So sorry I did not get back to you earlier!

janeyx99 · 2024-02-05T16:37:12Z

If you're willing to manually rebase and bring this PR up to date, please ping me and we can try to get this in this week.

github-actions · 2024-04-05T17:33:35Z

Looks like this PR hasn't been updated in a while so we're going to go ahead and mark this as Stale.
Feel free to remove the Stale label if you feel this was a mistake.
If you are unable to remove the Stale label please contact a maintainer in order to do so.
If you want the bot to never mark this PR stale again, add the no-stale label.
Stale pull requests will automatically be closed after 30 days of inactivity.

alperenunlu requested review from albanD, janeyx99 and soulitzer as code owners November 8, 2023 00:34

pytorch-bot bot added the release notes: optim label Nov 8, 2023

pytorchbot added the open source label Nov 8, 2023

Fix docstrings on optim and autograd

7c5cdb7

alperenunlu force-pushed the fix-docstring-optim_autograd branch from e9c1840 to 7c5cdb7 Compare November 8, 2023 03:02

albanD added triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module docathon-h2-2023 Issues for the docathon in H2 2023 labels Nov 8, 2023

albanD requested review from svekars and removed request for albanD November 8, 2023 19:25

svekars reviewed Nov 8, 2023

View reviewed changes

Update optimizer.py

6b645d7

svekars added the medium Label for medium docathon tasks label Nov 9, 2023

soulitzer reviewed Nov 10, 2023

View reviewed changes

torch/optim/optimizer.py Outdated Show resolved Hide resolved

soulitzer reviewed Nov 10, 2023

View reviewed changes

torch/optim/optimizer.py Outdated Show resolved Hide resolved

soulitzer reviewed Nov 10, 2023

View reviewed changes

torch/optim/lr_scheduler.py Outdated Show resolved Hide resolved

soulitzer reviewed Nov 10, 2023

View reviewed changes

alperenunlu added 3 commits November 10, 2023 18:42

Update optimizer.py

4e186bd

Update lr_scheduler.py

377cb4a

Update optimizer.py

8f5da01

alperenunlu and others added 2 commits November 10, 2023 19:58

Update optimizer.py

bcf4120

Merge branch 'main' into fix-docstring-optim_autograd

f21eb86

alperenunlu requested a review from svekars November 15, 2023 21:30

janeyx99 reviewed Nov 21, 2023

View reviewed changes

torch/optim/lr_scheduler.py Outdated Show resolved Hide resolved

janeyx99 reviewed Nov 21, 2023

View reviewed changes

torch/optim/lr_scheduler.py Outdated Show resolved Hide resolved

janeyx99 reviewed Nov 21, 2023

View reviewed changes

alperenunlu and others added 8 commits November 22, 2023 02:36

Update torch/optim/lr_scheduler.py

6532eef

Co-authored-by: Jane (Yuan) Xu <31798555+janeyx99@users.noreply.github.com>

Update torch/optim/lr_scheduler.py

a523961

Co-authored-by: Jane (Yuan) Xu <31798555+janeyx99@users.noreply.github.com>

Update torch/optim/lr_scheduler.py

a58386f

Co-authored-by: Jane (Yuan) Xu <31798555+janeyx99@users.noreply.github.com>

Update torch/optim/lr_scheduler.py

daa7f99

Co-authored-by: Jane (Yuan) Xu <31798555+janeyx99@users.noreply.github.com>

Update torch/optim/lr_scheduler.py

30a877b

Co-authored-by: Jane (Yuan) Xu <31798555+janeyx99@users.noreply.github.com>

Update torch/optim/lr_scheduler.py

f667db8

Co-authored-by: Jane (Yuan) Xu <31798555+janeyx99@users.noreply.github.com>

Update optimizer.py

1542523

Update torch/optim/lr_scheduler.py

a1f039b

Co-authored-by: Jane (Yuan) Xu <31798555+janeyx99@users.noreply.github.com>

github-actions bot added the Stale label Jan 21, 2024

janeyx99 removed the Stale label Feb 5, 2024

janeyx99 approved these changes Feb 5, 2024

View reviewed changes

github-actions bot added the Stale label Apr 5, 2024

github-actions bot closed this May 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix docstrings on torch/optim and torch/autograd #113218

Fix docstrings on torch/optim and torch/autograd #113218

alperenunlu commented Nov 8, 2023

pytorch-bot bot commented Nov 8, 2023 •

edited

Loading

linux-foundation-easycla bot commented Nov 8, 2023 •

edited

Loading

svekars Nov 8, 2023

svekars Nov 8, 2023

svekars Nov 8, 2023

alperenunlu commented Nov 8, 2023

soulitzer Nov 10, 2023

soulitzer Nov 10, 2023

alperenunlu Nov 10, 2023

soulitzer Nov 10, 2023

alperenunlu Nov 10, 2023

soulitzer Nov 10, 2023

soulitzer left a comment

alperenunlu commented Nov 10, 2023

alperenunlu commented Nov 10, 2023

soulitzer commented Nov 16, 2023

janeyx99 Nov 21, 2023

alperenunlu Nov 21, 2023

janeyx99 Nov 21, 2023

alperenunlu Nov 22, 2023

janeyx99 Nov 21, 2023

janeyx99 Nov 21, 2023

alperenunlu Nov 22, 2023

janeyx99 left a comment •

edited

Loading

alperenunlu commented Nov 22, 2023

github-actions bot commented Jan 21, 2024

janeyx99 left a comment

janeyx99 commented Feb 5, 2024

github-actions bot commented Apr 5, 2024

		"""Decays the learning rate of each parameter group by a small constant factor.

		Until the number of epoch reaches a pre-defined milestone: total_iters.

	Receives the list of schedulers that is expected to be called sequentially during optimization process.
	Receives the list of schedulers that is expected to be called sequentially during the optimization process.

	"""Sets the learning rate of each parameter group to the initial lr times a given function.
	"""Set the learning rate of each parameter group to the initial lr times a given function.

	When last_epoch=-1, sets initial lr as lr.
	When last_epoch=-1, set the initial lr as lr.

	When last_epoch=-1, sets initial lr as lr.
	When last_epoch=-1, set initial lr as lr.

Fix docstrings on torch/optim and torch/autograd #113218

Fix docstrings on torch/optim and torch/autograd #113218

Conversation

alperenunlu commented Nov 8, 2023

Description

pytorch-bot bot commented Nov 8, 2023 • edited Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/113218

✅ You can merge normally! (1 Unrelated Failure)

linux-foundation-easycla bot commented Nov 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alperenunlu commented Nov 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soulitzer left a comment

Choose a reason for hiding this comment

alperenunlu commented Nov 10, 2023

alperenunlu commented Nov 10, 2023

soulitzer commented Nov 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

janeyx99 left a comment • edited Loading

Choose a reason for hiding this comment

alperenunlu commented Nov 22, 2023

github-actions bot commented Jan 21, 2024

janeyx99 left a comment

Choose a reason for hiding this comment

janeyx99 commented Feb 5, 2024

github-actions bot commented Apr 5, 2024

pytorch-bot bot commented Nov 8, 2023 •

edited

Loading

linux-foundation-easycla bot commented Nov 8, 2023 •

edited

Loading

janeyx99 left a comment •

edited

Loading