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

Reply via email to