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

Adding very short section on conventions. #4508

Closed
amueller opened this issue Apr 3, 2015 · 3 comments
Closed

Adding very short section on conventions. #4508

amueller opened this issue Apr 3, 2015 · 3 comments
Labels
Documentation Easy Well-defined and straightforward way to resolve

Comments

@amueller
Copy link
Member

amueller commented Apr 3, 2015

Just saw #1679 again and thought we should add some "conventions" documentation.
I think adding a short paragraph about sklearn rules and expectations to the "quick start guide" would be nice.

It should contain "unless otherwise specified, input will be cast to float64", regression targets will be converted to float64, classification targets can be arbitrary and the same type will be produced again.
Also maybe in the same place say that calling fit will forget any previous models, and maybe that parameters can be set using estimator.parameter = stuff?

I have no other ideas what should be there.

@amueller amueller added Easy Well-defined and straightforward way to resolve Documentation labels Apr 3, 2015
@cangermueller
Copy link
Contributor

@amueller, is this the "quick start guide"? I can create a convention section about the fact that

  • input will be cast to float64, and
  • fit() overwrites the state of previous models

Can you elaborate on what you mean with estimator.paramter = stuff?

@amueller
Copy link
Member Author

amueller commented Apr 5, 2015

The link you gave is very old (version 0.10). I meant this: http://scikit-learn.org/dev/tutorial/basic/tutorial.html
Which you can find on the documentation page under "Quick start". It is indeed the newer version of the page you linked to.

I meant that you can set parameters on an object before fitting without reconstructing the object.

@amueller
Copy link
Member Author

closed in 0fe613e

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Easy Well-defined and straightforward way to resolve
Projects
None yet
Development

No branches or pull requests

2 participants