Autogenerate parameter types in documentation from python typehints #2125
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gpleiss
force-pushed
the
doc_typehints
branch
from
3d1b3e5
to
1a7cf09
Compare
For example: if the method is...
```python
def forward(self, x1: Tensor, x2: Optional[Tensor]) -> Union[Tensor, LinearOperator]:
r"""
Does the forward thing.
:param x1: The x1 arg
:param x2: The x2 arg
:return: The forward stuff.
"""
# ...
```
The resulting documentation will include the appropriate types:
```
Parameters:
- x1 (torch.Tensor) - The x1 arg
- x2 (torch.Tensor, optional) - The x2 arg
Return type: torch.Tensor or LinearOperator
Returns: The forward stuff.
```
This (hopefully) should prevent a lot of duplicate effort on our end.
This commit also refactors the gpytorch.kernels.Kernel and
gpytorch.distributions.MultivariateNormal docs to utilize
auto-typing.
gpleiss
force-pushed
the
doc_typehints
branch
from
1a7cf09
to
d3b1e91
Compare
Balandat
approved these changes
Sep 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For example: if the method is...
The resulting documentation will include the appropriate types:
This (hopefully) should prevent a lot of duplicate effort on our end.
This PR also refactors the gpytorch.kernels.Kernel and gpytorch.distributions.MultivariateNormal docs to utilize auto-typing.