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

Document deciders.py #158

Closed
david-z-shi opened this issue Sep 15, 2020 · 6 comments · Fixed by #280
Closed

Document deciders.py #158

david-z-shi opened this issue Sep 15, 2020 · 6 comments · Fixed by #280

Comments

@david-z-shi
Copy link
Contributor

david-z-shi commented Sep 15, 2020

Writing documentation for deciders.py. Part of issue #4 . Code in progress here.

@levinwil
Copy link
Collaborator

levinwil commented Oct 3, 2020

@latasianguy How has progress been on this? Looking at the code on your branch, it seems like the Documentation for SimpleArgmaxAverage is basically done. Do you think you could switch that documentation over to the version on main and adapt it?

@david-z-shi
Copy link
Contributor Author

@levinwil new branch here, let me know if I need to change anything before the PR, I'll close the other branch after the PR

@levinwil
Copy link
Collaborator

levinwil commented Oct 3, 2020

  1. Parameters means parameters to the init function. _is_fitted is NOT one of those parameters
  2. Class attributes means variables that are internally saved. This DOES include _is_fitted
  3. There are still some mentioned of ‘SimpleAverage’ instead of ‘ SimpleArgmaxAverage’

@levinwil
Copy link
Collaborator

levinwil commented Oct 3, 2020

You also don’t really need to mention anything about class attributes, since there aren’t any - just object attributes.

You should also have method signatures in the unit docstring. See https://github.com/latasianguy/progressive-learning/blob/document-deciders.py-new/proglearn/voters.py for examples of this.

Return statements in the doc strings should mention the types of the variables that are being returned

@levinwil
Copy link
Collaborator

levinwil commented Oct 5, 2020

Hey, @latasianguy do you have a progress report on this? We're in the process of generating documentation and this is the last major piece of documentation that we'd like to have finished.

@levinwil
Copy link
Collaborator

levinwil commented Oct 5, 2020

Closed per PR #280

@levinwil levinwil closed this as completed Oct 5, 2020
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

Successfully merging a pull request may close this issue.

2 participants