Skip to content

Commit e72eb3f

Browse files
authored
Apply suggestions from code review
1 parent de38539 commit e72eb3f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

lib/nx_signal/filters.ex

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,11 @@ defmodule NxSignal.Filters do
5858
Applies a Wiener filter to the given Nx tensor.
5959
6060
## Options
61-
* `:kernel_size` - filter size (scalar or tuple). Defaults to `3`.
62-
* `:noise` - noise power, auto-estimated if `nil`. Defaults to `nil`.
61+
62+
* `:kernel_size` - filter size given either a number or a tuple.
63+
If a number is given, a kernel with the given size, and same number of axes
64+
as the input tensor will be used. Defaults to `3`.
65+
* `:noise` - noise power, given as a scalar. This will be estimated based on the input tensor if `nil`. Defaults to `nil`.
6366
6467
## Examples
6568

0 commit comments

Comments
 (0)