Documentation is an essential part of the software development process, especially when working on a complex system in a collaborative environment where we want to encourage community growth.
On Wed, Jun 14, 2017 at 10:11 PM, Nakul Jindal <naku...@gmail.com> wrote: > Thank you Matthias for agreeing to do this! > > "Having a very verbose doc quickly gets outdated" is a problem many > projects deal with. We can have the community comment on PRs that changes > those parts, if the documentation does not reflect the submitted change. > As a starting point, since you are most familiar with the component, very > verbose documentation is VERY welcome :) > Specially for a complicated component like this one. It would greatly help > existing and new members. (Unless someone on the mailing list feels > otherwise). > > -Nakul > > > > > On Wed, Jun 14, 2017 at 9:04 PM, Matthias Boehm <mboe...@googlemail.com> > wrote: > > > sure - I'll try to add some documentation of IPA, probably directly > inlined > > into the code. Unfortunately, a too verbose dev documentation quickly > gets > > outdated because nobody updates it - let's see if we find the sweet spot > > that works for the project. > > > > Regards, > > Matthias > > > > > > On Wed, Jun 14, 2017 at 4:15 PM, <dusenberr...@gmail.com> wrote: > > > > > Agreed. More documentation, especially within the optimizer portion of > > > the engine, is quite useful. Given that a large number of our bugs and > > > performance issues stem from this area, it would be good for it to be > > clean > > > and well documented so that future bug searches/fixes can be completed > > in a > > > more expedient manner. > > > > > > -- > > > > > > Mike Dusenberry > > > GitHub: github.com/dusenberrymw > > > LinkedIn: linkedin.com/in/mikedusenberry > > > > > > Sent from my iPhone. > > > > > > > > > > On Jun 14, 2017, at 8:51 AM, Nakul Jindal <naku...@gmail.com> wrote: > > > > > > > > Hi Matthias, > > > > > > > > If its not too much trouble, could you please create a design > document > > > for > > > > this change. > > > > This will help the rest of the contributors work on this component as > > > well. > > > > > > > > Thanks, > > > > Nakul > > > > > > > > > > > > On Wed, Jun 14, 2017 at 12:00 AM, Matthias Boehm < > > mboe...@googlemail.com > > > > > > > > wrote: > > > > > > > >> just a quick heads up: in the next couple of days, I'll rework our > > > existing > > > >> inter-procedural analysis (IPA) in order to (1) create well-defined > > IPA > > > >> passes, (2) reuse functional call graphs across multiple rounds of > > IPA, > > > and > > > >> (3) introduce new IPA passes such as fine-grained literal > propagation > > > and > > > >> replacements as well as inlining of functions with control > structures. > > > This > > > >> will help improve the performance and debugging of scripts with > > complex > > > >> function call patterns. However, since this is a rather disruptive > > > change, > > > >> we might experience temporarily some compiler issues - if that > happens > > > >> please file anything you encounter against SYSTEMML-1668. > > > >> > > > >> Regards, > > > >> Matthias > > > >> > > > > > > -- Deron Eriksson Spark Technology Center http://www.spark.tc/
