Add docstrings #1110
Merged
Add docstrings #1110
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
* add docstings * add docstrings
* 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
edknv
added
documentation
Documentation preview |
nv-alaiacano
reviewed
Jun 2, 2023
| class EmbeddingEncoder(Encoder): | ||
| """Creates an Encoder from an EmbeddingTable. | ||
| Typically used with RetrievalModelV2. | ||
| Parameters |
Contributor
There was a problem hiding this comment.
We need a whitespace line before Parameters and before Returns or else it won't format right.
Here's an example of how this looks when the spacing is missing: https://nvidia-merlin.github.io/models/review/pr-1110/generated/merlin.models.tf.EmbeddingEncoder.html#merlin.models.tf.EmbeddingEncoder
Other places where this occurs:
- ModelBlock
- MetricsComputeCallback
- _maybe_convert_merlin_dataset
- get_task_name
- _get_col_set_by_tags
- _set_task_block
- default_binary_metrics
- default_categorical_prediction_metrics
Contributor
There was a problem hiding this comment.
I resolved these and some other instances of this pattern in the repo.
nv-alaiacano
approved these changes
Jun 12, 2023
oliverholworthy
approved these changes
Jun 12, 2023
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.
Adding docstrings from the doc bash.