Update docstrings and errors

alvgaona · alvgaona · commit 5bb92437ff78 · 2022-10-11T14:15:12.000-03:00
diff --git a/torch/signal/windows/windows.py b/torch/signal/windows/windows.py
@@ -42,7 +42,7 @@ def _window_function_checks(function_name: str, M: int, dtype: torch.dtype, layo
          layout (:class:`torch.layout`): the desired layout of the window tensor.
      """
     if M < 0:
-        raise ValueError(f'{function_name} requires non-negative window_length, got window_length={M}')
+        raise ValueError(f'{function_name} requires non-negative window length, got M={M}')
     if layout is not torch.strided:
         raise ValueError(f'{function_name} is implemented for strided tensors only, got: {layout}')
     if not is_float_dtype(dtype):
@@ -66,7 +66,7 @@ def _window_function_checks(function_name: str, M: int, dtype: torch.dtype, layo
         In other words, the number of points of the exponential window.
     center (float, optional): where the center of the window will be located.
         In other words, at which sample the peak of the window can be found.
-        Default: `window_length / 2` if `periodic` is `True` (default), else `(window_length - 1) / 2`.
+        Default: `M / 2` if `sym` is `False`, else `(M - 1) / 2`.
     tau (float, optional): the decay value. Default: 1.0.
     sym (bool, optional): If `False`, returns a periodic window suitable for use in spectral analysis.
         If `True`, returns a symmetric window suitable for use in filter design. Default: `True`.
diff --git a/torch/testing/_internal/opinfo/definitions/signal.py b/torch/testing/_internal/opinfo/definitions/signal.py
@@ -57,7 +57,7 @@ def error_inputs_window(op_info, device, *args, **kwargs):
     yield ErrorInput(
         SampleInput(-1, *args, dtype=torch.float32, device=device, **kwargs),
         error_type=ValueError,
-        error_regex="requires non-negative window_length, got window_length=-1",
+        error_regex="requires non-negative window length, got M=-1",
     )
 
     # Tests for window tensors that are not torch.strided, for instance, torch.sparse_coo.

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ def error_inputs_window(op_info, device, args, *kwargs):`
`57`	`57`	`yield ErrorInput(`
`58`	`58`	`SampleInput(-1, args, dtype=torch.float32, device=device, *kwargs),`
`59`	`59`	`error_type=ValueError,`
`60`		`- error_regex="requires non-negative window_length, got window_length=-1",`
	`60`	`+ error_regex="requires non-negative window length, got M=-1",`
`61`	`61`	`)`
`62`	`62`
`63`	`63`	`# Tests for window tensors that are not torch.strided, for instance, torch.sparse_coo.`