From 6ff5729c2eb69c82b6aab56103a687393fc437d3 Mon Sep 17 00:00:00 2001 From: Zeeshan Siddiqui Date: Thu, 18 Apr 2019 17:47:20 -0700 Subject: [PATCH 1/3] XML documentation for LightGBM multi-class trainer. --- src/Microsoft.ML.LightGbm/LightGbmCatalog.cs | 4 +-- .../LightGbmMulticlassTrainer.cs | 31 +++++++++++++++++-- 2 files changed, 31 insertions(+), 4 deletions(-) diff --git a/src/Microsoft.ML.LightGbm/LightGbmCatalog.cs b/src/Microsoft.ML.LightGbm/LightGbmCatalog.cs index 40d5532cfb..ff64f4472f 100644 --- a/src/Microsoft.ML.LightGbm/LightGbmCatalog.cs +++ b/src/Microsoft.ML.LightGbm/LightGbmCatalog.cs @@ -173,7 +173,7 @@ public static LightGbmRankingTrainer LightGbm(this RankingCatalog.RankingTrainer } /// - /// Predict a target using a gradient boosting decision tree multiclass classification model trained with the . + /// Creates , whihc predicts a target using a gradient boosting decision tree multiclass classification model trained. /// /// The . /// The name of the label column. @@ -205,7 +205,7 @@ public static LightGbmMulticlassTrainer LightGbm(this MulticlassClassificationCa } /// - /// Predict a target using a gradient boosting decision tree multiclass classification model trained with the and advanced options. + /// Creates , whihc predicts a target using a gradient boosting decision tree multiclass classification model trained with advanced options. /// /// The . /// Trainer options. diff --git a/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs b/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs index 1475f9a4a5..16473b04a9 100644 --- a/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs +++ b/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs @@ -22,9 +22,32 @@ namespace Microsoft.ML.Trainers.LightGbm { /// - /// The for training a boosted decision tree multi-class classification model using LightGBM. + /// TThe for training a boosted decision tree multi-class classification model using LightGBM. /// - /// + /// + /// + /// + /// + /// + /// + /// public sealed class LightGbmMulticlassTrainer : LightGbmTrainerBase, MulticlassPredictionTransformer, @@ -40,6 +63,10 @@ public sealed class LightGbmMulticlassTrainer : LightGbmTrainerBase PredictionKind.MulticlassClassification; + /// + /// Options for the as used in + /// [LightGbm(Options)](xref:Microsoft.ML.LightGbmExtensions.LightGbm(Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers,Microsoft.ML.Trainers.LightGbm.LightGbmMulticlassTrainer.Options)). + /// public sealed class Options : OptionsBase { public enum EvaluateMetricType From 1f334853352513a66f8d10dc8cf9b78d8c6b81a2 Mon Sep 17 00:00:00 2001 From: Zeeshan Siddiqui Date: Fri, 19 Apr 2019 16:55:04 -0700 Subject: [PATCH 2/3] PR feedback. --- src/Microsoft.ML.LightGbm/LightGbmCatalog.cs | 4 ++-- src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs | 10 ++++------ 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/src/Microsoft.ML.LightGbm/LightGbmCatalog.cs b/src/Microsoft.ML.LightGbm/LightGbmCatalog.cs index ff64f4472f..5cf883cc25 100644 --- a/src/Microsoft.ML.LightGbm/LightGbmCatalog.cs +++ b/src/Microsoft.ML.LightGbm/LightGbmCatalog.cs @@ -173,7 +173,7 @@ public static LightGbmRankingTrainer LightGbm(this RankingCatalog.RankingTrainer } /// - /// Creates , whihc predicts a target using a gradient boosting decision tree multiclass classification model trained. + /// Create , which predicts a target using a gradient boosting decision tree multiclass classification model. /// /// The . /// The name of the label column. @@ -205,7 +205,7 @@ public static LightGbmMulticlassTrainer LightGbm(this MulticlassClassificationCa } /// - /// Creates , whihc predicts a target using a gradient boosting decision tree multiclass classification model trained with advanced options. + /// Create with advanced options, which predicts a target using a gradient boosting decision tree multiclass classification model. /// /// The . /// Trainer options. diff --git a/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs b/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs index 16473b04a9..fad3556d56 100644 --- a/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs +++ b/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs @@ -35,18 +35,16 @@ namespace Microsoft.ML.Trainers.LightGbm /// | | | /// | -- | -- | /// | Machine learning task | Multiclass classification | - /// | Is normalization required? | Yes | + /// | Is normalization required? | No | /// | Is caching required? | No | /// | Required NuGet in addition to Microsoft.ML | Microsoft.ML.FastTree | /// - /// ### Training Algorithm Details - /// LightGBM is an open source implementation of gradient boosting decision tree. For implementation details, please see LightGBM's official [documentation](https://lightgbm.readthedocs.io/en/latest/index.html) or - /// [this](https://papers.nips.cc/paper/6907-lightgbm-a-highly-efficient-gradient-boosting-decision-tree.pdf) paper. + /// [!include[algorithm](~/../docs/samples/docs/api-reference/algo-details-lightgbm.md)] /// ]]> /// /// - /// - /// + /// + /// /// public sealed class LightGbmMulticlassTrainer : LightGbmTrainerBase, From 79d503ba2ba0eeb4f521d32e8c3bd14cb8e61df9 Mon Sep 17 00:00:00 2001 From: Zeeshan Siddiqui Date: Fri, 19 Apr 2019 16:57:30 -0700 Subject: [PATCH 3/3] PR feedback. --- src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs b/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs index fad3556d56..5c76eec2a1 100644 --- a/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs +++ b/src/Microsoft.ML.LightGbm/LightGbmMulticlassTrainer.cs @@ -22,7 +22,7 @@ namespace Microsoft.ML.Trainers.LightGbm { /// - /// TThe for training a boosted decision tree multi-class classification model using LightGBM. + /// The for training a boosted decision tree multi-class classification model using LightGBM. /// /// ///