Fix errors relating to pydocstyle in loss.py #113219

zabboud · 2023-11-08T00:51:04Z

Fixed errors relating to pydocstyle in torch/nn/modules/loss.py file. The remaining errors are related to docstrings at the module level and at methods within each class such as forward and __init__ methods.

pydocstyle torch/nn/modules/loss.py --count
before: 100
after: 46

remaining errors:

torch/nn/modules/loss.py:1 at module level:
        D100: Missing docstring in public module
torch/nn/modules/loss.py:97 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:100 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:210 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:215 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:219 in public class `NLLLoss2d`:
        D101: Missing docstring in public class
torch/nn/modules/loss.py:220 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:290 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:297 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:373 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:378 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:468 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:472 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:534 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:537 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:542 in public class `BCELoss`:
        D400: First line should end with a period (not ':')
torch/nn/modules/loss.py:617 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:620 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:721 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:729 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:789 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:793 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:857 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:860 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:940 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:944 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1003 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1007 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1044 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1047 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1186 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1192 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1240 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1243 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1303 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1307 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1363 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1367 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1436 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1448 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1531 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1539 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1648 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1656 in public method `forward`:
        D102: Missing docstring in public method
torch/nn/modules/loss.py:1801 in public method `__init__`:
        D107: Missing docstring in __init__
torch/nn/modules/loss.py:1806 in public method `forward`:
        D102: Missing docstring in public method

pytorch-bot · 2023-11-08T00:51:08Z

🔗 Helpful Links

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

📄 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.

✅ No Failures

As of commit 72650eb with merge base 1e60174 ():
💚 Looks good so far! There are no failures yet. 💚

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

zabboud · 2023-11-08T01:51:06Z

@pytorchbot label "docathon-h2-2023"

kit1980 · 2023-11-08T20:07:45Z

@pytorchbot rebase

pytorchmergebot · 2023-11-08T20:09:54Z

@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here

pytorchmergebot · 2023-11-08T20:10:06Z

Successfully rebased issue_112600 onto refs/remotes/origin/viable/strict, please pull locally before adding more changes (for example, via git checkout issue_112600 && git pull --rebase)

zabboud · 2023-11-09T13:16:40Z

@pytorchbot label "topic: not user facing"

zabboud · 2023-11-09T15:29:26Z

@svekars anything I can do to fix the lining errors?

mikaylagawarecki

To fix the failing lint job running make setup_lint and make quicklint from your local pytorch directory and following the corresponding instructions should be sufficient, see here

torch/nn/modules/loss.py

Co-authored-by: mikaylagawarecki <mikaylagawarecki@gmail.com>

mikaylagawarecki · 2023-11-09T22:01:19Z

Could you fix lint please

mikaylagawarecki · 2023-11-09T22:03:18Z

Additionally, SoftMarginLoss might be causing the docs-build to fail, see the logs here https://hud.pytorch.org/pr/pytorch/pytorch/113219#18538106599. Could you fix this please

zabboud · 2023-11-10T15:00:20Z

@mikaylagawarecki @svekars checks have passed - awaiting approval

kit1980 · 2023-11-10T22:27:00Z

@zabboud please don't do submodules updates changes.

This reverts commit 106702b.

zabboud · 2023-11-10T22:44:35Z

@zabboud please don't do submodules updates changes.

@kit1980 apologies - I've reverted those changes.

zabboud · 2023-11-12T20:26:25Z

@kit1980 @svekars @mikaylagawarecki all checked have passed - can the merge be initiated to close this PR?

zabboud · 2023-11-14T18:48:06Z

@svekars @kit1980 @mikaylagawarecki Can you please assist in these failures? How can they be addressed?

zabboud · 2023-11-14T19:19:16Z

@pytorchbot rebase

pytorchmergebot · 2023-11-14T19:21:06Z

@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here

pytorchmergebot · 2023-11-14T19:21:09Z

Rebase failed due to Command git -C /home/runner/work/pytorch/pytorch rebase refs/remotes/origin/viable/strict pull/113219/head returned non-zero exit code 1

Rebasing (1/8)
Rebasing (2/8)
Rebasing (3/8)
Auto-merging torch/nn/modules/loss.py
CONFLICT (content): Merge conflict in torch/nn/modules/loss.py
error: could not apply 795662a9089... fix errors relating to pydocstyle
hint: Resolve all conflicts manually, mark them as resolved with
hint: "git add/rm <conflicted_files>", then run "git rebase --continue".
hint: You can instead skip this commit: run "git rebase --skip".
hint: To abort and get back to the state before "git rebase", run "git rebase --abort".
Could not apply 795662a9089... fix errors relating to pydocstyle

Raised by /~https://github.com/pytorch/pytorch/actions/runs/6868448872

svekars · 2023-11-15T16:14:31Z

The doc build is still failing:

/opt/conda/envs/py_3.8/lib/python3.8/site-packages/torch/nn/modules/loss.py:docstring of torch.nn.modules.loss.SoftMarginLoss:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/var/lib/jenkins/workspace/docs/source/nn.rst:316:<autosummary>:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.

fix build issue related to softMarginLoss docstring summary

zabboud · 2023-11-15T16:28:30Z

The doc build is still failing:

/opt/conda/envs/py_3.8/lib/python3.8/site-packages/torch/nn/modules/loss.py:docstring of torch.nn.modules.loss.SoftMarginLoss:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/var/lib/jenkins/workspace/docs/source/nn.rst:316:<autosummary>:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.

@svekars I've changed the summary line - hopefully it'll address the docbuild issue.

zabboud · 2023-11-15T20:41:55Z

@pytorchbot merge

pytorch-bot · 2023-11-15T20:41:58Z

❌ 🤖 pytorchbot command failed:

@pytorchbot: error: argument command: invalid choice: ' merge' (choose from 'merge', 'revert', 'rebase', 'label', 'drci')

usage: @pytorchbot [-h] {merge,revert,rebase,label,drci} ...

Try @pytorchbot --help for more info.

zabboud · 2023-11-15T20:43:34Z

@pytorchbot merge

pytorch-bot · 2023-11-15T20:43:38Z

This PR needs to be approved by an authorized maintainer before merge.

zabboud · 2023-11-15T20:45:52Z

@svekars @mikaylagawarecki @kit1980 could you please approve, to be able to merge this PR. All checks have passed successfully.

zabboud · 2023-11-17T18:16:55Z

@jbschlosser @svekars @mikaylagawarecki could you please review/approve to close out this PR?

github-actions · 2024-02-13T19:33:51Z

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.

zabboud added 2 commits November 7, 2023 19:45

fix errors relating to pydocstyle

917203e

remove space from docstring in BCEWithLogitsLoss

7ec44ce

zabboud requested review from albanD, jbschlosser and mikaylagawarecki as code owners November 8, 2023 00:51

pytorchbot added the open source label Nov 8, 2023

pytorch-bot bot added the docathon-h2-2023 Issues for the docathon in H2 2023 label Nov 8, 2023

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

albanD added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label Nov 8, 2023

zabboud added 2 commits November 8, 2023 20:09

fix errors relating to pydocstyle

795662a

remove space from docstring in BCEWithLogitsLoss

fbe2003

pytorchmergebot force-pushed the issue_112600 branch from 7ec44ce to fbe2003 Compare November 8, 2023 20:10

pytorch-bot bot added the topic: not user facing topic category label Nov 9, 2023

zabboud changed the title ~~Fix errors relating to pydocstyle~~ Fix errors relating to pydocstyle in loss.py Nov 9, 2023

mikaylagawarecki reviewed Nov 9, 2023

View reviewed changes

torch/nn/modules/loss.py Outdated Show resolved Hide resolved

torch/nn/modules/loss.py Outdated Show resolved Hide resolved

torch/nn/modules/loss.py Outdated Show resolved Hide resolved

torch/nn/modules/loss.py Outdated Show resolved Hide resolved

Apply suggestions from code review

778f872

Co-authored-by: mikaylagawarecki <mikaylagawarecki@gmail.com>

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

Merge b 'issue_112600' of zabboud/pytorch

40ee9f9

Merge branch 'pytorch:main' into issue_112600

a6b9adf

linting branch

106702b

Revert "linting branch" - third_party changes

64afa20

This reverts commit 106702b.

fix lintrunner error

7769a12

Merge branch 'pytorch:main' into issue_112600

791c712

Update loss.py softmarginloss

a9ec593

fix build issue related to softMarginLoss docstring summary

zabboud added 3 commits November 15, 2023 12:11

fix indentation in softmarginloss docstring

2178d9b

fix lint error

9217ef3

fix indentation issue raised by docbuild

72650eb

github-actions bot added the Stale label Feb 13, 2024

github-actions bot closed this Mar 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix errors relating to pydocstyle in loss.py #113219

Fix errors relating to pydocstyle in loss.py #113219

zabboud commented Nov 8, 2023 •

edited

Loading

pytorch-bot bot commented Nov 8, 2023 •

edited

Loading

zabboud commented Nov 8, 2023

kit1980 commented Nov 8, 2023

pytorchmergebot commented Nov 8, 2023

pytorchmergebot commented Nov 8, 2023

zabboud commented Nov 9, 2023

zabboud commented Nov 9, 2023

mikaylagawarecki left a comment

mikaylagawarecki commented Nov 9, 2023

mikaylagawarecki commented Nov 9, 2023

zabboud commented Nov 10, 2023

kit1980 commented Nov 10, 2023 •

edited

Loading

zabboud commented Nov 10, 2023

zabboud commented Nov 12, 2023 •

edited

Loading

zabboud commented Nov 14, 2023

zabboud commented Nov 14, 2023

pytorchmergebot commented Nov 14, 2023

pytorchmergebot commented Nov 14, 2023

svekars commented Nov 15, 2023

zabboud commented Nov 15, 2023

zabboud commented Nov 15, 2023 •

edited

Loading

pytorch-bot bot commented Nov 15, 2023

zabboud commented Nov 15, 2023

pytorch-bot bot commented Nov 15, 2023

zabboud commented Nov 15, 2023 •

edited

Loading

zabboud commented Nov 17, 2023 •

edited

Loading

github-actions bot commented Feb 13, 2024

Fix errors relating to pydocstyle in loss.py #113219

Fix errors relating to pydocstyle in loss.py #113219

Conversation

zabboud commented Nov 8, 2023 • edited Loading

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

🔗 Helpful Links

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

✅ No Failures

zabboud commented Nov 8, 2023

kit1980 commented Nov 8, 2023

pytorchmergebot commented Nov 8, 2023

pytorchmergebot commented Nov 8, 2023

zabboud commented Nov 9, 2023

zabboud commented Nov 9, 2023

mikaylagawarecki left a comment

Choose a reason for hiding this comment

mikaylagawarecki commented Nov 9, 2023

mikaylagawarecki commented Nov 9, 2023

zabboud commented Nov 10, 2023

kit1980 commented Nov 10, 2023 • edited Loading

zabboud commented Nov 10, 2023

zabboud commented Nov 12, 2023 • edited Loading

zabboud commented Nov 14, 2023

zabboud commented Nov 14, 2023

pytorchmergebot commented Nov 14, 2023

pytorchmergebot commented Nov 14, 2023

svekars commented Nov 15, 2023

zabboud commented Nov 15, 2023

zabboud commented Nov 15, 2023 • edited Loading

pytorch-bot bot commented Nov 15, 2023

zabboud commented Nov 15, 2023

pytorch-bot bot commented Nov 15, 2023

zabboud commented Nov 15, 2023 • edited Loading

zabboud commented Nov 17, 2023 • edited Loading

github-actions bot commented Feb 13, 2024

zabboud commented Nov 8, 2023 •

edited

Loading

pytorch-bot bot commented Nov 8, 2023 •

edited

Loading

kit1980 commented Nov 10, 2023 •

edited

Loading

zabboud commented Nov 12, 2023 •

edited

Loading

zabboud commented Nov 15, 2023 •

edited

Loading

zabboud commented Nov 15, 2023 •

edited

Loading

zabboud commented Nov 17, 2023 •

edited

Loading