The Wayback Machine - https://web.archive.org/web/20201016061031/https://github.com/scikit-learn/scikit-learn/issues/18281
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

DOC Stop referencing preprocessing functions in user guide #18281

Open
lucyleeow opened this issue Aug 27, 2020 · 10 comments · May be fixed by #18327
Open

DOC Stop referencing preprocessing functions in user guide #18281

lucyleeow opened this issue Aug 27, 2020 · 10 comments · May be fixed by #18327

Comments

@lucyleeow
Copy link
Member

@lucyleeow lucyleeow commented Aug 27, 2020

Describe the issue linked to the documentation

Follows from #17387

Suggest a potential alternative/fix

Stop referencing preprocessing functions e.g. :

maxabs_scale
minmax_scale
normalize
quantile_transform
robust_scale
scale
power_transform

in the UG, and only add them e.g. in the "See Also" sections, or even just in the API ref.

In particular right now the first entry of the Preprocessing guide is scale. I think it should be StandardScaler within a pipeline.

@lucyleeow lucyleeow changed the title DOC Stop referencing preprocessing helpers in user guide DOC Stop referencing preprocessing functions in user guide Aug 27, 2020
@alfaro96
Copy link
Member

@alfaro96 alfaro96 commented Aug 27, 2020

These are the references of the preprocessing functions in the user guide:

  • maxabs_scale -> doc/modules/preprocessing.rst (line 185)
  • maxabs_scale -> doc/modules/preprocessing.rst (line 195)
  • maxabs_scale -> doc/modules/preprocessing.rst (line 244)
  • minmax_scale -> doc/modules/preprocessing.rst (line 185)
  • minmax_scale -> doc/modules/preprocessing.rst (line 243)
  • normalize -> doc/modules/preprocessing.rst(line 416)
  • normalize -> doc/modules/preprocessing.rst(line 423)
  • normalize -> doc/modules/preprocessing.rst(line 458)
  • quantile_transform -> doc/modules/preprocessing.rst(line 287)
  • scale -> doc/modules/preprocessing.rst(line 44)
  • scale -> doc/modules/preprocessing.rst(line 52)
  • scale -> doc/modules/preprocessing.rst(line 184)
  • scale -> doc/modules/preprocessing.rst(line 197)
  • scale -> doc/modules/preprocessing.rst(line 243)
  • robust_scale -> doc/modules/preprocessing.rst(line 221)
  • robust_scale -> doc/modules/preprocessing.rst(line 244)

Maybe it is better to have all this information in the issue description @lucyleeow?

@jnothman
Copy link
Member

@jnothman jnothman commented Aug 27, 2020

I think this is a good step. I'm not sure it needs a checklist, as I think it can be done in one pr, but code to check whether the job is done might be helpful.

@alfaro96
Copy link
Member

@alfaro96 alfaro96 commented Aug 28, 2020

You are absolutely right. Indeed, I would also recommend to solve this issue in one PR.

I have updated the comment to remove the checklist, but I have kept the information for contributors.

@OlehKSS
Copy link
Contributor

@OlehKSS OlehKSS commented Aug 28, 2020

Hi, does anyone work on it? I can give it a try otherwise

@lucyleeow
Copy link
Member Author

@lucyleeow lucyleeow commented Aug 28, 2020

If you comment 'take' the bot should assign it to you.

@OlehKSS
Copy link
Contributor

@OlehKSS OlehKSS commented Aug 28, 2020

Take

@alfaro96
Copy link
Member

@alfaro96 alfaro96 commented Aug 29, 2020

Hey @OlehKSS!

I think that it should be "take" instead of "Take".

Note: I think that it would be interesting to consider both options in the Assign workflow.

CC @thomasjpfan

@lucyleeow
Copy link
Member Author

@lucyleeow lucyleeow commented Aug 29, 2020

I think it the comment has to be just 'take' (without any other words) as well: https://scikit-learn.org/dev/developers/contributing.html#contributing-code

@OlehKSS
Copy link
Contributor

@OlehKSS OlehKSS commented Aug 30, 2020

take

@ivomarb
Copy link

@ivomarb ivomarb commented Sep 1, 2020

Hi @OlehKSS did you finish working in this issue? Do you need help?
Thanks in advance,
Best Regards,
Ivomar

@OlehKSS OlehKSS linked a pull request that will close this issue Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

5 participants
You can’t perform that action at this time.