Skip to content

XML documentation for Prior trainer. #3426

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

Merged
merged 2 commits into from
Apr 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,28 @@ private void MapDist(in VBuffer<float> src, ref float score, ref float prob)
}

/// <summary>
/// Learns the prior distribution for 0/1 class labels and outputs that.
/// The <see cref="IEstimator{TTransformer}"/> for predicting a target using a binary classification model.
/// </summary>
/// <remarks>
/// <format type="text/markdown"><![CDATA[
/// To create this trainer, use [Prior](xref:Microsoft.ML.StandardTrainersCatalog.Prior(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,System.String,System.String))
///
/// [!include[io](~/../docs/samples/docs/api-reference/io-columns-binary-classification.md)]
///
/// ### Trainer Characteristics
/// | | |
/// | -- | -- |
/// | Machine learning task | Binary classification |
/// | Is normalization required? | No |
/// | Is caching required? | No |
/// | Required NuGet in addition to Microsoft.ML | None |
///
/// ### Training Algorithm Details
/// Learns the prior distribution for 0/1 class labels and outputs that.
/// ]]>
/// </format>
/// </remarks>
/// <seealso cref="Microsoft.ML.StandardTrainersCatalog.Prior(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,System.String,System.String)"/>
public sealed class PriorTrainer : ITrainer<PriorModelParameters>,
ITrainerEstimator<BinaryPredictionTransformer<PriorModelParameters>, PriorModelParameters>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@ public static LinearSvmTrainer LinearSvm(this BinaryClassificationCatalog.Binary
}

/// <summary>
/// Predict a target using a binary classification model trained with <see cref="PriorTrainer"/> trainer.
/// Create <see cref="PriorTrainer"/>, which predict a target using a binary classification model.
/// </summary>
/// <remarks>
/// This trainer uses the proportion of a label in the training set as the probability of that label.
Expand Down