Skip to content

Commit 40abffc

Browse files
jwood803artidoro
authored andcommitted
Add XML doc to the ITrainerEstimator interface (#2847)
1 parent 4a58d76 commit 40abffc

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

src/Microsoft.ML.Data/Training/ITrainerEstimator.cs

+11-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,18 @@
44

55
namespace Microsoft.ML.Trainers
66
{
7-
public interface ITrainerEstimator<out TTransformer, out TPredictor> : IEstimator<TTransformer>
8-
where TTransformer : ISingleFeaturePredictionTransformer<TPredictor>
9-
where TPredictor : class
7+
/// <summary>
8+
/// Interface for the Trainer Estimator.
9+
/// </summary>
10+
/// <typeparam name="TTransformer">The type of the transformer returned by the estimator.</typeparam>
11+
/// <typeparam name="TModel">The type of the model parameters.</typeparam>
12+
public interface ITrainerEstimator<out TTransformer, out TModel> : IEstimator<TTransformer>
13+
where TTransformer : ISingleFeaturePredictionTransformer<TModel>
14+
where TModel : class
1015
{
16+
/// <summary>
17+
/// Gets the <see cref="TrainerInfo"/> information about the trainer.
18+
/// </summary>
1119
TrainerInfo Info { get; }
1220
}
1321
}

0 commit comments

Comments
 (0)