-
Notifications
You must be signed in to change notification settings - Fork 2.1k
[GLUON] Docstrings for public functions #7323
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
Conversation
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.
Seems reasonable, a few comments though.
Args: | ||
handle (ir.Value): The IR value representing the allocation handle. | ||
element_ty (dtype): The data type of each element. | ||
shape (List[int]): The dimensions of the descriptor. | ||
layout (SharedLayout): The layout of the shared memory. | ||
alloc_shape (List[int]): The actual allocation shape. |
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.
Since the __init__
is not part of the public API, we probably don't want the arguments documented here.
python/triton/experimental/gluon/language/nvidia/ampere/async_copy.py
Outdated
Show resolved
Hide resolved
python/triton/experimental/gluon/language/nvidia/ampere/async_copy.py
Outdated
Show resolved
Hide resolved
python/triton/experimental/gluon/language/nvidia/blackwell/__init__.py
Outdated
Show resolved
Hide resolved
python/triton/experimental/gluon/language/nvidia/blackwell/tma.py
Outdated
Show resolved
Hide resolved
python/triton/experimental/gluon/language/nvidia/blackwell/tma.py
Outdated
Show resolved
Hide resolved
python/triton/experimental/gluon/language/nvidia/hopper/__init__.py
Outdated
Show resolved
Hide resolved
python/triton/experimental/gluon/language/nvidia/hopper/__init__.py
Outdated
Show resolved
Hide resolved
python/triton/experimental/gluon/language/nvidia/hopper/__init__.py
Outdated
Show resolved
Hide resolved
Thanks for taking the time @peterbell10 ! |
Adding documentation for public gluon API. Generated by codex, with proof-reading and editing some of the issues by me. Formatting differs from triton docstrings, (using Google style rather than reST), but subjectively this seems more readable. Changing to reST formatting should be relatively easy if people have strong opinions about this.