From d31346f6c265e994c54ebddd19ed1fb6445ba0c9 Mon Sep 17 00:00:00 2001 From: Akshita Dixit <56997545+akshitadixit@users.noreply.github.com> Date: Wed, 16 Feb 2022 04:50:44 -0800 Subject: [PATCH] Change docs for feval (#5002) --- python-package/lightgbm/basic.py | 8 ++++---- python-package/lightgbm/engine.py | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/python-package/lightgbm/basic.py b/python-package/lightgbm/basic.py index 823c620de4eb..b3c6788fef57 100644 --- a/python-package/lightgbm/basic.py +++ b/python-package/lightgbm/basic.py @@ -3191,14 +3191,14 @@ def eval_train(self, feval=None): ---------- feval : callable or None, optional (default=None) Customized evaluation function. - Should accept two parameters: preds, train_data, + Should accept two parameters: preds, eval_data, and return (eval_name, eval_result, is_higher_better) or list of such tuples. preds : numpy 1-D array The predicted values. If ``fobj`` is specified, predicted values are returned before any transformation, e.g. they are raw margin instead of probability of positive class for binary task in this case. - train_data : Dataset + eval_data : Dataset The training dataset. eval_name : str The name of evaluation function (without whitespace). @@ -3224,14 +3224,14 @@ def eval_valid(self, feval=None): ---------- feval : callable or None, optional (default=None) Customized evaluation function. - Should accept two parameters: preds, valid_data, + Should accept two parameters: preds, eval_data, and return (eval_name, eval_result, is_higher_better) or list of such tuples. preds : numpy 1-D array The predicted values. If ``fobj`` is specified, predicted values are returned before any transformation, e.g. they are raw margin instead of probability of positive class for binary task in this case. - valid_data : Dataset + eval_data : Dataset The validation dataset. eval_name : str The name of evaluation function (without whitespace). diff --git a/python-package/lightgbm/engine.py b/python-package/lightgbm/engine.py index bffc2cc7c436..0d3c4b58543f 100644 --- a/python-package/lightgbm/engine.py +++ b/python-package/lightgbm/engine.py @@ -75,14 +75,14 @@ def train( feval : callable, list of callable, or None, optional (default=None) Customized evaluation function. - Each evaluation function should accept two parameters: preds, train_data, + Each evaluation function should accept two parameters: preds, eval_data, and return (eval_name, eval_result, is_higher_better) or list of such tuples. preds : numpy 1-D array The predicted values. If ``fobj`` is specified, predicted values are returned before any transformation, e.g. they are raw margin instead of probability of positive class for binary task in this case. - train_data : Dataset + eval_data : Dataset The training dataset. eval_name : str The name of evaluation function (without whitespaces).