Skip to content
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.

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

Fix Typo in Autograd Documentation for Gradient Description (Fixes #41) #42

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

agentmarketbot
Copy link

Pull Request Description

Summary

This pull request addresses issue #41 by correcting a typographical error in the documentation related to the gradient calculations in PyTorch's Autograd system. The updates clarify the definition of x.grad to ensure that it accurately conveys the information regarding gradients.

Changes Made

  1. In README.md:

    • Updated the description of x.grad to:

      If x is a Tensor that has x.requires_grad=True, then x.grad is another Tensor holding the gradient of scalar (usually loss) with respect to x.

  2. In autograd/two_layer_net_autograd.py:

    • Updated comments to reflect the same correction regarding the relationship between gradients and the scalar (loss).

Rationale

The original phrasing was ambiguous, potentially leading to confusion about what x.grad represents. This correction ensures that users of the library have a clear understanding of gradient computations, which is essential for effective use of the Autograd features in PyTorch.

Testing

There are no direct tests associated with documentation changes; however, the modifications have been reviewed to ensure that they accurately represent the functionality of the library.

Conclusion

These updates aim to improve the clarity and accuracy of the documentation. Please review the changes, and once approved, I will merge them into the main branch.

Fixes #41.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

typo
1 participant