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

Add docstrings #1106

Merged
merged 14 commits into from
May 23, 2023
Merged

Conversation

edknv
Copy link
Contributor

@edknv edknv commented May 22, 2023

Note: This PR will be merged to tf/doc_strings_update (not main).

@edknv edknv requested a review from gabrielspmoreira May 22, 2023 15:39
@edknv edknv self-assigned this May 22, 2023
@edknv edknv requested a review from rnyak May 22, 2023 15:40
@edknv edknv added documentation Improvements or additions to documentation chore Maintenance for the repository labels May 22, 2023
@edknv edknv added this to the Merlin 23.05 milestone May 22, 2023
@@ -44,7 +44,6 @@ def InputBlock(
post: Optional[BlockType] = None,
aggregation: Optional[TabularAggregationType] = None,
seq: bool = False,
max_seq_length: Optional[int] = None,
Copy link
Contributor Author

@edknv edknv May 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This argument max_seq_length is removed because it doesn't seem to be used anywhere in the function.

@edknv edknv marked this pull request as ready for review May 22, 2023 15:52
@edknv
Copy link
Contributor Author

edknv commented May 23, 2023

I'll go ahead and merge this since this PR will be merged to tf/doc_strings_update not main.

@edknv edknv merged commit db4483c into NVIDIA-Merlin:tf/doc_strings_update May 23, 2023
@edknv edknv deleted the tf/doc_strings_update branch May 23, 2023 16:43
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 <[email protected]>
Co-authored-by: rnyak <[email protected]>
Co-authored-by: Adam Laiacano <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Maintenance for the repository documentation Improvements or additions to documentation skip-base-branch-check
Projects
None yet
1 participant