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.

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

Good documentation on default scaling behavior #1166

Closed
hrzn opened this issue Aug 23, 2022 · 3 comments
Closed

Good documentation on default scaling behavior #1166

hrzn opened this issue Aug 23, 2022 · 3 comments
Labels
documentation Creating or improving documentation

Comments

@hrzn
Copy link
Contributor

hrzn commented Aug 23, 2022

No description provided.

@hrzn hrzn added the documentation Creating or improving documentation label Aug 23, 2022
@adamkells
Copy link

Hi @hrzn , seems like I might have been too ambitious with the Window transformations as a first issue! Have significantly more time to contribute now, so was thinking of doing some documentation work unless you have a better suggestion for an issue to work on?

@hrzn
Copy link
Contributor Author

hrzn commented Nov 29, 2022

Hi @adamkells, sorry for my late reply! Yes, more & better documentation is always better :)

For this particular story, we had in mind of improving the docstring of Scaler, to explicit that the default sklearn scaler used under the hood may change e.g. MAPE error values, and point to other options that do not (e.g., MaxAbsScaler).

But in general adding more examples to docstrings a bit everywhere throughout the library, or complementing missing sections of the user guide, is always welcome 👍

@madtoinou
Copy link
Collaborator

madtoinou commented Sep 3, 2024

Closing this issue, the docstring of Scaler clearly indicate which sklearn scaler is used by default since #720 and the impact of the scaler on the metrics is implicit but sufficiently intuitive since the values of the series are directly modified.

Also, a lot of example/code snippets has been added by #1956.

#2020 also updated a lot of the notebook to avoid data-leak between training and validation/test set when using Scaler.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Creating or improving documentation
Projects
None yet
Development

No branches or pull requests

3 participants