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

Create a KeystoneML style guide #113

Open
tomerk opened this issue May 17, 2015 · 1 comment
Open

Create a KeystoneML style guide #113

tomerk opened this issue May 17, 2015 · 1 comment

Comments

@tomerk
Copy link
Contributor

tomerk commented May 17, 2015

Should contain information such as:

  • What should be a Transformer vs. Estimator vs. LabelEstimator vs. FunctionNode vs. Evaluator vs. Loader vs. util method
  • What packages to put things in
  • (Till we figure something better out) ensure that Transformer RDD method implementations maintain each item & partitioning, e.g. functionally equivalent to rdd.map(x => apply(x))
  • Using MatrixUtils.rowsToMatrix instead of DenseMatrix(x:_*)
  • When to use Vector vs. DenseVector, when to use Matrix vs. DenseMatrix
  • (eventually) when & how to use NumericTransformer

etc.
Also, we should decide and be consistent about whether nodes:

  • are normal classes
  • are case classes
  • are normal classes w/ companion object constructor
@etrain
Copy link
Contributor

etrain commented May 17, 2015

Should also contain a link to the spark style guide (which is our coding standard) and something brief about the expectation of how docs are formatted and desired test coverage.

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

No branches or pull requests

2 participants