[docs] added new parameters aliases #1537
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
StrikerRUS
commented
Jul 21, 2018
There was a problem hiding this comment.
ping @Laurae2 for just letting you know about these updates in R
| @@ -140,7 +140,7 @@ lgb.cv <- function(params = list(), | |||
| begin_iteration <- predictor$current_iter() + 1 | |||
| } | |||
| # Check for number of rounds passed as parameter - in case there are multiple ones, take only the first one | |||
| n_trees <- c("num_iterations", "num_iteration", "num_tree", "num_trees", "num_round", "num_rounds") | |||
| n_trees <- c("num_iterations", "num_iteration", "n_iter", "num_tree", "num_trees", "num_round", "num_rounds", "num_boost_round", "n_estimators") | |||
| @@ -117,7 +117,7 @@ lgb.train <- function(params = list(), | |||
| begin_iteration <- predictor$current_iter() + 1 | |||
| } | |||
| # Check for number of rounds passed as parameter - in case there are multiple ones, take only the first one | |||
| n_rounds <- c("num_iterations", "num_iteration", "num_tree", "num_trees", "num_round", "num_rounds") | |||
| n_rounds <- c("num_iterations", "num_iteration", "n_iter", "num_tree", "num_trees", "num_round", "num_rounds", "num_boost_round", "n_estimators") | |||
StrikerRUS
commented
Jul 21, 2018
There was a problem hiding this comment.
The following aliases are taken from here https://xgboost.readthedocs.io/en/latest/parameter.html
| // check = >=0 | ||
| // desc = number of boosting iterations | ||
| // desc = **Note**: for Python/R-package, **this parameter is ignored**, use ``num_boost_round`` (Python) or ``nrounds`` (R) input arguments of ``train`` and ``cv`` methods instead | ||
| // desc = **Note**: internally, LightGBM constructs ``num_class * num_iterations`` trees for multi-class classification problems | ||
| int num_iterations = 100; | ||
|
|
||
| // alias = shrinkage_rate | ||
| // alias = shrinkage_rate, eta |
| // check = >0.0 | ||
| // desc = shrinkage rate | ||
| // desc = in ``dart``, it also affects on normalization weights of dropped trees | ||
| double learning_rate = 0.1; | ||
|
|
||
| // default = 31 | ||
| // alias = num_leaf | ||
| // alias = num_leaf, max_leaves, max_leaf |
| @@ -266,7 +266,7 @@ struct Config { | |||
| // desc = L1 regularization | |||
| double lambda_l1 = 0.0; | |||
|
|
|||
| // alias = reg_lambda | |||
| // alias = reg_lambda, lambda | |||
| @@ -276,21 +276,22 @@ struct Config { | |||
| // desc = the minimal gain to perform split | |||
| double min_gain_to_split = 0.0; | |||
|
|
|||
| // alias = rate_drop | |||
| @@ -407,6 +410,7 @@ struct Config { | |||
| // desc = **Note**: can be used only in CLI version | |||
| std::string output_model = "LightGBM_model.txt"; | |||
|
|
|||
| // alias = save_period | |||
| @@ -419,7 +423,7 @@ struct Config { | |||
| // desc = **Note**: can be used only in CLI version | |||
| std::string input_model = ""; | |||
|
|
|||
| // alias = predict_result, prediction_result | |||
| // alias = predict_result, prediction_result, predict_name, prediction_name, pred_name, name_pred | |||
StrikerRUS
commented
Jul 21, 2018
| @@ -660,12 +660,8 @@ def _lazy_init(self, data, label=None, reference=None, | |||
| warnings.warn('{0} keyword has been found in `params` and will be ignored. ' | |||
| 'Please use {0} argument of the Dataset constructor to pass this parameter.'.format(key)) | |||
| self.predictor = predictor | |||
| if "verbosity" in params: | |||
| params.setdefault("verbose", params.pop("verbosity")) | |||
There was a problem hiding this comment.
Now aliases are treated at C++ side
| if silent: | ||
| params["verbose"] = 0 | ||
| elif "verbose" not in params: | ||
| params["verbose"] = 1 |
There was a problem hiding this comment.
No need to do this, since 1 is the default value at C++ side
StrikerRUS
commented
Jul 21, 2018
| @@ -397,9 +397,6 @@ def fit(self, X, y, | |||
| self._fobj = None | |||
| evals_result = {} | |||
| params = self.get_params() | |||
| # sklearn interface has another naming convention | |||
| params.setdefault('seed', params.pop('random_state')) | |||
| params.setdefault('nthread', params.pop('n_jobs')) | |||
There was a problem hiding this comment.
Lets move these names to aliases at C++ side
| iris = load_iris() | ||
| X_train, X_test, y_train, y_test = train_test_split(iris.data, iris.target, test_size=0.2, random_state=42) | ||
|
|
||
| # Tests that `seed` is the same as `random_state` |
There was a problem hiding this comment.
With adding this argument name to aliases at C++ side, this test becomes useless
chivee
approved these changes
Jul 22, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added some new aliases for parameters and updated the codebase according to aliases treating mechanism at C++ side. See comments for details.