Commit 7949cf51 authored by Zafarullah Mahmood's avatar Zafarullah Mahmood Committed by Nikita Titov
Browse files

[docs] Fixed some typos in Python API Docs (#1737)

* Fixed some typos in Python API Docs

* FixTypo changed validation set -> sets
parent c920e634
...@@ -320,7 +320,7 @@ class _InnerPredictor(object): ...@@ -320,7 +320,7 @@ class _InnerPredictor(object):
Note: Can convert from Booster, but cannot convert to Booster Note: Can convert from Booster, but cannot convert to Booster
""" """
def __init__(self, model_file=None, booster_handle=None, pred_parameter=None): def __init__(self, model_file=None, booster_handle=None, pred_parameter=None):
"""Initialize the _InnerPredictor. Not expose to user """Initialize the _InnerPredictor. Not exposed to user
Parameters Parameters
---------- ----------
...@@ -629,7 +629,7 @@ class Dataset(object): ...@@ -629,7 +629,7 @@ class Dataset(object):
weight=None, group=None, init_score=None, silent=False, weight=None, group=None, init_score=None, silent=False,
feature_name='auto', categorical_feature='auto', params=None, feature_name='auto', categorical_feature='auto', params=None,
free_raw_data=True): free_raw_data=True):
"""Constract Dataset. """Construct Dataset.
Parameters Parameters
---------- ----------
...@@ -657,7 +657,7 @@ class Dataset(object): ...@@ -657,7 +657,7 @@ class Dataset(object):
If list of strings, interpreted as feature names (need to specify ``feature_name`` as well). If list of strings, interpreted as feature names (need to specify ``feature_name`` as well).
If 'auto' and data is pandas DataFrame, pandas categorical columns are used. If 'auto' and data is pandas DataFrame, pandas categorical columns are used.
All values in categorical features should be less than int32 max value (2147483647). All values in categorical features should be less than int32 max value (2147483647).
Large values could be memory consuming. Consider to use consecutive integers started from zero. Large values could be memory consuming. Consider using consecutive integers starting from zero.
All negative values in categorical features will be treated as missing values. All negative values in categorical features will be treated as missing values.
params : dict or None, optional (default=None) params : dict or None, optional (default=None)
Other parameters. Other parameters.
...@@ -1046,7 +1046,7 @@ class Dataset(object): ...@@ -1046,7 +1046,7 @@ class Dataset(object):
return ret return ret
def save_binary(self, filename): def save_binary(self, filename):
"""Save Dataset to binary file. """Save Dataset to a binary file.
Parameters Parameters
---------- ----------
...@@ -1212,7 +1212,7 @@ class Dataset(object): ...@@ -1212,7 +1212,7 @@ class Dataset(object):
Parameters Parameters
---------- ----------
reference : Dataset reference : Dataset
Reference that is used as a template to consturct the current Dataset. Reference that is used as a template to construct the current Dataset.
Returns Returns
------- -------
......
...@@ -58,7 +58,7 @@ def train(params, train_set, num_boost_round=100, ...@@ -58,7 +58,7 @@ def train(params, train_set, num_boost_round=100,
If list of strings, interpreted as feature names (need to specify ``feature_name`` as well). If list of strings, interpreted as feature names (need to specify ``feature_name`` as well).
If 'auto' and data is pandas DataFrame, pandas categorical columns are used. If 'auto' and data is pandas DataFrame, pandas categorical columns are used.
All values in categorical features should be less than int32 max value (2147483647). All values in categorical features should be less than int32 max value (2147483647).
Large values could be memory consuming. Consider to use consecutive integers started from zero. Large values could be memory consuming. Consider using consecutive integers starting from zero.
All negative values in categorical features will be treated as missing values. All negative values in categorical features will be treated as missing values.
early_stopping_rounds: int or None, optional (default=None) early_stopping_rounds: int or None, optional (default=None)
Activates early stopping. The model will train until the validation score stops improving. Activates early stopping. The model will train until the validation score stops improving.
...@@ -347,7 +347,7 @@ def cv(params, train_set, num_boost_round=100, ...@@ -347,7 +347,7 @@ def cv(params, train_set, num_boost_round=100,
num_boost_round : int, optional (default=100) num_boost_round : int, optional (default=100)
Number of boosting iterations. Number of boosting iterations.
folds : generator or iterator of (train_idx, test_idx) tuples, scikit-learn splitter object or None, optional (default=None) folds : generator or iterator of (train_idx, test_idx) tuples, scikit-learn splitter object or None, optional (default=None)
If generator or iterator, it should yield the train and test indices for the each fold. If generator or iterator, it should yield the train and test indices for each fold.
If object, it should be one of the scikit-learn splitter classes If object, it should be one of the scikit-learn splitter classes
(http://scikit-learn.org/stable/modules/classes.html#splitter-classes) (http://scikit-learn.org/stable/modules/classes.html#splitter-classes)
and have ``split`` method. and have ``split`` method.
...@@ -382,7 +382,7 @@ def cv(params, train_set, num_boost_round=100, ...@@ -382,7 +382,7 @@ def cv(params, train_set, num_boost_round=100,
If list of strings, interpreted as feature names (need to specify ``feature_name`` as well). If list of strings, interpreted as feature names (need to specify ``feature_name`` as well).
If 'auto' and data is pandas DataFrame, pandas categorical columns are used. If 'auto' and data is pandas DataFrame, pandas categorical columns are used.
All values in categorical features should be less than int32 max value (2147483647). All values in categorical features should be less than int32 max value (2147483647).
Large values could be memory consuming. Consider to use consecutive integers started from zero. Large values could be memory consuming. Consider using consecutive integers starting from zero.
All negative values in categorical features will be treated as missing values. All negative values in categorical features will be treated as missing values.
early_stopping_rounds: int or None, optional (default=None) early_stopping_rounds: int or None, optional (default=None)
Activates early stopping. Activates early stopping.
......
...@@ -316,7 +316,7 @@ class LGBMModel(_LGBMModelBase): ...@@ -316,7 +316,7 @@ class LGBMModel(_LGBMModelBase):
group : array-like or None, optional (default=None) group : array-like or None, optional (default=None)
Group data of training data. Group data of training data.
eval_set : list or None, optional (default=None) eval_set : list or None, optional (default=None)
A list of (X, y) tuple pairs to use as a validation sets. A list of (X, y) tuple pairs to use as validation sets.
eval_names : list of strings or None, optional (default=None) eval_names : list of strings or None, optional (default=None)
Names of eval_set. Names of eval_set.
eval_sample_weight : list of arrays or None, optional (default=None) eval_sample_weight : list of arrays or None, optional (default=None)
...@@ -349,7 +349,7 @@ class LGBMModel(_LGBMModelBase): ...@@ -349,7 +349,7 @@ class LGBMModel(_LGBMModelBase):
If list of strings, interpreted as feature names (need to specify ``feature_name`` as well). If list of strings, interpreted as feature names (need to specify ``feature_name`` as well).
If 'auto' and data is pandas DataFrame, pandas categorical columns are used. If 'auto' and data is pandas DataFrame, pandas categorical columns are used.
All values in categorical features should be less than int32 max value (2147483647). All values in categorical features should be less than int32 max value (2147483647).
Large values could be memory consuming. Consider to use consecutive integers started from zero. Large values could be memory consuming. Consider using consecutive integers starting from zero.
All negative values in categorical features will be treated as missing values. All negative values in categorical features will be treated as missing values.
callbacks : list of callback functions or None, optional (default=None) callbacks : list of callback functions or None, optional (default=None)
List of callback functions that are applied at each iteration. List of callback functions that are applied at each iteration.
......
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