Skip to content

Add XML summary comments to fields in Options class #2154

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.

Sign up for GitHub

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

Jump to bottom
Closed
abgoswam opened this issue Jan 15, 2019 · 1 comment
Closed

Add XML summary comments to fields in Options class #2154

abgoswam opened this issue Jan 15, 2019 · 1 comment
Labels
API Issues pertaining the friendly API

Comments

@abgoswam
Copy link
Member

abgoswam commented Jan 15, 2019 •
edited
Loading

We need to add XML summary comments to fields in Options class.

Learners where its missing:

  • SdcaBinaryTrainer
  • SdcaMultiClassTrainer
  • SdcaRegressionTrainer
  • StochasticGradientDescentClassificationTrainer
  • MulticlassLogisticRegression + related LR learners
  • Online learners

Also, in XML help for options we should say something consistent (right now there is inconsistency in the help text for options)
e.g.

/// <param name="options">Advanced **options** to the algorithm.</param>
@abgoswam abgoswam added the API Issues pertaining the friendly API label Jan 15, 2019
This was referenced Jan 15, 2019
Merged
Merged
@abgoswam abgoswam mentioned this issue Feb 5, 2019
Merged
@wschin
Copy link
Member

wschin commented Jul 2, 2019

I think we have finished this during our API season.

@wschin wschin closed this as completed Jul 2, 2019
@ghost ghost locked as resolved and limited conversation to collaborators Mar 25, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
API Issues pertaining the friendly API
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@wschin @abgoswam