Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
tianlh
LightGBM-DCU
Commits
3d8013c8
Unverified
Commit
3d8013c8
authored
Jul 24, 2024
by
Axel Durand
Committed by
GitHub
Jul 24, 2024
Browse files
[python-package] [docs] Expand class docs for Dataset (#6558)
parent
cbee5eea
Changes
5
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
24 additions
and
7 deletions
+24
-7
R-package/DESCRIPTION
R-package/DESCRIPTION
+1
-1
R-package/R/lgb.Dataset.R
R-package/R/lgb.Dataset.R
+7
-2
R-package/man/lgb.Dataset.Rd
R-package/man/lgb.Dataset.Rd
+6
-2
docs/env.yml
docs/env.yml
+1
-1
python-package/lightgbm/basic.py
python-package/lightgbm/basic.py
+9
-1
No files found.
R-package/DESCRIPTION
View file @
3d8013c8
...
...
@@ -63,4 +63,4 @@ Imports:
utils
SystemRequirements:
~~CXXSTD~~
RoxygenNote: 7.3.
1
RoxygenNote: 7.3.
2
R-package/R/lgb.Dataset.R
View file @
3d8013c8
...
...
@@ -758,8 +758,13 @@ Dataset <- R6::R6Class(
)
#' @title Construct \code{lgb.Dataset} object
#' @description Construct \code{lgb.Dataset} object from dense matrix, sparse matrix
#' or local file (that was created previously by saving an \code{lgb.Dataset}).
#' @description LightGBM does not train on raw data.
#' It discretizes continuous features into histogram bins, tries to
#' combine categorical features, and automatically handles missing and
# infinite values.
#'
#' The \code{Dataset} class handles that preprocessing, and holds that
#' alternative representation of the input data.
#' @inheritParams lgb_shared_dataset_params
#' @param data a \code{matrix} object, a \code{dgCMatrix} object,
#' a character representing a path to a text file (CSV, TSV, or LibSVM),
...
...
R-package/man/lgb.Dataset.Rd
View file @
3d8013c8
...
...
@@ -60,8 +60,12 @@ second group, etc.}
constructed dataset
}
\description{
Construct \code{lgb.Dataset} object from dense matrix, sparse matrix
or local file (that was created previously by saving an \code{lgb.Dataset}).
LightGBM does not train on raw data.
It discretizes continuous features into histogram bins, tries to
combine categorical features, and automatically handles missing and
The \code{Dataset} class handles that preprocessing, and holds that
alternative representation of the input data.
}
\examples{
\donttest{
...
...
docs/env.yml
View file @
3d8013c8
...
...
@@ -12,7 +12,7 @@ dependencies:
-
r-markdown=1.12
-
r-matrix=1.6_4
-
r-pkgdown=2.0.7
-
r-roxygen2=7.3.
1
-
r-roxygen2=7.3.
2
-
scikit-learn>=1.4.0
-
sphinx>=6.0
-
sphinx_rtd_theme>=2.0
python-package/lightgbm/basic.py
View file @
3d8013c8
...
...
@@ -1745,7 +1745,15 @@ class _InnerPredictor:
class
Dataset
:
"""Dataset in LightGBM."""
"""
Dataset in LightGBM.
LightGBM does not train on raw data.
It discretizes continuous features into histogram bins, tries to combine categorical features,
and automatically handles missing and infinite values.
This class handles that preprocessing, and holds that alternative representation of the input data.
"""
def
__init__
(
self
,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment