DOC: Correct torch.trapezoid docstring (#141459)

arthurfeeney · pytorchmergebot · commit 0c587c324dc9 · 2024-11-27T01:54:14.000Z
This is super duper minor, but I believe this corrects a typo in the documentation of `torch.trapezoid`. The documentation says the input is a 1-dimensional tensor $y_0, \dots, y_n$, but it uses summations going from 1 to n-1. Since it's summing over terms $y_i - y_{i-1}$, stopping at n-1 excludes the last partition $y_n - y_{n-1}$, which doesn't match the implementation... ```python # (just showing it does include $y_n - y_{n-1}$) torch.trapezoid([0, 0, 9999]) == 9999 / 2 ``` Pull Request resolved: #141459 Approved by: https://github.com/colesbury
diff --git a/torch/_torch_docs.py b/torch/_torch_docs.py
@@ -12673,14 +12673,14 @@ def merge_dicts(*dicts):
 
 .. math::
     \begin{aligned}
-        \sum_{i = 1}^{n-1} \frac{1}{2} (y_i + y_{i-1})
+        \sum_{i = 1}^{n} \frac{1}{2} (y_i + y_{i-1})
     \end{aligned}
 
 When :attr:`dx` is specified the computation becomes
 
 .. math::
     \begin{aligned}
-        \sum_{i = 1}^{n-1} \frac{\Delta x}{2} (y_i + y_{i-1})
+        \sum_{i = 1}^{n} \frac{\Delta x}{2} (y_i + y_{i-1})
     \end{aligned}
 
 effectively multiplying the result by :attr:`dx`. When :attr:`x` is specified,
@@ -12689,7 +12689,7 @@ def merge_dicts(*dicts):
 
 .. math::
     \begin{aligned}
-        \sum_{i = 1}^{n-1} \frac{(x_i - x_{i-1})}{2} (y_i + y_{i-1})
+        \sum_{i = 1}^{n} \frac{(x_i - x_{i-1})}{2} (y_i + y_{i-1})
     \end{aligned}
 
 When :attr:`x` and :attr:`y` have the same size, the computation is as described above and no broadcasting is needed.
