[jira] [Commented] (SYSTEMML-54) Reference manuals for all APIs for invoking SystemML

["Sebastian Baunsgaard (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SYSTEMML-54?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17144746#comment-17144746 ] 

Sebastian Baunsgaard commented on SYSTEMML-54:
----------------------------------------------

We should  do this in documentation, or at least reference to individual places where this is shown.

I think the updated list for SystemDS include:

- Standalone
- Spark
- JMLC
- Python


> Reference manuals for all APIs for invoking SystemML
> ----------------------------------------------------
>
>                 Key: SYSTEMML-54
>                 URL: https://issues.apache.org/jira/browse/SYSTEMML-54
>             Project: SystemDS
>          Issue Type: Task
>            Reporter: Frederick Reiss
>            Assignee: Frederick Reiss
>            Priority: Major
>   Original Estimate: 80h
>  Remaining Estimate: 80h
>
> This task covers producing complete *reference* manuals for all of the programmatic APIs for running DML scripts. Tutorial and "how-to" style documentation for these APIs is covered by SYSML-61. 
> APIs to cover:
> * Standalone batch mode (command-line execution)
> * Spark batch mode
> * Hadoop batch mode
> * JMLC
> * Debugger
> * Scala/Java MLContext
> * Python MLContext
> Some of these APIs already have some documentation; others do not.
> At a minimum, documentation for an API should consist of:
> * An overall introduction to the API: What use cases is it designed for? What are its strengths? What are its current limitations?
> * A list of all methods in the API, with a detailed description of what each method does, what each parameter of the method does, and what value the method returns



--
This message was sent by Atlassian Jira
(v8.3.4#803005)