Update torch.var documentation to use modern API#167209
Closed
mohsinm-dev wants to merge 1 commit intopytorch:mainfrom
Closed
Update torch.var documentation to use modern API#167209mohsinm-dev wants to merge 1 commit intopytorch:mainfrom
mohsinm-dev wants to merge 1 commit intopytorch:mainfrom
Conversation
Fix outdated `unbiased` parameter references in normalization module documentation. Replace deprecated `torch.var(input, unbiased=False/True)` with modern `torch.var(input, correction=0/1)` API throughout BatchNorm, InstanceNorm, LayerNorm, and GroupNorm docstrings. The mathematical behavior remains identical: - unbiased=False ≡ correction=0 (biased estimator) - unbiased=True ≡ correction=1 (unbiased estimator) Fixes pytorch#166804
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/167209
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit c74d230 with merge base a51208c ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
|
|
Contributor
Author
|
@pytorchbot label "release notes: documentation" |
|
Didn't find following labels among repository labels: release notes: documentation |
Contributor
Author
|
@pytorchbot label "release notes: nn" |
Collaborator
|
@pytorchbot merge |
Collaborator
Merge startedYour 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 |
yarongmu-google
pushed a commit
to yarongmu-google/pytorch
that referenced
this pull request
Nov 7, 2025
## Summary Fix outdated unbiased parameter references in normalization module documentation. Replace deprecated torch.var(input, unbiased=False/True) with modern torch.var(input, correction=0/1) API throughout BatchNorm, InstanceNorm, LayerNorm, and GroupNorm docstrings. ## Changes - torch/nn/modules/batchnorm.py: Updated 4 instances across BatchNorm1d, BatchNorm2d, BatchNorm3d, and SyncBatchNorm - torch/nn/modules/instancenorm.py: Updated 3 instances across InstanceNorm1d, InstanceNorm2d, and InstanceNorm3d - torch/nn/modules/normalization.py: Updated 2 instances in LayerNorm and GroupNorm ## Test plan Mathematical behavior remains identical: unbiased=False ≡ correction=0 (biased estimator), unbiased=True ≡ correction=1 (unbiased estimator). Documentation now uses consistent modern API terminology with no functional changes to code behavior. Fixes pytorch#166804 Pull Request resolved: pytorch#167209 Approved by: https://github.com/albanD
Silv3S
pushed a commit
to Silv3S/pytorch
that referenced
this pull request
Nov 18, 2025
## Summary Fix outdated unbiased parameter references in normalization module documentation. Replace deprecated torch.var(input, unbiased=False/True) with modern torch.var(input, correction=0/1) API throughout BatchNorm, InstanceNorm, LayerNorm, and GroupNorm docstrings. ## Changes - torch/nn/modules/batchnorm.py: Updated 4 instances across BatchNorm1d, BatchNorm2d, BatchNorm3d, and SyncBatchNorm - torch/nn/modules/instancenorm.py: Updated 3 instances across InstanceNorm1d, InstanceNorm2d, and InstanceNorm3d - torch/nn/modules/normalization.py: Updated 2 instances in LayerNorm and GroupNorm ## Test plan Mathematical behavior remains identical: unbiased=False ≡ correction=0 (biased estimator), unbiased=True ≡ correction=1 (unbiased estimator). Documentation now uses consistent modern API terminology with no functional changes to code behavior. Fixes pytorch#166804 Pull Request resolved: pytorch#167209 Approved by: https://github.com/albanD
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix outdated unbiased parameter references in normalization module documentation. Replace deprecated torch.var(input, unbiased=False/True) with modern torch.var(input, correction=0/1) API throughout BatchNorm, InstanceNorm, LayerNorm, and GroupNorm docstrings.
Changes
Test plan
Mathematical behavior remains identical: unbiased=False ≡ correction=0 (biased estimator), unbiased=True ≡ correction=1 (unbiased estimator). Documentation now uses consistent modern API terminology with no functional changes to code behavior.
Fixes #166804