Commits on Sep 7, 2022

1. Autogenerate parameter types in documentation from python typehints. …

   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 committed Sep 7, 2022
   Configuration menu

   • View commit details
   • Copy full SHA for d3b1e91
   • Browse repository at this point

   Copy the full SHA

   d3b1e91 View commit details

   Browse the repository at this point in the history