-
Notifications
You must be signed in to change notification settings - Fork 50
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
Add docstrings #1110
Add docstrings #1110
Conversation
* 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
Documentation preview |
@@ -526,23 +627,90 @@ def fit(self, *args, **kwargs): | |||
|
|||
@tf.keras.utils.register_keras_serializable(package="merlin.models") | |||
class EmbeddingEncoder(Encoder): | |||
"""Creates an Encoder from an EmbeddingTable. | |||
Typically used with RetrievalModelV2. | |||
Parameters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I resolved these and some other instances of this pattern in the repo.
Adding docstrings from the doc bash.