-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Docs: Added missing documentation for out_sharding in lax.conv_general_dilated #33494
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
base: main
Are you sure you want to change the base?
Docs: Added missing documentation for out_sharding in lax.conv_general_dilated #33494
Conversation
Summary of ChangesHello @Prakharprasun, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a documentation gap by providing a comprehensive explanation for the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request adds the missing documentation for the out_sharding parameter in lax.conv_general_dilated. The added docstring is helpful. I've suggested a small revision to make it more concise and to clarify the behavior when out_sharding is not specified, which will make it more complete for users.
jax/_src/lax/convolution.py
Outdated
| Can be a :class:`~jax.sharding.NamedSharding`, a | ||
| :class:`~jax.sharding.PartitionSpec` (``P``), or ``None`` (default). | ||
| If unspecified, the sharding is inferred from the inputs where possible, | ||
| otherwise an error is raised. Primarily used in explicit sharding mode. |
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.
Please add a link to the explicit sharding doc: https://docs.jax.dev/en/latest/notebooks/explicit-sharding.html
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.
Thanks for the suggestion!
I've added it as:
“... See the explicit sharding tutorial <https://docs.jax.dev/en/latest/notebooks/explicit-sharding.html>_ for more details. “
I would be happy to refine further based on your suggestions.
a94be04 to
7dec320
Compare
|
Can you squash please? |
…l_dilated The parameter `out_sharding` was present in the function signature but missing its description. This commit adds the complete documentation, including details on inference behavior and a link to the explicit sharding tutorial.
7dec320 to
3ac23b5
Compare
Done. |
Added missing documentation for out_sharding in lax.conv_general_dilated
The parameter out_sharding was present in the function signature but missing its description in the docstring
The added documentation covers the parameter's info.