From 30da951db5560d505773c303f71249fac08a85cf Mon Sep 17 00:00:00 2001 From: J W Date: Tue, 5 Mar 2019 07:49:47 -0500 Subject: [PATCH 1/2] Add XML doc to the ITrainerEstimator interface --- src/Microsoft.ML.Data/Training/ITrainerEstimator.cs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/Microsoft.ML.Data/Training/ITrainerEstimator.cs b/src/Microsoft.ML.Data/Training/ITrainerEstimator.cs index c7d1c29dc6..ca16eb1598 100644 --- a/src/Microsoft.ML.Data/Training/ITrainerEstimator.cs +++ b/src/Microsoft.ML.Data/Training/ITrainerEstimator.cs @@ -4,10 +4,18 @@ namespace Microsoft.ML.Trainers { + /// + /// Interface for the Trainer Estimator. + /// + /// + /// public interface ITrainerEstimator : IEstimator where TTransformer : ISingleFeaturePredictionTransformer where TPredictor : class { + /// + /// Gets the information about the trainer. + /// TrainerInfo Info { get; } } } From e0e194f1620e1de7eb8ffabed500b647f1aac192 Mon Sep 17 00:00:00 2001 From: J W Date: Sat, 9 Mar 2019 07:00:42 -0500 Subject: [PATCH 2/2] Update XML docs for PR feedback --- src/Microsoft.ML.Data/Training/ITrainerEstimator.cs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/Microsoft.ML.Data/Training/ITrainerEstimator.cs b/src/Microsoft.ML.Data/Training/ITrainerEstimator.cs index ca16eb1598..b15c2b9851 100644 --- a/src/Microsoft.ML.Data/Training/ITrainerEstimator.cs +++ b/src/Microsoft.ML.Data/Training/ITrainerEstimator.cs @@ -7,11 +7,11 @@ namespace Microsoft.ML.Trainers /// /// Interface for the Trainer Estimator. /// - /// - /// - public interface ITrainerEstimator : IEstimator - where TTransformer : ISingleFeaturePredictionTransformer - where TPredictor : class + /// The type of the transformer returned by the estimator. + /// The type of the model parameters. + public interface ITrainerEstimator : IEstimator + where TTransformer : ISingleFeaturePredictionTransformer + where TModel : class { /// /// Gets the information about the trainer.