-
Notifications
You must be signed in to change notification settings - Fork 42
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 #280
Document deciders.py #280
Conversation
@latasianguy
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some small changes:
- On lines 26 and 31, please describe what classes actually is. You did it below as "A list of classes of type obj."
- On line 49, you say "Fits tree classification to transformed data X with labels y.". The data is NOT transformed here, it is input data. Also, this a decider, NOT a tree classifier.
- On line 102, ValueError is thrown when the labels have not been provided AND classes is empty
- On lines 140 and 192, you describe transformer_ids as "A list with all transformer ids". This is not true. It is a list of transformer_ids you would like to send the inference point through to be considered in the overall decision. Also, it technically does default to None, but you should say that it defaults to using ALL transformers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On line 52m you say "Fits the a Decider to the given voters and transformers."
That's grammatically incorrect. Also, it saves the transformers and voters internally. I'd just describe it as "Fits the decider to inputs X and final classification outputs y."
Reference issue
Closes #158 .
Type of change
Documents deciders.py
What does this implement/fix?
Wrote docstrings for the SimpleArgmaxAverage decider.
Additional information