Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add detailed compiler documentation #18

Open
2 tasks
fschueler opened this issue Apr 8, 2016 · 0 comments
Open
2 tasks

Add detailed compiler documentation #18

fschueler opened this issue Apr 8, 2016 · 0 comments

Comments

@fschueler
Copy link

To make the later maintenance of the Flink-backend easier, we should document the compiler details while we figure them out. Maybe we should even shortly describe the instructions - and possibly do a better job with the JavaDoc there than it's the case in SystemML right now. I suggest to

  • Keep a Google-doc / Wiki-page with details about the compiler.
  • Key classes, key points in the Flink implemenation, how does it work in general...
  • I started a high level overwiew a while ago that can be found here.
  • Add JavaDoc to all instruction classes
    • Currently not all instruction classes in SystemML have sufficient documentation to understand right away what they do.
    • Additionally, some instructions perform recompilation inside their executeInstruction methods. this can lead to the effect that a SparkInstruction never actually executes a Spark job. I think it would be good to have this information somewhere.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant