Update Documentation for TripletMarginLoss #105115
Closed
Conversation
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
This PR updates the documentation for `TripletMarginLoss` in `torch.nn`. The previous version of the documentation didn't mention the parameter `eps` used for numerical stability. This PR does the following: 1. Describes the purpose and use of the `eps` parameter in the `TripletMarginLoss` class documentation. 2. Includes `eps` in the example usage of `TripletMarginLoss`. Please review this update for the completeness with respect to the `TripletMarginLoss` functionality. If there are any issues or further changes needed, please let me know.
danielzhangau
requested review from
albanD,
jbschlosser and
mikaylagawarecki
as code owners
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/105115
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit d30539a: This comment was automatically generated by Dr. CI and updates every 15 minutes. |
mikaylagawarecki
added
topic: docs
There was a problem hiding this comment.
Thanks! The docs fixes look ok but could you please fix the failing lint
To fix the failing lint job running setup_lint and quicklint from your local pytorch directory and following the corresponding instructions should be sufficient, see here
soulitzer
added
the
triaged
|
@pytorchbot merge |
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 |
pytorchmergebot
pushed a commit
to mixarcid/pytorch
that referenced
this pull request
Jul 14, 2023
This PR updates the documentation for `TripletMarginLoss` in `torch.nn`. The previous version of the documentation didn't mention the parameter `eps` used for numerical stability. This PR does the following: 1. Describes the purpose and use of the `eps` parameter in the `TripletMarginLoss` class documentation. 2. Includes `eps` in the example usage of `TripletMarginLoss`. Please review this update for the completeness with respect to the `TripletMarginLoss` functionality. If there are any issues or further changes needed, please let me know. Pull Request resolved: pytorch#105115 Approved by: https://github.com/mikaylagawarecki
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
This PR updates the documentation for
TripletMarginLossintorch.nn. The previous version of the documentation didn't mention the parameterepsused for numerical stability.This PR does the following:
epsparameter in theTripletMarginLossclass documentation.epsin the example usage ofTripletMarginLoss.Please review this update for the completeness with respect to the
TripletMarginLossfunctionality. If there are any issues or further changes needed, please let me know.