Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🖍️ improve the make_robust docs #72

Merged
merged 1 commit into from
Jun 24, 2022
Merged

🖍️ improve the make_robust docs #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions tsflex/features/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ def make_robust(
) -> Union[FuncWrapper, List[FuncWrapper]]:
"""Decorate `funcs` into one or multiple robust FuncWrappers.

More specifically this method does:\n
More specifically this method does (in the following order):\n
* `np.NaN` data input propagation / filtering
* `min_nb_samples` checking before feeding to `func`
(if not met, returns `error_val`)\n
Expand All @@ -179,9 +179,12 @@ def make_robust(
funcs: Union[Callable, FuncWrapper, List[Union[Callable, FuncWrapper]]]
The function which will be made robust.
min_nb_samples: int, optional
The minimum number of samples that are needed for `func` to be applied, by
default 1.
successfully.
The minimum number of samples that are needed for `func` to be applied
successfully, by default 1.
.. Note::
The number of samples are determined after the `passthrough_nans` filter
took place.

error_val: Any, optional
The error *return* value if the `min_nb_samples` requirement is not met, by
default `np.NaN`.
Expand Down