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 explanations #25

Open
kijungs opened this issue Apr 29, 2015 · 2 comments
Open

Add explanations #25

kijungs opened this issue Apr 29, 2015 · 2 comments
Labels

Comments

@kijungs
Copy link
Contributor

kijungs commented Apr 29, 2015

We have to add comments for all public classes and public methods within the classes so that we are able to run javadoc to create an API documentation automatically.
Especially, we need detailed explanation for the following classes:

  • ComputeTask
    (what are the steps done in ComputeTask and how ComputeTask uses group comm, considering finite state machine that describes Controller and Compute Task state changes)
  • DataParser
    (how DataParser is working. There are two methods: parse and get. Why do you have two)
  • Driver
    (main logic of the Driver)
  • Stage
    (main logic of a Stage)
  • UserJobInfo
  • UserParameters
    (what are needed at Driver, and ControllerTask explicitly)
  • KeyValueStore
    (how we use this key value store)
  • UserComputeTask
    (iteration)
  • Each Machine Learning Algorithm and its important parameters
  • FlexionConfiguration
  • FlexionParameters
@bchocho
Copy link
Contributor

bchocho commented May 13, 2015

+1 I'd like to add to the list:

  • ControllerTask
  • UserControllerTask

@jsjason
Copy link
Contributor

jsjason commented Sep 22, 2015

The neural network classes need documentation too. We also need READMEs and a few diagrams.

@jsjason jsjason added the BSP label Sep 30, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants