Skip to content

Add usage example to KeyedJaggedTensor docstring #3121

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

Closed
wants to merge 1 commit into from

Conversation

vaishnavirao24
Copy link

This PR adds a practical usage example to the KeyedJaggedTensor docstring
to improve developer understanding of how it represents variable-length
sequences across multiple keys.

This addition provides:

  • A realistic input example
  • Explanation of the keys, values, and lengths
  • Context on where KJT is used in recommendation systems

No code logic was changed. Pure documentation improvement.

@facebook-github-bot
Copy link
Contributor

Hi @vaishnavirao24!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jun 20, 2025
@vaishnavirao24
Copy link
Author

Hi, I’ve signed the CLA and all checks have passed
This is a small documentation enhancement — happy to make any changes if needed!
Thanks for reviewing

@facebook-github-bot
Copy link
Contributor

@TroyGarden has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@TroyGarden
Copy link
Contributor

thanks @vaishnavirao24 for adding the docstring. please address the pre-commit test error

@TroyGarden TroyGarden closed this Jun 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants