You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@systemml.apache.org by Janardhan <ja...@apache.org> on 2020/05/23 13:01:11 UTC

[DISCUSSION] Documentation dev & user along with builtins.

Hi all,

We have few people with us, willing to work on documentation (no code!)

Ideas on the parts of the codebase lacking/improvisation of documentation.
(1) what and how we want to document (user-facing builtins, internal dev,
etc),
(2) which tools[1] we should consistently use.

[1]
https://mail-archives.apache.org/mod_mbox/systemml-dev/202005.mbox/%3CCAObMueX1LA7D_Lwxd-wkXiFWKt6Pem4p3H9ZmjKj%3DGSvzwghrw%40mail.gmail.com%3E

Thank you,
Janardhan

Re: [DISCUSSION] Documentation dev & user along with builtins.

Posted by Janardhan <ja...@gmail.com>.

Hi,

Notebooks are removed from the project. Is there any reason for this - like
to simplify maintenance.

Are you open for creating notebooks. :-)

Thank you,
Janardhan

On Saturday, May 23, 2020, Matthias Boehm <mb...@gmail.com> wrote:

> thanks for the initiative and moving this discussion to the dev list. I
> think this would be very valuable. Regarding how to start, I would
> recommend to focus on external functionality first by documenting all
> dml-bodied and native builtin functions (see org.apache.sysds.common.Builtins)
> and operators.
>
> We started with Kevin Innerebner and others on this a while ago:
> https://github.com/apache/systemml/blob/master/docs/builtins-reference.md,
> but it's far from complete. Also, Sebastian Baunsgaard has a couple of
> ideas on the topic.
>
> Regards,
> Matthias
>
> On 5/23/2020 3:01 PM, Janardhan wrote:
>
>> Hi all,
>>
>> We have few people with us, willing to work on documentation (no code!)
>>
>> Ideas on the parts of the codebase lacking/improvisation of documentation.
>> (1) what and how we want to document (user-facing builtins, internal dev,
>> etc),
>> (2) which tools[1] we should consistently use.
>>
>> [1]
>> https://mail-archives.apache.org/mod_mbox/systemml-dev/20200
>> 5.mbox/%3CCAObMueX1LA7D_Lwxd-wkXiFWKt6Pem4p3H9ZmjKj%3DGSvzw
>> ghrw%40mail.gmail.com%3E
>>
>> Thank you,
>> Janardhan
>>
>>

Re: [DISCUSSION] Documentation dev & user along with builtins.

Posted by Matthias Boehm <mb...@gmail.com>.

thanks for the initiative and moving this discussion to the dev list. I 
think this would be very valuable. Regarding how to start, I would 
recommend to focus on external functionality first by documenting all 
dml-bodied and native builtin functions (see 
org.apache.sysds.common.Builtins) and operators.

We started with Kevin Innerebner and others on this a while ago: 
https://github.com/apache/systemml/blob/master/docs/builtins-reference.md, 
but it's far from complete. Also, Sebastian Baunsgaard has a couple of 
ideas on the topic.

Regards,
Matthias

On 5/23/2020 3:01 PM, Janardhan wrote:
> Hi all,
> 
> We have few people with us, willing to work on documentation (no code!)
> 
> Ideas on the parts of the codebase lacking/improvisation of documentation.
> (1) what and how we want to document (user-facing builtins, internal dev,
> etc),
> (2) which tools[1] we should consistently use.
> 
> [1]
> https://mail-archives.apache.org/mod_mbox/systemml-dev/202005.mbox/%3CCAObMueX1LA7D_Lwxd-wkXiFWKt6Pem4p3H9ZmjKj%3DGSvzwghrw%40mail.gmail.com%3E
> 
> Thank you,
> Janardhan
>