[WIP] add docstrings in mms classes and functions #1101
Merged
Conversation
This file contains 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
gabrielspmoreira
force-pushed
the
tf/doc_strings_update
branch
from
8efbd36 to
48b4998
Compare
| @@ -34,52 +34,55 @@ def DLRMBlock( | |||
| *, | |||
| embedding_dim: int = None, | |||
| embedding_options: EmbeddingOptions = None, | |||
| embeddings: Optional[Block] = None, | |||
There was a problem hiding this comment.
Let's not move the order of arguments if possible - it's a breaking change in the unlikely case where people provide all of the arguments in order as opposed to using named arguments.
There was a problem hiding this comment.
The * on line 34 forces the remaining arguments to be keword arguments. which makes them robust to the order here
There was a problem hiding this comment.
@nv-alaiacano thanks for your comment. Make sense, I talked to Oliver, I think we are safe changing the position of the arg thanks to * arg there. It makes everything forced to be a keyword arg, rather than a positional arg.
edknv
added a commit
that referenced
this pull request
Jun 12, 2023
* Fixed docstrings * [WIP] add docstrings in mms classes and functions (#1101) * add docstings * add docstrings * Add docstrings (#1106) * Add docstrings to Encoder * Add docstrings to ItemRetrievalScorer * Add docstrings to Model * Fix docstring for TwoTowerModel * Add docstring to YoutubeDNNRetrievalModelV2 * Add docstrings to L2Norm * Add docstrings to ContinuousFeatures * Add docstrings to AverageEmbeddingsByWeightFeature * Add docstrings to ReplaceMaskedEmbeddings * Add docstrings to SequenceEmbeddingFeatures * Add docstrings to EmbeddingTable * lint * lint * lint * update docstring syntax --------- Co-authored-by: Gabriel Moreira <gmoreira@nvidia.com> Co-authored-by: rnyak <16246900+rnyak@users.noreply.github.com> Co-authored-by: Adam Laiacano <alaiacano@nvidia.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 is still WIP.