[
https://issues.apache.org/jira/browse/MADLIB-32?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Frank McQuillan reassigned MADLIB-32:
-------------------------------------
Assignee: (was: Rahul Iyer)
> Coherence
> ---------
>
> Key: MADLIB-32
> URL: https://issues.apache.org/jira/browse/MADLIB-32
> Project: Apache MADlib
> Issue Type: Task
> Reporter: Florian Schoppmann
> Priority: Major
> Fix For: v2.0
>
>
> As part of making MADlib intuitive, easy-to-use, and coherent we should
> address the following (list to be extended):
> * *SQL Interface Design*
> ** A common naming scheme for SQL functions
> ** Decide on what to return from SQL functions and what messages to output
> during runtime. Right now, the modules are quite disparate:
> *** linear/logistic regression return a vector of coefficients, give no
> messages during runtime
> *** kmeans writes output into a table whose name it generates from the input
> data, the output of the SQL function is a textual summary of the algorithm run
> *** etc.
> * *Code Style*
> ** We should choose a coding style guide for each of the languages we use
> ** We should collect "design patterns" or best practices on how to solve
> recurring problems (e.g., how to split code among SQL, C, Python -- what to
> do or not to do in any of these languages, how to work around Greenplum
> limitations like "no correlated subqueries")
> * *Documentation*
> We should adapt a style guide. Sample questions:
> ** How do we write consistent and concise single-line function descriptions?
> (@brief tag)
> ** How do we structure extensive descriptions of functions/files/modules/...?
> ** How should the examples look like?
> *** Do we use the madlib schema prefix?
> *** Do we include the full psql prompt?
> *** etc.
> ** How much basics and math on the main page?
> *** If basic math is desired: Agree on a common math notation: E.g., inner
> products or matrix-multiplication? etc.
> This issue overlaps with
> https://github.com/madlib/madlib-contrib/wiki/Thoughts-on-API
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
