"python-package/vscode:/vscode.git/clone" did not exist on "1d075f4dda618515490cb1e9bdbd4fa0a4603c8d"
Unverified Commit fdc582ea authored by James Lamb's avatar James Lamb Committed by GitHub
Browse files

[docs] document CLI behavior when label_column is omitted (#4485)

parent 5d40dc4b
...@@ -762,6 +762,8 @@ Dataset Parameters ...@@ -762,6 +762,8 @@ Dataset Parameters
- add a prefix ``name:`` for column name, e.g. ``label=name:is_click`` - add a prefix ``name:`` for column name, e.g. ``label=name:is_click``
- if omitted, the first column in the training data is used as the label
- **Note**: works only in case of loading data directly from file - **Note**: works only in case of loading data directly from file
- ``weight_column`` :raw-html:`<a id="weight_column" title="Permalink to this parameter" href="#weight_column">&#x1F517;&#xFE0E;</a>`, default = ``""``, type = int or string, aliases: ``weight`` - ``weight_column`` :raw-html:`<a id="weight_column" title="Permalink to this parameter" href="#weight_column">&#x1F517;&#xFE0E;</a>`, default = ``""``, type = int or string, aliases: ``weight``
......
...@@ -26,6 +26,9 @@ metric_freq = 1 ...@@ -26,6 +26,9 @@ metric_freq = 1
# true if need output metric for training data, alias: tranining_metric, train_metric # true if need output metric for training data, alias: tranining_metric, train_metric
is_training_metric = true is_training_metric = true
# column in data to use as label
label_column = 0
# number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy. # number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy.
max_bin = 255 max_bin = 255
......
...@@ -29,6 +29,9 @@ metric_freq = 1 ...@@ -29,6 +29,9 @@ metric_freq = 1
# true if need output metric for training data, alias: tranining_metric, train_metric # true if need output metric for training data, alias: tranining_metric, train_metric
is_training_metric = true is_training_metric = true
# column in data to use as label
label_column = 0
# number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy. # number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy.
max_bin = 255 max_bin = 255
......
...@@ -41,6 +41,9 @@ metric_freq = 1 ...@@ -41,6 +41,9 @@ metric_freq = 1
# true if need output metric for training data, alias: tranining_metric, train_metric # true if need output metric for training data, alias: tranining_metric, train_metric
is_training_metric = true is_training_metric = true
# column in data to use as label
label_column = 0
# number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy. # number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy.
max_bin = 255 max_bin = 255
......
...@@ -26,6 +26,9 @@ metric_freq = 1 ...@@ -26,6 +26,9 @@ metric_freq = 1
# true if need output metric for training data, alias: tranining_metric, train_metric # true if need output metric for training data, alias: tranining_metric, train_metric
is_training_metric = true is_training_metric = true
# column in data to use as label
label_column = 0
# number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy. # number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy.
max_bin = 255 max_bin = 255
......
...@@ -26,6 +26,9 @@ metric_freq = 1 ...@@ -26,6 +26,9 @@ metric_freq = 1
# true if need output metric for training data, alias: tranining_metric, train_metric # true if need output metric for training data, alias: tranining_metric, train_metric
is_training_metric = true is_training_metric = true
# column in data to use as label
label_column = 0
# number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy. # number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy.
max_bin = 255 max_bin = 255
......
...@@ -29,6 +29,9 @@ metric_freq = 1 ...@@ -29,6 +29,9 @@ metric_freq = 1
# true if need output metric for training data, alias: tranining_metric, train_metric # true if need output metric for training data, alias: tranining_metric, train_metric
is_training_metric = true is_training_metric = true
# column in data to use as label
label_column = 0
# number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy. # number of bins for feature bucket, 255 is a recommend setting, it can save memories, and also has good accuracy.
max_bin = 255 max_bin = 255
......
...@@ -657,6 +657,7 @@ struct Config { ...@@ -657,6 +657,7 @@ struct Config {
// desc = used to specify the label column // desc = used to specify the label column
// desc = use number for index, e.g. ``label=0`` means column\_0 is the label // desc = use number for index, e.g. ``label=0`` means column\_0 is the label
// desc = add a prefix ``name:`` for column name, e.g. ``label=name:is_click`` // desc = add a prefix ``name:`` for column name, e.g. ``label=name:is_click``
// desc = if omitted, the first column in the training data is used as the label
// desc = **Note**: works only in case of loading data directly from file // desc = **Note**: works only in case of loading data directly from file
std::string label_column = ""; std::string label_column = "";
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment