KEMBAR78
Changed 'standard-deviation' to 'variance' in GroupNorm documentation by Uvi-12 · Pull Request #141982 · pytorch/pytorch · GitHub
Skip to content

Changed 'standard-deviation' to 'variance' in GroupNorm documentation #141982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

Changed 'standard-deviation' to 'variance' in GroupNorm documentation #141982

wants to merge 2 commits into from

Conversation

@Uvi-12
Copy link
Contributor

@Uvi-12 Uvi-12 commented Dec 3, 2024 •
edited
Loading

Fixes #141315

Updated the GroupNorm documentation to replace 'standard-deviation' with 'variance' to accurately reflect the calculation
method.

cc @albanD @mruberry @jbschlosser @walterddr @mikaylagawarecki @voznesenskym @penguinwu @EikanWang @jgong5 @Guobing-Chen @XiaobingSuper @zhuhaozhe @blzheng @wenzhe-nrv @jiayisunx @ipiszy @yf225 @chenyang78 @kadeng @muchulee8 @ColinPeppler @amjames @desertfire @chauhang @aakhundov

@pytorchbot label "topic: not user facing"

@pytorch-bot
Copy link

pytorch-bot bot commented Dec 3, 2024 •
edited
Loading

🔗 Helpful Links

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

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

✅ No Failures

As of commit 2640aee with merge base 61dc5e9 (image):
💚 Looks good so far! There are no failures yet. 💚

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

@Uvi-12
Copy link
Contributor Author

Uvi-12 commented Dec 3, 2024

@pytorchbot label "topic: not user facing"

@pytorch-bot pytorch-bot bot added the topic: not user facing topic category label Dec 3, 2024
@Uvi-12
Copy link
Contributor Author

Uvi-12 commented Dec 3, 2024 •
edited
Loading

@jbschlosser @jansel @jgong5 @ezyang @c-p-i-o Please review the PR, It should solve the issue.

mikaylagawarecki
mikaylagawarecki reviewed Dec 3, 2024
View reviewed changes
Copy link
Contributor

@mikaylagawarecki mikaylagawarecki left a comment

Choose a reason for hiding this comment

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

Should this also apply to the other *{Norm} ops (e.g. LayerNorm) that use the same phrasing?

@cpuhrsch cpuhrsch added module: nn Related to torch.nn triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels Dec 4, 2024
@Uvi-12
Copy link
Contributor Author

Uvi-12 commented Dec 4, 2024

@mikaylagawarecki Yes, this correction should apply to other operations if they use the same phrasing. Since the calculation is based on "variance," not "standard deviation," it's important to keep the documentation consistent.

This PR solve the issue in the mentioned file.

@mikaylagawarecki
Copy link
Contributor

Would you be okay to fix the other docs as well please

@Uvi-12
Copy link
Contributor Author

Uvi-12 commented Dec 4, 2024

Would you be okay to fix the other docs as well please

Sure, I will fix the other docs too.

@Uvi-12
Copy link
Contributor Author

Uvi-12 commented Dec 4, 2024 •
edited
Loading

@mikaylagawarecki Fixed all docs to replace instances of 'standard-deviation' with 'variance'. Please review and merge the PR.

mikaylagawarecki
mikaylagawarecki approved these changes Dec 4, 2024
View reviewed changes
Copy link
Contributor

@mikaylagawarecki mikaylagawarecki left a comment

Choose a reason for hiding this comment

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

Thanks

@mikaylagawarecki
Copy link
Contributor

@pytorchbot merge

@pytorch-bot pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Dec 4, 2024
@mikaylagawarecki mikaylagawarecki added release notes: nn release notes category topic: docs topic category and removed ciflow/trunk Trigger trunk jobs on your pull request module: nn Related to torch.nn labels Dec 4, 2024
@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

@pytorchmergebot
Copy link
Collaborator

Merge failed

Reason: 1 mandatory check(s) failed. The first few are:

Dig deeper by viewing the failures on hud

Details for Dev Infra team Raised by workflow job

Failing merge rule: Core Maintainers

@pytorch-bot
Copy link

pytorch-bot bot commented Dec 4, 2024

You are not authorized to force merges to this repository. Please use the regular @pytorchmergebot merge command instead

@Uvi-12
Copy link
Contributor Author

Uvi-12 commented Dec 4, 2024

@mikaylagawarecki Can you please help me with the failing tests, it is not merged due to them.

@mikaylagawarecki
Copy link
Contributor

@pytorchbot merge -r

@pytorch-bot pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Dec 4, 2024
@pytorchmergebot
Copy link
Collaborator

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

@pytorchmergebot
Copy link
Collaborator

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

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

@pytorchmergebot
Copy link
Collaborator

Merge failed

Reason: 3 mandatory check(s) failed. The first few are:

Dig deeper by viewing the failures on hud

Details for Dev Infra team Raised by workflow job

Failing merge rule: Core Maintainers

@Uvi-12
Copy link
Contributor Author

Uvi-12 commented Dec 4, 2024

@mikaylagawarecki Maybe it requires approval for the workflows or you can directly merge the PR.

@mikaylagawarecki
Copy link
Contributor

@pytorchbot merge

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

pobin6 pushed a commit to pobin6/pytorch that referenced this pull request Dec 5, 2024
@Uvi-12
Changed 'standard-deviation' to 'variance' in GroupNorm documentation (…
7bff340 
…pytorch#141982)

Fixes pytorch#141315

Updated the GroupNorm documentation to replace 'standard-deviation' with 'variance' to accurately reflect the calculation
method.

@pytorchbot label "topic: not user facing"
Pull Request resolved: pytorch#141982
Approved by: https://github.com/mikaylagawarecki
@Uvi-12 Uvi-12 deleted the var branch December 5, 2024 12:30
@Uvi-12 Uvi-12 mentioned this pull request Dec 6, 2024
Closed
AmdSampsa pushed a commit to AmdSampsa/pytorch that referenced this pull request Dec 9, 2024
@Uvi-12 @AmdSampsa
Changed 'standard-deviation' to 'variance' in GroupNorm documentation (…
7be67ca 
…pytorch#141982)

Fixes pytorch#141315

Updated the GroupNorm documentation to replace 'standard-deviation' with 'variance' to accurately reflect the calculation
method.

@pytorchbot label "topic: not user facing"
Pull Request resolved: pytorch#141982
Approved by: https://github.com/mikaylagawarecki
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mikaylagawarecki mikaylagawarecki mikaylagawarecki approved these changes

@albanD albanD Awaiting requested review from albanD albanD is a code owner

@jbschlosser jbschlosser Awaiting requested review from jbschlosser jbschlosser is a code owner

Assignees

No one assigned

Labels

ciflow/trunk Trigger trunk jobs on your pull request Merged open source release notes: nn release notes category topic: docs topic category topic: not user facing topic category triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

GroupNorm Doc Typo: Should Be Variance

5 participants

@Uvi-12 @mikaylagawarecki @pytorchmergebot @cpuhrsch @pytorchbot