Adding xml style documentation for trainers #393
Conversation
… trainers, to improve what's currently on docs.microsoft.com
|
Starting with just sdca, averaged perceptron and lbfgs to give a feeling about the changes involved. |
…the ep_list.tsv, so that they have one line per entry point. Formatting.
There was a problem hiding this comment.
This seems like a step in the right direction, though that it's solely on the code-generated API is a bit unfortunate. Should be easy enough to transfer though. There are build failures... is this a problem with the manifest or API generation or something?
…cific new line characters.
| internal const string UserNameValue = "Averaged Perceptron"; | ||
| internal const string ShortName = "ap"; | ||
| internal const string Summary = "Perceptron is a binary classification algorithm that makes its predictions based on a linear function."; | ||
| internal const string DetailedSummary = @"Perceptron is a classification algorithm that makes its predictions based on a linear function. |
There was a problem hiding this comment.
Perceptron [](start = 50, length = 10)
I wish there was some way to author them in markdown files... I know attributes require constants, but is there some way to do this? We have done this for Py and R. #WontFix
There was a problem hiding this comment.
The documentation system will support ingesting md files, in the future, and those will go away.
Didn't want to duplicate what they are doing, but at the same time can't leave the docs with just one liners.
| @@ -106,18 +106,6 @@ public void Add(Microsoft.ML.Models.AnomalyDetectionEvaluator input, Microsoft.M | |||
| _jsonNodes.Add(Serialize("Models.AnomalyDetectionEvaluator", input, output)); | |||
| } | |||
|
|
|||
| public Microsoft.ML.Models.AnomalyPipelineEnsemble.Output Add(Microsoft.ML.Models.AnomalyPipelineEnsemble input) | |||
| { | |||
| var output = new Microsoft.ML.Models.AnomalyPipelineEnsemble.Output(); | |||
There was a problem hiding this comment.
feature [](start = 39, length = 7)
Is it possible to reduce the column count to 80 or at most 120 chars? It's hard to read.
src/Microsoft.ML/CSharpApi.cs
Outdated
| /// Perceptron is a classification algorithm that makes its predictions based on a linear function. | ||
| /// Perceptron is a classification algorithm that makes its predictions based on a linear function. | ||
| /// I.e., for an instance with feature values f0, f1,..., f_D-1, , the prediction is given by the sign of sigma[0,D-1] ( w_i * f_i), where w_0, w_1,...,w_D-1 are the weights computed by the algorithm. | ||
| /// |
There was a problem hiding this comment.
📝 blank lines are ignored in XML (they all collapse to a single space). If you want paragraphs, each block should start with <para> and end with </para>.
|
I left a comment above that auto-collapsed. Adding this comment to make sure it's seen. |
|
Thanks for the note, i'll update on the next iteration. |
* Adding xml style documentation for lbfgs, sdca and averagerPerceptron trainers, to improve what's currently on docs.microsoft.com * regenerating the C#Api file * Removing the control characters from the description when generating the ep_list.tsv, so that they have one line per entry point. Formatting. * spaces * The epList.tsv file and the manifest should not have the platform specific new line characters. * merge fix
ghost
locked as resolved and limited conversation to collaborators
4 participants
Adding xml style documentation for trainers, to improve what's currently on docs.microsoft.com.
Adresses #388