Skip to content

Commit

Permalink
Fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
benHeid committed Oct 12, 2023
1 parent b7c32fe commit 10b4d2a
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions sktime/transformations/merger.py
Expand Up @@ -32,6 +32,10 @@ class Merger(BaseTransformer):
----------
method : {`median`, `mean`}, default="median"
The method to use for aggregation. Can be one of "mean" or "median".
stride : int, default=0
The stride to use for the aggregation. The stride determines the number of
shifts between consecutive instances. A stride of 0 means no shift. A
stride of 1 means that the time series is aggregated as above.
Examples
--------
Expand All @@ -40,6 +44,13 @@ class Merger(BaseTransformer):
>>> y = _make_panel(n_instances=10, n_columns=3, n_timepoints=5)
>>> result = Merger(method="median").fit_transform(y)
>>> result.shape
(3, 5)
>>> from sktime.transformations.merger import Merger
>>> from sktime.utils._testing.panel import _make_panel
>>> y = _make_panel(n_instances=10, n_columns=3, n_timepoints=5)
>>> result = Merger(method="median", stride=1).fit_transform(y)
>>> result.shape
(14, 3, 1)
"""

Expand Down

0 comments on commit 10b4d2a

Please sign in to comment.