fixed metric_freq param description (#2780)

microsoft · Feb 20, 2020 · 997a469 · 997a469
1 parent c4a7ab8
commit 997a469
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/R-package/tests/testthat/test_learning_to_rank.R b/R-package/tests/testthat/test_learning_to_rank.R
@@ -20,7 +20,6 @@ test_that("learning-to-rank with lgb.train() works as expected", {
         objective = "lambdarank"
         , metric = "ndcg"
         , ndcg_at = ndcg_at
-        , metric_freq = 1L
         , max_position = 3L
         , learning_rate = 0.001
     )
@@ -68,7 +67,6 @@ test_that("learning-to-rank with lgb.cv() works as expected", {
         objective = "lambdarank"
         , metric = "ndcg"
         , ndcg_at = ndcg_at
-        , metric_freq = 1L
         , max_position = 3L
         , label_gain = "0,1,3"
     )

diff --git a/docs/Parameters.rst b/docs/Parameters.rst
@@ -951,6 +951,8 @@ Metric Parameters
 
    -  frequency for metric output
 
+   -  **Note**: can be used only in CLI version
+
 -  ``is_provide_training_metric`` :raw-html:`<a id="is_provide_training_metric" title="Permalink to this parameter" href="#is_provide_training_metric">&#x1F517;&#xFE0E;</a>`, default = ``false``, type = bool, aliases: ``training_metric``, ``is_training_metric``, ``train_metric``
 
    -  set this to ``true`` to output metric result over training dataset

diff --git a/include/LightGBM/config.h b/include/LightGBM/config.h
@@ -808,6 +808,7 @@ struct Config {
   // check = >0
   // alias = output_freq
   // desc = frequency for metric output
+  // desc = **Note**: can be used only in CLI version
   int metric_freq = 1;
 
   // alias = training_metric, is_training_metric, train_metric